{"type":"api","title":"Fetch User Data by Subscription ID","meta":{"id":"/apps/pubhub/media/conc-2511/d77fe2fa1c66c5533550637c8fa49491e06b8c79/00c40fb3-664f-39a5-a810-78ac3bbc6506","info":{"title":"NBI Service","description":"NBI Service api documentation. ","contact":{},"license":{"name":"ONC-AE-License","url":"https://www.cisco.com"},"version":"1.0.0-25.1.1"},"security":[{"basicAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/2431/nbi-service.md"},"serverConfig":"full","enableAuthEditing":true,"httpBasic":{"username":"api-user","password":"encrypted-password@123"}},"openapi":"3.0.1","servers":[{"url":"http://localhost","description":"Generated server url"}],"securitySchemes":{"basicAuth":{"type":"http","description":"Basic authentication scheme","scheme":"basic"}}},"spec":{"tags":["alarm-controller"],"summary":"Fetch User Data by Subscription ID","description":"This API returns the user data associated with the provided subscription ID.","operationId":"fetchUserData","parameters":[{"name":"subscription-id","in":"query","description":"subscription-id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"*/*":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"The username associated with the subscription.","nullable":true},"url":{"type":"string","description":"The URL associated with the subscription.","nullable":true},"topic":{"type":"string","description":"The topic associated with the subscription.","nullable":true},"creationTime":{"type":"string","description":"The creation time of the subscription in a readable format.","nullable":true},"creationTimeIso8601":{"type":"string","description":"The creation time of the subscription in ISO 8601 format.","nullable":true},"timeOfUpdate":{"type":"string","description":"The last update time of the subscription in a readable format.","nullable":true},"timeOfUpdateIso8601":{"type":"string","description":"The last update time of the subscription in ISO 8601 format.","nullable":true},"format":{"type":"string","description":"The format of the subscription data, e.g., JSON, XML.","nullable":true},"connectionType":{"type":"string","description":"The connection type used for the subscription, e.g., HTTP, API.","nullable":true},"filters":{"type":"object","additionalProperties":{"type":"array","description":"A map of filters applied to the subscription.","items":{"type":"string","description":"A map of filters applied to the subscription."}},"description":"A map of filters applied to the subscription.","nullable":true},"subscription-id":{"type":"string","description":"The unique identifier for the subscription.","format":"uuid","nullable":true}},"description":"Original name: UserDataResponseBean","nullable":true,"$$ref":"#/components/schemas/UserDataResponseBean"},"example":{"subscription-id":"123e4567-e89b-12d3-a456-426614174000","userName":"JohnDoe","url":"https://example.com/userdata","topic":"Tech Updates","creationTime":"2024-01-01T12:00:00Z","creationTimeIso8601":"2024-01-01T12:00:00Z","timeOfUpdate":"2024-08-27T15:30:00Z","timeOfUpdateIso8601":"2024-08-27T15:30:00Z","format":"JSON","connectionType":"API","topology":{},"name":{}}}}},"400":{"description":"Bad Request","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"*/*":{"schema":{"type":"object","properties":{"error-type":{"type":"string","nullable":true},"error-tag":{"type":"string","nullable":true},"error-path":{"type":"string","nullable":true},"error-message":{"type":"string","nullable":true},"error-code":{"type":"integer","format":"int32","nullable":true}},"description":"Original name: TapiErrorDetail","nullable":true,"$$ref":"#/components/schemas/TapiErrorDetail"},"example":{"error-message":"Bad request","error-path":"/v1/resources/11111111-1111-1111-1111-111111111111","error-code":400}}}},"404":{"description":"Not Found","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"*/*":{"schema":{"type":"object","properties":{"error-type":{"type":"string","nullable":true},"error-tag":{"type":"string","nullable":true},"error-path":{"type":"string","nullable":true},"error-message":{"type":"string","nullable":true},"error-code":{"type":"integer","format":"int32","nullable":true}},"description":"Original name: TapiErrorDetail","nullable":true,"$$ref":"#/components/schemas/TapiErrorDetail"},"example":{"error-message":"Not found.","error-path":"/v1/resources/11111111-1111-1111-1111-111111111111","error-code":404}}}},"405":{"description":"Method Not Allowed","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"*/*":{"schema":{"type":"object","properties":{"error-type":{"type":"string","nullable":true},"error-tag":{"type":"string","nullable":true},"error-path":{"type":"string","nullable":true},"error-message":{"type":"string","nullable":true},"error-code":{"type":"integer","format":"int32","nullable":true}},"description":"Original name: TapiErrorDetail","nullable":true,"$$ref":"#/components/schemas/TapiErrorDetail"},"example":{"error-message":"The HTTP method used is not allowed for this endpoint.","error-path":"/v1/resources/11111111-1111-1111-1111-111111111111","error-code":405}}}},"500":{"description":"Internal Server Error","headers":{"Date":{"description":"The date and time at which the response was generated","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} GMT$","type":"string","example":"Thu, 15 Aug 2024 09:48:17 GMT"}},"Cache-Control":{"description":"Directives for caching mechanisms in responses","schema":{"type":"string","example":"private, no-cache, no-store, max-age=0, must-revalidate"}}},"content":{"*/*":{"schema":{"type":"object","properties":{"error-type":{"type":"string","nullable":true},"error-tag":{"type":"string","nullable":true},"error-path":{"type":"string","nullable":true},"error-message":{"type":"string","nullable":true},"error-code":{"type":"integer","format":"int32","nullable":true}},"description":"Original name: TapiErrorDetail","nullable":true,"$$ref":"#/components/schemas/TapiErrorDetail"},"example":{"error-message":"The HTTP method used is not allowed for this endpoint.","error-path":"/v1/resources/11111111-1111-1111-1111-111111111111","error-code":500}}}}},"security":[{"basicAuth":[]}],"__originalOperationId":"fetchUserData","method":"get","path":"/api/v1/subscription"}}