REST API for Oracle Digital Experience for Communications Industry Fabric

Get all system descriptors

get

/admin/systemDescriptors

Request

Query Parameters

api-id: string
api-version: string
domain: string
owner: string

Allowed Values: [ "internal", "tenant" ]
system: string
type: string

Allowed Values: [ "internal", "external" ]

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : SystemDescriptors

Type: array

Show Source

Array of: object SystemDescriptor

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SystemDescriptor"
    }
}

Nested Schema : SystemDescriptor

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "target-name":{
            "type":"string"
        },
        "external":{
            "$ref":"#/components/schemas/External"
        },
        "header-enrichment":{
            "type":"object",
            "properties":{
                "expected-headers":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"string",
                        "nullable":false
                    }
                },
                "fixed-headers":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                }
            },
            "anyOf":[
                {
                    "required":[
                        "expected-headers"
                    ]
                },
                {
                    "required":[
                        "fixed-headers"
                    ]
                },
                {
                    "required":[
                        "expected-headers",
                        "fixed-headers"
                    ]
                }
            ]
        },
        "edk":{
            "type":"object",
            "properties":{
                "enabled":{
                    "description":"if set, EDK is enabled for the Adapter/System\n",
                    "type":"boolean"
                },
                "version":{
                    "description":"if EDK is enabled, what is the version it supports\n",
                    "type":"string",
                    "nullable":false
                },
                "apis":{
                    "description":"Describes Adapter capabilities that are supported for a particular API.\n",
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object",
                        "properties":{
                            "api-id":{
                                "description":"the unique ID of the API\n",
                                "type":"string",
                                "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
                            },
                            "api-version":{
                                "description":"the API version\n",
                                "type":"string"
                            },
                            "types":{
                                "type":"array",
                                "minItems":1,
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "base-name":{
                                            "type":"string",
                                            "nullable":false
                                        },
                                        "type-name":{
                                            "type":"string",
                                            "nullable":false
                                        },
                                        "mapping-directions":{
                                            "type":"array",
                                            "minItems":1,
                                            "items":{
                                                "type":"string",
                                                "enum":[
                                                    "FROM_MODEL",
                                                    "TO_MODEL"
                                                ]
                                            }
                                        },
                                        "extensibility-support":{
                                            "type":"string",
                                            "enum":[
                                                "NONE",
                                                "AUGMENTATION_ONLY",
                                                "TYPE_EXT_ONLY",
                                                "AUGMENTATION_AND_TYPE_EXT"
                                            ]
                                        },
                                        "type-extensibility-support":{
                                            "type":"object",
                                            "properties":{
                                                "levels":{
                                                    "type":"string",
                                                    "enum":[
                                                        "SINGLE",
                                                        "MULTI"
                                                    ]
                                                },
                                                "siblings":{
                                                    "type":"boolean"
                                                }
                                            },
                                            "anyOf":[
                                                {
                                                    "required":[
                                                        "levels"
                                                    ]
                                                },
                                                {
                                                    "required":[
                                                        "siblings"
                                                    ]
                                                }
                                            ]
                                        }
                                    },
                                    "oneOf":[
                                        {
                                            "required":[
                                                "type-name",
                                                "mapping-directions",
                                                "extensibility-support"
                                            ]
                                        },
                                        {
                                            "required":[
                                                "base-name",
                                                "type-name",
                                                "extensibility-support"
                                            ]
                                        }
                                    ]
                                }
                            }
                        },
                        "oneOf":[
                            {
                                "required":[
                                    "api-id",
                                    "api-version",
                                    "types"
                                ]
                            }
                        ]
                    }
                }
            },
            "oneOf":[
                {
                    "required":[
                        "enabled",
                        "version",
                        "apis"
                    ]
                }
            ]
        },
        "id":{
            "type":"string"
        },
        "system":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "internal",
                "external"
            ]
        }
    }
}

Nested Schema : edk

Type: object

Show Source

apis: array apis

Minimum Number of Items: 1

Describes 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

