REST API for Oracle Digital Experience for Communications Industry Fabric

Get an API annex.

get

/admin/apiAnnexes/{id}

Retrieves the API annex identified by the path parameter.

Request

Path Parameters

id(required): string

The ID of the APIAnnex.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : APIAnnexResponse

Type: object

Represents a persisted API annex returned by the service.

Show Source

api-events: array api-events
api-resources: array api-resources
base-api: string
id: string

{
    "description":"Represents a persisted API annex returned by the service.",
    "type":"object",
    "properties":{
        "base-api":{
            "type":"string"
        },
        "api-resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Api-generic-resource"
            }
        },
        "api-events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Api-event"
            }
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : api-events

Type: array

Show Source

Array of: object Api-event

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Api-event"
    }
}

Nested Schema : api-resources

Type: array

Show Source

Array of: object Api-generic-resource

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Api-generic-resource"
    }
}

Nested Schema : Api-event

Type: object

Show Source

api-resource: string
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "api-resource":{
            "type":"string"
        }
    }
}

Nested Schema : Api-generic-resource

Type: object

Show Source

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" ]

{
    "type":"object",
    "properties":{
        "resource-id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "resource-path":{
            "type":"string"
        },
        "path-parameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Api-path-parameter"
            }
        },
        "http-methods":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Api-http-method"
            }
        },
        "cors-preflight-handling":{
            "type":"string",
            "enum":[
                "fabric",
                "routing-target"
            ]
        },
        "routing-ambiguity-resolution-strategy":{
            "type":"string",
            "enum":[
                "HTTP400BadRequest",
                "HTTP300MultipleChoices",
                "QueryHighestPriority",
                "QueryAllFirstMatch",
                "QueryAllRankedMatch",
                "QueryAllConflictFail"
            ]
        },
        "interaction-context-enrichment-specification":{
            "type":"string"
        }
    }
}

Nested Schema : http-methods

Type: array

Show Source

Array of: object Api-http-method

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Api-http-method"
    }
}

Nested Schema : path-parameters

Type: array

Show Source

Array of: object Api-path-parameter

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Api-path-parameter"
    }
}

Nested Schema : Api-http-method

Type: object

Show Source

multi-record-methods: array multi-record-methods
single-record-methods: array single-record-methods

{
    "type":"object",
    "properties":{
        "single-record-methods":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Http-method"
            }
        },
        "multi-record-methods":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Http-method"
            }
        }
    }
}

Nested Schema : multi-record-methods

Type: array

Show Source

Array of: object Http-method

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Http-method"
    }
}

Nested Schema : single-record-methods

Type: array

Show Source

Array of: object Http-method

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Http-method"
    }
}

Nested Schema : Http-method

Type: object

Show Source

method: string

Allowed Values: [ "GET", "PUT", "POST", "PATCH", "DELETE", "HEAD", "OPTIONS" ]

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "enum":[
                "GET",
                "PUT",
                "POST",
                "PATCH",
                "DELETE",
                "HEAD",
                "OPTIONS"
            ]
        }
    }
}

Nested Schema : Api-path-parameter

Type: object

Show Source

description: string
is-record-id: boolean
parameter-name: string
parameter-type: string

Allowed Values: [ "string", "number", "none" ]

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "parameter-type":{
            "type":"string",
            "enum":[
                "string",
                "number",
                "none"
            ]
        },
        "parameter-name":{
            "type":"string"
        },
        "is-record-id":{
            "type":"boolean"
        }
    }
}

400 Response

Bad Request

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

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

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

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

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."
        }
    }
}

Examples

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

cURL Command

curl --<username:password> --request GET '{FABRIC_HOST}//admin/apiAnnexes/{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.

{
    "base-api": "industries-tax-calculation-v4",
    "api-resources": [
        {
            "resource-id": "addressValidation",
            "name": "addressValidation",
            "resource-path": "addressValidation",
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "QueryAllFirstMatch"
        }
    ],
    "id": "industries-tax-calculation-v4-annex-apia2ptcm"
}