Get a system descriptor.
get
/admin/systemDescriptors/{id}
Retrieves the system descriptor identified by the path parameter.
Request
Path Parameters
-
id(required): string
The ID of the SystemDescriptors to be retrieved.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
arrayContains a collection of system descriptor configurations.
Show Source
Nested Schema : SystemDescriptor
Type:
Show Source
object-
domain: string
-
edk: object
edk
-
external: object
External
-
header-enrichment: object
header-enrichment
-
id: string
-
system: string
-
target-name: string
-
type: string
Allowed Values:
[ "internal", "external" ]
Nested Schema : edk
Type:
Show Source
object-
apis: array
apis
Minimum Number of Items:
1Describes Adapter capabilities that are supported for a particular API. -
enabled: boolean
If set, EDK is enabled for the Adapter/System .
-
version: string
If EDK is enabled, what is the version it supports .
Match One Schema
Show Source
Nested Schema : header-enrichment
Type:
Show Source
object-
expected-headers: array
expected-headers
Minimum Number of Items:
1 -
fixed-headers: object
fixed-headers
Additional Properties Allowed: additionalProperties
Nested Schema : apis
Type:
arrayMinimum Number of Items:
1Describes Adapter capabilities that are supported for a particular API.
Show Source
Nested Schema : items
Type:
Show Source
object-
api-id: string
Pattern:
^[a-z0-9]{1,8}-[0-9]{1,4}$The unique ID of the API . -
api-version: string
The API version .
-
types: array
types
Minimum Number of Items:
1
Match One Schema
Show Source
Nested Schema : items
Type:
Show Source
object-
base-name: string
-
extensibility-support: string
Allowed Values:
[ "NONE", "AUGMENTATION_ONLY", "TYPE_EXT_ONLY", "AUGMENTATION_AND_TYPE_EXT" ] -
mapping-directions: array
mapping-directions
Minimum Number of Items:
1 -
type-extensibility-support: object
type-extensibility-support
-
type-name: string
Match One Schema
Show Source
Nested Schema : mapping-directions
Type:
arrayMinimum Number of Items:
Show Source
1-
Array of:
string
Allowed Values:
[ "FROM_MODEL", "TO_MODEL" ]
Nested Schema : type-extensibility-support
Type:
Show Source
object-
levels: string
Allowed Values:
[ "SINGLE", "MULTI" ] -
siblings: boolean
Nested Schema : Http-method
Type:
Show Source
object-
method: string
Allowed Values:
[ "GET", "PUT", "POST", "PATCH", "DELETE", "HEAD", "OPTIONS" ]
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 a system descriptor by submitting a GET request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X GET
https://{FABRIC_HOST}/admin/systemDescriptors/{id} -H
"Content-Type: application/json" | json_pp
Example of Response Body
The following shows an example of the response body in JSON format.
{
"target-name": "FA629-Listeners",
"external": {
"apis": [
{
"api-id": "fa-101",
"api-version": "v9",
"api-resources": [
{
"resources": [
{
"resource-id": "contacts"
},
{
"resource-id": "contacts_SourceSystemRef"
},
{
"resource-id": "contacts_ContactPoint"
},
{
"resource-id": "contacts_SourceSystemRef_Id"
},
{
"resource-id": "contacts_ContactPoint_Id"
}
]
}
]
}
]
},
"id": "fa629-listenersgsh2h",
"system": "fusion",
"domain": "fusion",
"type": "external"
}