{
    "type":"object",
    "properties":{
        "enabled":{
            "description":"if set, EDK is enabled for the Adapter/System\n",
            "type":"boolean"
        },
        "version":{
            "description":"if EDK is enabled, what is the version it supports\n",
            "type":"string",
            "nullable":false
        },
        "apis":{
            "description":"Describes Adapter capabilities that are supported for a particular API.\n",
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "api-id":{
                        "description":"the unique ID of the API\n",
                        "type":"string",
                        "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
                    },
                    "api-version":{
                        "description":"the API version\n",
                        "type":"string"
                    },
                    "types":{
                        "type":"array",
                        "minItems":1,
                        "items":{
                            "type":"object",
                            "properties":{
                                "base-name":{
                                    "type":"string",
                                    "nullable":false
                                },
                                "type-name":{
                                    "type":"string",
                                    "nullable":false
                                },
                                "mapping-directions":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"string",
                                        "enum":[
                                            "FROM_MODEL",
                                            "TO_MODEL"
                                        ]
                                    }
                                },
                                "extensibility-support":{
                                    "type":"string",
                                    "enum":[
                                        "NONE",
                                        "AUGMENTATION_ONLY",
                                        "TYPE_EXT_ONLY",
                                        "AUGMENTATION_AND_TYPE_EXT"
                                    ]
                                },
                                "type-extensibility-support":{
                                    "type":"object",
                                    "properties":{
                                        "levels":{
                                            "type":"string",
                                            "enum":[
                                                "SINGLE",
                                                "MULTI"
                                            ]
                                        },
                                        "siblings":{
                                            "type":"boolean"
                                        }
                                    },
                                    "anyOf":[
                                        {
                                            "required":[
                                                "levels"
                                            ]
                                        },
                                        {
                                            "required":[
                                                "siblings"
                                            ]
                                        }
                                    ]
                                }
                            },
                            "oneOf":[
                                {
                                    "required":[
                                        "type-name",
                                        "mapping-directions",
                                        "extensibility-support"
                                    ]
                                },
                                {
                                    "required":[
                                        "base-name",
                                        "type-name",
                                        "extensibility-support"
                                    ]
                                }
                            ]
                        }
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "api-id",
                            "api-version",
                            "types"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "enabled",
                "version",
                "apis"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "enabled":{
            "description":"if set, EDK is enabled for the Adapter/System\n",
            "type":"boolean"
        },
        "version":{
            "description":"if EDK is enabled, what is the version it supports\n",
            "type":"string",
            "nullable":false
        },
        "apis":{
            "description":"Describes Adapter capabilities that are supported for a particular API.\n",
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "api-id":{
                        "description":"the unique ID of the API\n",
                        "type":"string",
                        "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
                    },
                    "api-version":{
                        "description":"the API version\n",
                        "type":"string"
                    },
                    "types":{
                        "type":"array",
                        "minItems":1,
                        "items":{
                            "type":"object",
                            "properties":{
                                "base-name":{
                                    "type":"string",
                                    "nullable":false
                                },
                                "type-name":{
                                    "type":"string",
                                    "nullable":false
                                },
                                "mapping-directions":{
                                    "type":"array",
                                    "minItems":1,
                                    "items":{
                                        "type":"string",
                                        "enum":[
                                            "FROM_MODEL",
                                            "TO_MODEL"
                                        ]
                                    }
                                },
                                "extensibility-support":{
                                    "type":"string",
                                    "enum":[
                                        "NONE",
                                        "AUGMENTATION_ONLY",
                                        "TYPE_EXT_ONLY",
                                        "AUGMENTATION_AND_TYPE_EXT"
                                    ]
                                },
                                "type-extensibility-support":{
                                    "type":"object",
                                    "properties":{
                                        "levels":{
                                            "type":"string",
                                            "enum":[
                                                "SINGLE",
                                                "MULTI"
                                            ]
                                        },
                                        "siblings":{
                                            "type":"boolean"
                                        }
                                    },
                                    "anyOf":[
                                        {
                                            "required":[
                                                "levels"
                                            ]
                                        },
                                        {
                                            "required":[
                                                "siblings"
                                            ]
                                        }
                                    ]
                                }
                            },
                            "oneOf":[
                                {
                                    "required":[
                                        "type-name",
                                        "mapping-directions",
                                        "extensibility-support"
                                    ]
                                },
                                {
                                    "required":[
                                        "base-name",
                                        "type-name",
                                        "extensibility-support"
                                    ]
                                }
                            ]
                        }
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "api-id",
                            "api-version",
                            "types"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "enabled",
                "version",
                "apis"
            ]
        }
    ]
}

