Jump to

• Request
• Response
• Examples

Get spoke system registration information

get

/status/routing/apis

Request

Query Parameters

• ids(required): array[string]
  The list of ids for which spoke system registration is to be checked. Each value in the list of values should in the format of <api-id>:<api-version>:<path-id>. All three parameters are mandatory and should be non empty values. Incase of mising values or extra values or empty values ,**400 Bad request** will be returned.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Routing Status is TRUE, fabric will be able to route the request with the given combination of api-id, version-id and path-id

Body ()

Root Schema : Results

Type: array

Show Source

• Array of: object Result

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Result"
    },
    "example":[
        {
            "api-id":"tmf-632",
            "api-version":"v4",
            "path-id":"individual",
            "served":true
        },
        {
            "api-id":"tmf-632",
            "api-version":"v4",
            "path-id":"organization",
            "served":false
        }
    ]
}

Example:

[
    {
        "api-id":"tmf-632",
        "api-version":"v4",
        "path-id":"individual",
        "served":true
    },
    {
        "api-id":"tmf-632",
        "api-version":"v4",
        "path-id":"organization",
        "served":false
    }
]

Nested Schema : Result

Type: object

Show Source

• api-id(required): string
• api-version(required): string
• path-id(required): string
• served(required): boolean
  Indicates whether fabric will be able to route the request with the given combination of api-id, version-id, and path-id or not.

{
    "required":[
        "served",
        "api-id",
        "api-version",
        "path-id"
    ],
    "type":"object",
    "properties":{
        "served":{
            "type":"boolean",
            "description":"Indicates whether fabric will be able to route the request with the given combination of api-id, version-id, and path-id or not."
        },
        "api-id":{
            "type":"string"
        },
        "api-version":{
            "type":"string"
        },
        "path-id":{
            "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."
        }
    }
}

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 spoke system registration information for a specific api, version and path by submitting a get request on the REST resource using cURL.

cURL Command

curl --<username:password> --request GET '{FABRIC_HOST}/status/routing/apis?id={api-id}:{version-id}:{path-id}' --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-id":"tmf-632",
        "api-version":"v4",
        "path-id":"individual",
        "served":true
    },
    {
        "api-id":"tmf-632",
        "api-version":"v4",
        "path-id":"organization",
        "served":false
    }
]

Back to Top