Get an API.
get
/admin/apis/{id}
Retrieves the API identified by the path parameter.
Request
Path Parameters
-
id(required): string
The ID of the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
objectDefines an API configuration, including its identity, resources, events, and routing metadata.
Show Source
Nested Schema : Api-generic-resource
Type:
Show Source
object-
cors-preflight-handling: string
Allowed Values:
[ "fabric", "routing-target" ] -
http-methods: array
http-methods
-
interaction-context-enrichment-specification: string
-
name: string
-
path-parameters: array
path-parameters
-
resource-id: string
-
resource-path: string
-
routing-ambiguity-resolution-strategy: string
Allowed Values:
[ "HTTP400BadRequest", "HTTP300MultipleChoices", "QueryHighestPriority", "QueryAllFirstMatch", "QueryAllRankedMatch", "QueryAllConflictFail" ]
Nested Schema : Http-method
Type:
Show Source
object-
method: string
Allowed Values:
[ "GET", "PUT", "POST", "PATCH", "DELETE", "HEAD", "OPTIONS" ]
Nested Schema : Api-path-parameter
Type:
Show Source
object-
description: string
-
is-record-id: boolean
-
parameter-name: string
-
parameter-type: string
Allowed Values:
[ "string", "number", "none" ]
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
404 Response
Not Found
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension.
Examples
The following example shows how to get an API object by submitting a GET request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X GET
https://{FABRIC_HOST}/admin/apis/{id} -H "Content-Type:
application/json" | json_ppExample of Response Body
The following shows the contents of the response body in JSON format.
{
"api-name": "Payment",
"api-number": 676,
"api-version": "v4",
"api-root-resources": [
"Payment",
"Refund",
"PaymentAllocation"
],
"api-events": [
{
"name": "PaymentCreateEvent"
},
{
"name": "PaymentAttributeValueChangeEvent"
},
{
"name": "PaymentStateChangeEvent"
},
{
"name": "PaymentDeleteEvent"
},
{
"name": "RefundCreateEvent"
},
{
"name": "RefundAttributeValueChangeEvent"
},
{
"name": "RefundStateChangeEvent"
},
{
"name": "RefundDeleteEvent"
}
],
"id": "payment-v4",
"type": "managed"
}