Nested Schema : External

Type: object

Show Source

apis: array apis

{
    "type":"object",
    "properties":{
        "apis":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Generic-api"
            }
        }
    }
}

Nested Schema : header-enrichment

Type: object

Show Source

expected-headers: array expected-headers

Minimum Number of Items: 1
fixed-headers: object fixed-headers

Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "expected-headers":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"string",
                "nullable":false
            }
        },
        "fixed-headers":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "anyOf":[
        {
            "required":[
                "expected-headers"
            ]
        },
        {
            "required":[
                "fixed-headers"
            ]
        },
        {
            "required":[
                "expected-headers",
                "fixed-headers"
            ]
        }
    ]
}

Nested Schema : apis

Type: array

Minimum Number of Items: 1

Describes Adapter capabilities that are supported for a particular API.

Show Source

Array of: object items

{
    "description":"Describes Adapter capabilities that are supported for a particular API.\n",
    "type":"array",
    "minItems":1,
    "items":{
        "type":"object",
        "properties":{
            "api-id":{
                "description":"the unique ID of the API\n",
                "type":"string",
                "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
            },
            "api-version":{
                "description":"the API version\n",
                "type":"string"
            },
            "types":{
                "type":"array",
                "minItems":1,
                "items":{
                    "type":"object",
                    "properties":{
                        "base-name":{
                            "type":"string",
                            "nullable":false
                        },
                        "type-name":{
                            "type":"string",
                            "nullable":false
                        },
                        "mapping-directions":{
                            "type":"array",
                            "minItems":1,
                            "items":{
                                "type":"string",
                                "enum":[
                                    "FROM_MODEL",
                                    "TO_MODEL"
                                ]
                            }
                        },
                        "extensibility-support":{
                            "type":"string",
                            "enum":[
                                "NONE",
                                "AUGMENTATION_ONLY",
                                "TYPE_EXT_ONLY",
                                "AUGMENTATION_AND_TYPE_EXT"
                            ]
                        },
                        "type-extensibility-support":{
                            "type":"object",
                            "properties":{
                                "levels":{
                                    "type":"string",
                                    "enum":[
                                        "SINGLE",
                                        "MULTI"
                                    ]
                                },
                                "siblings":{
                                    "type":"boolean"
                                }
                            },
                            "anyOf":[
                                {
                                    "required":[
                                        "levels"
                                    ]
                                },
                                {
                                    "required":[
                                        "siblings"
                                    ]
                                }
                            ]
                        }
                    },
                    "oneOf":[
                        {
                            "required":[
                                "type-name",
                                "mapping-directions",
                                "extensibility-support"
                            ]
                        },
                        {
                            "required":[
                                "base-name",
                                "type-name",
                                "extensibility-support"
                            ]
                        }
                    ]
                }
            }
        },
        "oneOf":[
            {
                "required":[
                    "api-id",
                    "api-version",
                    "types"
                ]
            }
        ]
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "api-id":{
            "description":"the unique ID of the API\n",
            "type":"string",
            "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
        },
        "api-version":{
            "description":"the API version\n",
            "type":"string"
        },
        "types":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "base-name":{
                        "type":"string",
                        "nullable":false
                    },
                    "type-name":{
                        "type":"string",
                        "nullable":false
                    },
                    "mapping-directions":{
                        "type":"array",
                        "minItems":1,
                        "items":{
                            "type":"string",
                            "enum":[
                                "FROM_MODEL",
                                "TO_MODEL"
                            ]
                        }
                    },
                    "extensibility-support":{
                        "type":"string",
                        "enum":[
                            "NONE",
                            "AUGMENTATION_ONLY",
                            "TYPE_EXT_ONLY",
                            "AUGMENTATION_AND_TYPE_EXT"
                        ]
                    },
                    "type-extensibility-support":{
                        "type":"object",
                        "properties":{
                            "levels":{
                                "type":"string",
                                "enum":[
                                    "SINGLE",
                                    "MULTI"
                                ]
                            },
                            "siblings":{
                                "type":"boolean"
                            }
                        },
                        "anyOf":[
                            {
                                "required":[
                                    "levels"
                                ]
                            },
                            {
                                "required":[
                                    "siblings"
                                ]
                            }
                        ]
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "type-name",
                            "mapping-directions",
                            "extensibility-support"
                        ]
                    },
                    {
                        "required":[
                            "base-name",
                            "type-name",
                            "extensibility-support"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "api-id",
                "api-version",
                "types"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "api-id":{
            "description":"the unique ID of the API\n",
            "type":"string",
            "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
        },
        "api-version":{
            "description":"the API version\n",
            "type":"string"
        },
        "types":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"object",
                "properties":{
                    "base-name":{
                        "type":"string",
                        "nullable":false
                    },
                    "type-name":{
                        "type":"string",
                        "nullable":false
                    },
                    "mapping-directions":{
                        "type":"array",
                        "minItems":1,
                        "items":{
                            "type":"string",
                            "enum":[
                                "FROM_MODEL",
                                "TO_MODEL"
                            ]
                        }
                    },
                    "extensibility-support":{
                        "type":"string",
                        "enum":[
                            "NONE",
                            "AUGMENTATION_ONLY",
                            "TYPE_EXT_ONLY",
                            "AUGMENTATION_AND_TYPE_EXT"
                        ]
                    },
                    "type-extensibility-support":{
                        "type":"object",
                        "properties":{
                            "levels":{
                                "type":"string",
                                "enum":[
                                    "SINGLE",
                                    "MULTI"
                                ]
                            },
                            "siblings":{
                                "type":"boolean"
                            }
                        },
                        "anyOf":[
                            {
                                "required":[
                                    "levels"
                                ]
                            },
                            {
                                "required":[
                                    "siblings"
                                ]
                            }
                        ]
                    }
                },
                "oneOf":[
                    {
                        "required":[
                            "type-name",
                            "mapping-directions",
                            "extensibility-support"
                        ]
                    },
                    {
                        "required":[
                            "base-name",
                            "type-name",
                            "extensibility-support"
                        ]
                    }
                ]
            }
        }
    },
    "oneOf":[
        {
            "required":[
                "api-id",
                "api-version",
                "types"
            ]
        }
    ]
}

