Skip to main content

Fetch the service ids registered against a bridge

Retrieve the unique identifiers, known as service IDs, that are associated with a specific bridge.

GET/api/hiecm/gateway/v3/bridge-services

In this context, a bridge acts as an intermediary component that connects various services or networks, enabling them to communicate with each other. When you call this API, it queries the bridge to gather a list of all the service IDs that have been registered with it.

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions, sent with a Bearer prefix.

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds

X-CM-IDstringRequired

Suffix of the consent manager to which the request was intended

Responses

200

OK

bridgeobject
bridge.idstring
bridge.namestring
bridge.urlstring
bridge.activeboolean
bridge.blocklistedboolean
servicesobject[]
services.idstring
services.namestring
services.typesstring[]
services.endpointsobject
services.endpoints.hipEndpointsobject[]
services.endpoints.hipEndpoints.usestring
services.endpoints.hipEndpoints.connectionTypestring
services.endpoints.hipEndpoints.addressstring
services.endpoints.hiuEndpointsobject[]
services.endpoints.hiuEndpoints.usestring
services.endpoints.hiuEndpoints.connectionTypestring
services.endpoints.hiuEndpoints.addressstring
services.endpoints.healthLockerEndpointsobject[]
services.endpoints.healthLockerEndpoints.usestring
services.endpoints.healthLockerEndpoints.connectionTypestring
services.endpoints.healthLockerEndpoints.addressstring
services.activeboolean
204

No Content

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1001 - No data found. May be returned either bare (ABDM-1001) or with a trailing ": " separator (ABDM-1001: ); match on the code itself and tolerate the separator.

error.messagestringRequired
400

Bad Request

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1015 - Invalid Response. May be returned either bare (ABDM-1015) or with a trailing ": " separator (ABDM-1015: ); match on the code itself and tolerate the separator.

error.messagestringRequired
401

Unauthorized

Everything returns 401

codestring

900901 - Invalid Credentials. May be returned either bare or with a trailing ": " separator; match on the code itself and tolerate the separator.

messagestring
descriptionstring
403

Forbidden. The caller is authenticated but is not permitted to perform this operation on this resource.

500

Internal Server Error

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-9999 - Unknown exception. May be returned either bare (ABDM-9999) or with a trailing ": " separator (ABDM-9999: ); match on the code itself and tolerate the separator.

error.messagestringRequired
503

Service Unavailable

codestringRequired

ABDM-1024 - Dependent service unavailable. May be returned either bare (ABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.

messagestringRequired