Jump to

• Request
• Response
• Examples

Get an OpenAPI

get

/apiManagement/openAPI/v3.0.3/{api-name}/{api-version}

Request

Path Parameters

• api-name(required): string
  Value for the api-name can be obtained by performing the GET all list of openAPIs by using the API /openAPI/v3.0.3. Below are the sample list of values for 'api-name': * `CustomerManagement` and `Party` - the value is a string. * ..
• api-version(required): string
  Value for the api-version can be obtained by performing the GET all list of openAPIs by using the API /openAPI/v3.0.3. Below are the sample values for 'api-version': * `v4`. * ..

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : openAPI

Type: object

Show Source

• schema: string

{
    "type":"object",
    "properties":{
        "schema":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "description":"Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name."
        }
    }
}

Back to Top

Examples

The following example shows how to get an openapi by submitting a get request on the REST resource using cURL.

cURL Command

curl --<username:password> --request GET '{FABRIC_HOST}/apiManagement/openAPI/v3.0.3/{api-name}/{api-version}' --header 'Authorization: Bearer <accessToken> --header 'Content-Type: application/json'

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "api-name": "fa-contacts-new4",
    "api-id": "fa-1014",
    "api-version": "v1",
    "api-resources": [
        {
            "resource-id": "contacts",
            "name": "contacts",
            "resource-path": "{party-name}",
            "path-parameters": [
                {
                    "parameter-name": "party-name",
                    "parameter-type": "string",
                    "is-record-id": true
                }
            ],
            "http-methods": {
                "single-record-methods": [
                    "GET",
                    "PUT",
                    "POST",
                    "HEAD",
                    "OPTIONS",
                    "PATCH",
                    "DELETE"
                ],
                "multi-record-methods": [
                    "GET",
                    "POST",
                    "HEAD",
                    "OPTIONS"
                ]
            },
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_SourceSystemRef",
            "name": "contacts_SourceSystemRef",
            "resource-path": "{party-number}/child/SourceSystemReference",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "http-methods": {
                "single-record-methods": [],
                "multi-record-methods": [
                    "GET",
                    "POST",
                    "HEAD",
                    "OPTIONS"
                ]
            },
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_ContactPoint",
            "name": "contacts_ContactPoint",
            "resource-path": "{party-number}/child/ContactPoint",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "http-methods": {
                "single-record-methods": [],
                "multi-record-methods": [
                    "GET",
                    "POST",
                    "HEAD",
                    "OPTIONS"
                ]
            },
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_SourceSystemRef_Id",
            "name": "contacts_SourceSystemRef_Id",
            "resource-path": "{party-number}/child/SourceSystemReference/{sourcesystem-refid}",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                },
                {
                    "parameter-name": "sourcesystem-refid",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "http-methods": {
                "single-record-methods": [],
                "multi-record-methods": [
                    "GET",
                    "POST",
                    "HEAD",
                    "OPTIONS"
                ]
            },
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_ContactPoint_Id",
            "name": "contacts_ContactPoint_Id",
            "resource-path": "{party-number}/child/ContactPoint/{contactpoint-id}",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                },
                {
                    "parameter-name": "contactpoint-id",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "http-methods": {
                "single-record-methods": [],
                "multi-record-methods": [
                    "GET",
                    "POST",
                    "HEAD",
                    "OPTIONS"
                ]
            },
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        }
    ],
    "alternative-root-path": "contacts",
    "callback-registration-path": "",
    "api-events": [
        {
            "name": "Event1",
            "api-resource": "contacts"
        },
        {
            "name": "Event2",
            "api-resource": "contacts"
        },
        {
            "name": "createEvent",
            "api-resource": "contacts_SourceSystemRef"
        },
        {
            "name": "deleteEvent",
            "api-resource": "contacts_SourceSystemRef"
        },
        {
            "name": "updateEvent",
            "api-resource": "contacts_SourceSystemRef"
        },
        {
            "name": "event1",
            "api-resource": "contacts_ContactPoint"
        },
        {
            "name": "event2",
            "api-resource": "contacts_ContactPoint"
        }
    ],
    "openapi-document-url": "",
    "id": "fa-contacts-new4ll8q5"
}

Back to Top