Nested Schema : types

Type: array

Minimum Number of Items: 1

Show Source

Array of: object items

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"object",
        "properties":{
            "base-name":{
                "type":"string",
                "nullable":false
            },
            "type-name":{
                "type":"string",
                "nullable":false
            },
            "mapping-directions":{
                "type":"array",
                "minItems":1,
                "items":{
                    "type":"string",
                    "enum":[
                        "FROM_MODEL",
                        "TO_MODEL"
                    ]
                }
            },
            "extensibility-support":{
                "type":"string",
                "enum":[
                    "NONE",
                    "AUGMENTATION_ONLY",
                    "TYPE_EXT_ONLY",
                    "AUGMENTATION_AND_TYPE_EXT"
                ]
            },
            "type-extensibility-support":{
                "type":"object",
                "properties":{
                    "levels":{
                        "type":"string",
                        "enum":[
                            "SINGLE",
                            "MULTI"
                        ]
                    },
                    "siblings":{
                        "type":"boolean"
                    }
                },
                "anyOf":[
                    {
                        "required":[
                            "levels"
                        ]
                    },
                    {
                        "required":[
                            "siblings"
                        ]
                    }
                ]
            }
        },
        "oneOf":[
            {
                "required":[
                    "type-name",
                    "mapping-directions",
                    "extensibility-support"
                ]
            },
            {
                "required":[
                    "base-name",
                    "type-name",
                    "extensibility-support"
                ]
            }
        ]
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "base-name":{
            "type":"string",
            "nullable":false
        },
        "type-name":{
            "type":"string",
            "nullable":false
        },
        "mapping-directions":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"string",
                "enum":[
                    "FROM_MODEL",
                    "TO_MODEL"
                ]
            }
        },
        "extensibility-support":{
            "type":"string",
            "enum":[
                "NONE",
                "AUGMENTATION_ONLY",
                "TYPE_EXT_ONLY",
                "AUGMENTATION_AND_TYPE_EXT"
            ]
        },
        "type-extensibility-support":{
            "type":"object",
            "properties":{
                "levels":{
                    "type":"string",
                    "enum":[
                        "SINGLE",
                        "MULTI"
                    ]
                },
                "siblings":{
                    "type":"boolean"
                }
            },
            "anyOf":[
                {
                    "required":[
                        "levels"
                    ]
                },
                {
                    "required":[
                        "siblings"
                    ]
                }
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "type-name",
                "mapping-directions",
                "extensibility-support"
            ]
        },
        {
            "required":[
                "base-name",
                "type-name",
                "extensibility-support"
            ]
        }
    ]
}

