Get Domain API Resource Docs
GET /obp/v7.0.0/banks/BANK_ID/domain-apis/resource-docs
OBPv7.0.0-getDomainApiResourceDocs No role required DynamicAPIDocumentation
The endpoints a Domain API publishes, as OBP Resource Docs: the same endpoints as its OpenAPI document
(BASE_PATH/openapi.json), in the format API Explorer and other OBP tools read. Each one's request_url
and specified_url is its full published path, base path included (for example
/carbon-registry/v1/public/activity), so it can be called as it stands.
base_path (required) is the Domain API's base path, for example carbon-registry/v1. BANK_ID is its
space: a bank's id, or SYS for the system space.
Like the OpenAPI document, these are served whether or not the Domain API is publicly discoverable.
No Authentication is Required.
For more information see here
User Authentication is Optional. The User need not be logged in.
URL Parameters:
BANK_ID: gh.29.uk
JSON response body fields (0)
Possible errors (4)
- OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
- OBP-20055: These query parameters are missing:
- OBP-09029: Domain API not found in this space. Please specify a valid value for DOMAIN_API_ID.
- OBP-50000: Unknown Error.