Match One Schema

Show Source

{
    "type":"object",
    "properties":{
        "base-name":{
            "type":"string",
            "nullable":false
        },
        "type-name":{
            "type":"string",
            "nullable":false
        },
        "mapping-directions":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"string",
                "enum":[
                    "FROM_MODEL",
                    "TO_MODEL"
                ]
            }
        },
        "extensibility-support":{
            "type":"string",
            "enum":[
                "NONE",
                "AUGMENTATION_ONLY",
                "TYPE_EXT_ONLY",
                "AUGMENTATION_AND_TYPE_EXT"
            ]
        },
        "type-extensibility-support":{
            "type":"object",
            "properties":{
                "levels":{
                    "type":"string",
                    "enum":[
                        "SINGLE",
                        "MULTI"
                    ]
                },
                "siblings":{
                    "type":"boolean"
                }
            },
            "anyOf":[
                {
                    "required":[
                        "levels"
                    ]
                },
                {
                    "required":[
                        "siblings"
                    ]
                }
            ]
        }
    },
    "oneOf":[
        {
            "required":[
                "type-name",
                "mapping-directions",
                "extensibility-support"
            ]
        },
        {
            "required":[
                "base-name",
                "type-name",
                "extensibility-support"
            ]
        }
    ]
}

Nested Schema : mapping-directions

Type: array

Minimum Number of Items: 1

Show Source

Array of: string

Allowed Values: [ "FROM_MODEL", "TO_MODEL" ]

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"string",
        "enum":[
            "FROM_MODEL",
            "TO_MODEL"
        ]
    }
}

Nested Schema : type-extensibility-support

Type: object

Show Source

levels: string

Allowed Values: [ "SINGLE", "MULTI" ]
siblings: boolean

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"string",
            "enum":[
                "SINGLE",
                "MULTI"
            ]
        },
        "siblings":{
            "type":"boolean"
        }
    },
    "anyOf":[
        {
            "required":[
                "levels"
            ]
        },
        {
            "required":[
                "siblings"
            ]
        }
    ]
}

Nested Schema : apis

Type: array

Show Source

Array of: object Generic-api

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Generic-api"
    }
}

Nested Schema : Generic-api

Type: object

Show Source

api-id: string
api-resources: array api-resources
api-timeout: string
api-version: string

{
    "type":"object",
    "properties":{
        "api-id":{
            "type":"string"
        },
        "api-version":{
            "type":"string"
        },
        "api-timeout":{
            "type":"string"
        },
        "api-resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Generic-api-resource"
            }
        }
    }
}

Nested Schema : api-resources

Type: array

Show Source

Array of: object Generic-api-resource

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

Nested Schema : Generic-api-resource

Type: object

Show Source

resources: array resources
url-prefix: string

{
    "type":"object",
    "properties":{
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Generic-resource"
            }
        },
        "url-prefix":{
            "type":"string"
        }
    }
}

Nested Schema : resources

Type: array

Show Source

Array of: object Generic-resource

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

Nested Schema : Generic-resource

Type: object

Show Source

multi-record-methods: array multi-record-methods
resource-id: string
single-record-methods: array single-record-methods

{
    "type":"object",
    "properties":{
        "resource-id":{
            "type":"string"
        },
        "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 : expected-headers

Type: array

Minimum Number of Items: 1

Show Source

Array of: string

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"string",
        "nullable":false
    }
}

Nested Schema : fixed-headers

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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 all system descriptors 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 -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-Listener",
        "id": "fa-cdm-tmf629-rest-listener",
        "system": "FA",
        "domain": "CDM",
        "type": "internal"
    },
    {
        "target-name": "BRM",
        "external": {
            "offered-apis": [
                {
                    "api-name": "customerBillManagement",
                    "api-id": "tmf-678",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "customerBill",
                        "customerBillOnDemand",
                        "appliedCustomerBillingRate",
                        "customerBillInvoice",
                        "invoice",
                        "billingCycle"
                    ]
                },
                {
                    "api-name": "accountManagement",
                    "api-id": "tmf-666",
                    "api-version": "v4",
                    "api-timeout": 1000.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "settlementAccount",
                        "billPresentationMedia",
                        "billingCycleSpecification",
                        "billingAccount",
                        "financialAccount",
                        "partyAccount",
                        "billFormat"
                    ]
                },
                {
                    "api-name": "payment",
                    "api-id": "tmf-676",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "paymentAllocation",
                        "payment",
                        "refund"
                    ]
                },
                {
                    "api-name": "usageManagement",
                    "api-id": "tmf-635",
                    "api-version": "v2",
                    "url-prefix": "brm",
                    "api-resources": [
                        "usageSpecification",
                        "usage"
                    ]
                }
            ]
        },
        "id": "brmsz5lm",
        "system": "default",
        "domain": "default",
        "type": "external"
    },
    {
        "target-name": "BRM-For-Merge",
        "external": {
            "offered-apis": [
                {
                    "api-name": "validateMerge",
                    "api-id": "merge-100",
                    "api-version": "v1",
                    "url-prefix": "brm",
                    "api-resources": [
                        "contact",
                        "organization"
                    ]
                }
            ]
        },
        "id": "brm-for-merge",
        "system": "BRM",
        "domain": "Billing",
        "type": "external"
    },
    {
        "target-name": "FA666-Listener",
        "id": "fa-cdm-tmf666-rest-listener",
        "system": "FA",
        "domain": "CDM",
        "type": "internal"
    },
    {
        "target-name": "newSystem",
        "external": {
            "apis": [
                {
                    "api-id": "tmf-663",
                    "api-version": "v4",
                    "api-resources": [
                        {
                            "resources": [
                                {
                                    "resource-id": "res-1"
                                }
                            ]
                        }
                    ]
                },
                {
                    "api-id": "tmf-637",
                    "api-version": "v4",
                    "api-resources": [
                        {
                            "resources": [
                                {
                                    "resource-id": "res-1"
                                }
                            ]
                        }
                    ]
                }
            ],
            "offered-apis": [
                {
                    "api-name": "shoppingCart",
                    "api-id": "tmf-663",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "shoppingCart"
                    ]
                },
                {
                    "api-name": "productInventory",
                    "api-id": "tmf-637",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "product"
                    ]
                }
            ]
        },
        "id": "newsystemll8dp",
        "system": "default",
        "domain": "default",
        "type": "external"
    },
    {
        "target-name": "FA632-Listener",
        "id": "fa-cdm-tmf632-rest-listener",
        "system": "FA",
        "domain": "CDM",
        "type": "internal"
    },
    {
        "target-name": "fusion",
        "external": {
            "apis": [
                {
                    "api-id": "fa-101",
                    "api-version": "v5",
                    "api-resources": [
                        {
                            "resources": [
                                {
                                    "resource-id": "contacts_SourceSystemRef"
                                },
                                {
                                    "resource-id": "contacts_ContactPoint"
                                },
                                {
                                    "resource-id": "contacts_SourceSystemRef_Id"
                                },
                                {
                                    "resource-id": "contacts_ContactPoint_Id"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "id": "fusionppqgk",
        "system": "fusion",
        "domain": "fusion",
        "type": "external"
    },
    {
        "target-name": "BillingSystem",
        "external": {
            "offered-apis": [
                {
                    "api-name": "customerBillManagement",
                    "api-id": "tmf-678",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "customerBill"
                    ]
                },
                {
                    "api-name": "payment",
                    "api-id": "tmf-676",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "payment"
                    ]
                },
                {
                    "api-name": "prepayBalanceManagement",
                    "api-id": "tmf-654",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "disputeBalance"
                    ]
                }
            ]
        },
        "id": "billingsystembbvj2",
        "system": "default",
        "domain": "default",
        "type": "external"
    },
    {
        "target-name": "Buying",
        "external": {
            "apis": [
                {
                    "api-id": "tmf-637",
                    "api-version": "v4",
                    "api-resources": [
                        {
                            "resources": [
                                {
                                    "resource-id": "res-1"
                                }
                            ],
                            "url-prefix": "cx/industry/buying/tmf-api"
                        }
                    ]
                },
                {
                    "api-id": "tmf-663",
                    "api-version": "v4",
                    "api-resources": [
                        {
                            "resources": [
                                {
                                    "resource-id": "res-1"
                                }
                            ],
                            "url-prefix": "cx/industry/buying/tmf-api"
                        }
                    ]
                }
            ],
            "offered-apis": [
                {
                    "api-name": "agreementManagement",
                    "api-id": "tmf-651",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "agreement"
                    ]
                },
                {
                    "api-name": "customerManagement",
                    "api-id": "tmf-629",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "customer"
                    ]
                },
                {
                    "api-name": "party",
                    "api-id": "tmf-632",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "individual"
                    ]
                },
                {
                    "api-name": "accountManagement",
                    "api-id": "tmf-666",
                    "api-version": "v4",
                    "api-timeout": 500.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "partyAccount"
                    ]
                },
                {
                    "api-name": "paymentMethods",
                    "api-id": "tmf-670",
                    "api-version": "v1",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "paymentMethod"
                    ]
                },
                {
                    "api-name": "productCatalogManagement",
                    "api-id": "tmf-620",
                    "api-version": "v4",
                    "api-timeout": 300.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "priceList",
                        "productSpecification",
                        "productOfferingPrice",
                        "category",
                        "catalog",
                        "productOffering",
                        "productLine"
                    ]
                },
                {
                    "api-name": "productOrderingManagement",
                    "api-id": "tmf-622",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "productOrder",
                        "cancelProductOrder"
                    ]
                },
                {
                    "api-name": "productInventory",
                    "api-id": "tmf-637",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "product"
                    ]
                },
                {
                    "api-name": "shoppingCart",
                    "api-id": "tmf-663",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "shoppingCart"
                    ]
                },
                {
                    "api-name": "bulk-api",
                    "api-id": "orcl-300",
                    "api-version": "v1",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "shoppingCart"
                    ]
                },
                {
                    "api-name": "recommendationManagement",
                    "api-id": "tmf-680",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "queryProductRecommendation"
                    ]
                },
                {
                    "api-name": "outbound",
                    "api-id": "orcl-301",
                    "api-version": "v1",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "configurations"
                    ]
                },
                {
                    "api-name": "alarmManagement",
                    "api-id": "tmf-642",
                    "api-version": "v2",
                    "api-timeout": 200.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "clearAlarms"
                    ]
                },
                {
                    "api-name": "federatedIdentity",
                    "api-id": "tmf-691",
                    "api-version": "v1",
                    "api-timeout": 400.0,
                    "url-prefix": "cx/industry/buying/tmf-api",
                    "api-resources": [
                        "userInfo"
                    ]
                }
            ]
        },
        "id": "buyingvp8zg",
        "system": "default",
        "domain": "default",
        "type": "external"
    },
    {
        "target-name": "Oct6_System",
        "external": {
            "offered-apis": [
                {
                    "api-name": "documentManagement",
                    "api-id": "tmf-667",
                    "api-version": "v2",
                    "api-timeout": 200.0,
                    "url-prefix": "",
                    "api-resources": [
                        "document"
                    ]
                },
                {
                    "api-name": "loyaltyManagement",
                    "api-id": "tmf-658",
                    "api-version": "v1",
                    "api-timeout": 200.0,
                    "url-prefix": "",
                    "api-resources": [
                        "loyaltyEvent"
                    ]
                }
            ]
        },
        "id": "oct6system2shhk",
        "system": "default",
        "domain": "default",
        "type": "external"
    },
    {
        "target-name": "SS1_Oct21",
        "external": {
            "offered-apis": [
                {
                    "api-name": "accountManagement",
                    "api-id": "tmf-666",
                    "api-version": "v4",
                    "api-timeout": 500.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "partyAccount"
                    ]
                }
            ]
        },
        "id": "ss1oct216tcmc",
        "system": "default",
        "domain": "default",
        "type": "external"
    },
    {
        "target-name": "SS1_Dec2",
        "external": {
            "offered-apis": [
                {
                    "api-name": "AiM",
                    "api-id": "tmf-915",
                    "api-version": "v4",
                    "api-timeout": 200.0,
                    "url-prefix": "brm",
                    "api-resources": [
                        "topic",
                        "alarm"
                    ]
                },
                .....
]