Jump to

• Request
• Response

List the CapabilitiesManifest

get

https://serverRoot/cartridgeAssembler/v1/capabilitiesManifest

This operation lists the loaded CapabilitiesManifests.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Security

• ocaClientCredentials: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The operation is successful.

Body ()

Root Schema : CapabilitiesManifest

Type: object

Show Source

• component(required): object component
• fulfillmentMode: object Entity
  Base entity schema for use in TMForum Open-APIs.
• fulfillmentPattern(required): array fulfillmentPattern
• identification(required): object identification
• openAPIRef(required): object Entity
  Base entity schema for use in TMForum Open-APIs.
• orderComponents(required): object OrderComponents
• orderItemSpecification(required): object OrderItemSpecification
• orderTransformation(required): object OrderTransformation
• parameterBindingURI(required): string
• tmf(required): boolean

{
    "type":"object",
    "properties":{
        "identification":{
            "$ref":"#/components/schemas/identification",
            "type":"string"
        },
        "component":{
            "$ref":"#/components/schemas/component"
        },
        "tmf":{
            "type":"boolean"
        },
        "openAPIRef":{
            "$ref":"#/components/schemas/Entity"
        },
        "orderItemSpecification":{
            "$ref":"#/components/schemas/OrderItemSpecification"
        },
        "parameterBindingURI":{
            "type":"string"
        },
        "orderComponents":{
            "$ref":"#/components/schemas/OrderComponents"
        },
        "fulfillmentMode":{
            "$ref":"#/components/schemas/Entity"
        },
        "orderTransformation":{
            "$ref":"#/components/schemas/OrderTransformation"
        },
        "fulfillmentPattern":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FulfillmentPattern"
            }
        }
    },
    "required":[
        "component",
        "identification",
        "fulfillmentPattern",
        "openAPIRef",
        "orderComponents",
        "orderItemSpecification",
        "orderTransformation",
        "parameterBindingURI",
        "tmf"
    ]
}

Nested Schema : component

Type: object

Show Source

• location: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    },
    "required":[
        "Location",
        "Type"
    ]
}

Nested Schema : Entity

Type: object

Base entity schema for use in TMForum Open-APIs.

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 Extensible name.
• href: string (uri)
  Hyperlink reference.
• id: string
  Unique identifier.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier."
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference.",
            "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 Extensible name."
        }
    },
    "description":"Base entity schema for use in TMForum Open-APIs."
}

Nested Schema : fulfillmentPattern

Type: array

Show Source

• Array of: object FulfillmentPattern

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

Nested Schema : identification

Type: object

Show Source

• buildID(required): integer
• name(required): string
• type(required): string
• version(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "buildID":{
            "type":"integer"
        }
    },
    "required":[
        "buildID",
        "name",
        "type",
        "version"
    ]
}

Nested Schema : OrderComponents

Type: object

Show Source

• function(required): array function
• granularity(required): array granularity
• system(required): array system

{
    "type":"object",
    "properties":{
        "function":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Function"
            }
        },
        "system":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Systems"
            }
        },
        "granularity":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Granularity"
            }
        }
    },
    "required":[
        "function",
        "system",
        "granularity"
    ]
}

Nested Schema : OrderItemSpecification

Type: object

Show Source

• name(required): string
• namespace(required): string
• property(required): array property
• propertyReferences(required): object PropertyReferences

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "propertyReferences":{
            "$ref":"#/components/schemas/PropertyReferences"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OrderItemProperty"
            }
        }
    },
    "required":[
        "name",
        "namespace",
        "property",
        "propertyReferences"
    ]
}

Nested Schema : OrderTransformation

Type: object

Show Source

• actionCode(required): array actionCode
• externalFulfillmentState(required): array externalFulfillmentState
• orderItemSpecification(required): object OrderItemSpecification
• providerFunction(required): object Entity
  Base entity schema for use in TMForum Open-APIs.
• psrModelNamespace(required): string
• relationshipType(required): array relationshipType
• transformationSequence(required): object Entity
  Base entity schema for use in TMForum Open-APIs.

{
    "type":"object",
    "properties":{
        "orderItemSpecification":{
            "$ref":"#/components/schemas/OrderItemSpecification"
        },
        "transformationSequence":{
            "$ref":"#/components/schemas/Entity"
        },
        "providerFunction":{
            "$ref":"#/components/schemas/Entity"
        },
        "psrModelNamespace":{
            "type":"string"
        },
        "relationshipType":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Entity"
            }
        },
        "externalFulfillmentState":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExternalFulfillmentState"
            }
        },
        "actionCode":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "actionCode",
        "externalFulfillmentState",
        "orderItemSpecification",
        "providerFunction",
        "psrModelNamespace",
        "relationshipType",
        "transformationSequence"
    ]
}

Nested Schema : FulfillmentPattern

Type: object

Show Source

• component: array component
• description: string
• fulfillmentMode(required): object Entity
  Base entity schema for use in TMForum Open-APIs.
• id(required): string
• name(required): string
• namespace(required): string
• transition: array transition

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "fulfillmentMode":{
            "$ref":"#/components/schemas/Entity"
        },
        "component":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComponentElement"
            }
        },
        "transition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Transition"
            }
        }
    },
    "required":[
        "fulfillmentMode",
        "id",
        "name",
        "namespace"
    ]
}

Nested Schema : component

Type: array

Show Source

• Array of: object ComponentElement

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

Nested Schema : transition

Type: array

Show Source

• Array of: object Transition

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

Nested Schema : ComponentElement

Type: object

Show Source

• condition(required): array condition
• orderComponent(required): object Entity
  Base entity schema for use in TMForum Open-APIs.

{
    "type":"object",
    "properties":{
        "orderComponent":{
            "$ref":"#/components/schemas/Entity"
        },
        "condition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Condition"
            }
        }
    },
    "required":[
        "condition",
        "orderComponent"
    ]
}

Nested Schema : condition

Type: array

Show Source

• Array of: object Condition

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

Nested Schema : Condition

Type: object

Show Source

• fileUri(required): string
• inlineFileUri: string
• name(required): string
• type(required): string
• xquery: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "fileUri":{
            "type":"string"
        },
        "xquery":{
            "type":"string"
        },
        "inlineFileUri":{
            "type":"string"
        }
    },
    "required":[
        "fileUri",
        "name",
        "type"
    ]
}

Nested Schema : Transition

Type: object

Show Source

• from(required): object From
• name(required): string
• to(required): object To

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "from":{
            "$ref":"#/components/schemas/From"
        },
        "to":{
            "$ref":"#/components/schemas/To"
        }
    },
    "required":[
        "from",
        "name",
        "to"
    ]
}

Nested Schema : From

Type: object

Show Source

• component(required): object Entity
  Base entity schema for use in TMForum Open-APIs.
• fulfillmentPattern: object Entity
  Base entity schema for use in TMForum Open-APIs.

{
    "type":"object",
    "properties":{
        "component":{
            "$ref":"#/components/schemas/Entity"
        },
        "fulfillmentPattern":{
            "$ref":"#/components/schemas/Entity"
        }
    },
    "required":[
        "component"
    ]
}

Nested Schema : To

Type: object

Show Source

• component(required): object Entity
  Base entity schema for use in TMForum Open-APIs.

{
    "type":"object",
    "properties":{
        "component":{
            "$ref":"#/components/schemas/Entity"
        }
    },
    "required":[
        "component"
    ]
}

Nested Schema : function

Type: array

Show Source

• Array of: object Function

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

Nested Schema : granularity

Type: array

Show Source

• Array of: object Granularity

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

Nested Schema : system

Type: array

Show Source

• Array of: object Systems

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

Nested Schema : Function

Type: object

Show Source

• description: string
• name(required): string
• namespace(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    },
    "required":[
        "name",
        "namespace"
    ]
}

Nested Schema : Granularity

Type: object

Show Source

• description: string
• name(required): string
• namespace(required): string
• uxLabel(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "uxLabel":{
            "type":"string"
        }
    },
    "required":[
        "name",
        "namespace",
        "uxLabel"
    ]
}

Nested Schema : Systems

Type: object

Show Source

• description: string
• functionRef(required): object Entity
  Base entity schema for use in TMForum Open-APIs.
• name(required): string
• namespace(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "functionRef":{
            "$ref":"#/components/schemas/Entity"
        }
    },
    "required":[
        "name",
        "namespace",
        "functionRef"
    ]
}

Nested Schema : property

Type: array

Show Source

• Array of: object OrderItemProperty

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

Nested Schema : PropertyReferences

Type: object

Show Source

• dynamicParameterProperty(required): string
• fulfillmenPatternMappingProperty(required): string
• orderItemActionProperty(required): string
• orderItemIdProperty(required): string
• orderItemNameProperty(required): string
• orderItemRecognitionProperty(required): string
• requestedDeliveryDateProperty(required): string

{
    "type":"object",
    "properties":{
        "fulfillmenPatternMappingProperty":{
            "type":"string"
        },
        "orderItemNameProperty":{
            "type":"string"
        },
        "requestedDeliveryDateProperty":{
            "type":"string"
        },
        "orderItemRecognitionProperty":{
            "type":"string"
        },
        "orderItemActionProperty":{
            "type":"string"
        },
        "orderItemIdProperty":{
            "type":"string"
        },
        "dynamicParameterProperty":{
            "type":"string"
        }
    },
    "required":[
        "dynamicParameterProperty",
        "fulfillmenPatternMappingProperty",
        "orderItemActionProperty",
        "orderItemIdProperty",
        "orderItemNameProperty",
        "orderItemRecognitionProperty",
        "requestedDeliveryDateProperty"
    ]
}

Nested Schema : OrderItemProperty

Type: object

Show Source

• dataType(required): string
  Allowed Values: [ "string", "boolean", "int", "long" ]
• name(required): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "dataType":{
            "type":"string",
            "enum":[
                "string",
                "boolean",
                "int",
                "long"
            ]
        }
    },
    "required":[
        "name",
        "dataType"
    ]
}

Nested Schema : actionCode

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : externalFulfillmentState

Type: array

Show Source

• Array of: object ExternalFulfillmentState

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

Nested Schema : relationshipType

Type: array

Show Source

• Array of: object Entity
  Base entity schema for use in TMForum Open-APIs.

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

Nested Schema : ExternalFulfillmentState

Type: object

Show Source

• name(required): string
• orderComponent(required): object Entity
  Base entity schema for use in TMForum Open-APIs.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "orderComponent":{
            "$ref":"#/components/schemas/Entity"
        }
    },
    "required":[
        "name",
        "orderComponent"
    ]
}

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. Typically, with an 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
  Possible list of error codes returned as part of ProductOrder API response.
• message: string
  More details and corrective actions related to the error that can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error that 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",
    "properties":{
        "code":{
            "type":"string",
            "description":"Possible list of error codes returned as part of ProductOrder API response."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error that 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."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. Typically, with an 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
  Possible list of error codes returned as part of ProductOrder API response.
• message: string
  More details and corrective actions related to the error that can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error that 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",
    "properties":{
        "code":{
            "type":"string",
            "description":"Possible list of error codes returned as part of ProductOrder API response."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error that 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."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. Typically, with an 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
  Possible list of error codes returned as part of ProductOrder API response.
• message: string
  More details and corrective actions related to the error that can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error that 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",
    "properties":{
        "code":{
            "type":"string",
            "description":"Possible list of error codes returned as part of ProductOrder API response."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error that 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."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. Typically, with an 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
  Possible list of error codes returned as part of ProductOrder API response.
• message: string
  More details and corrective actions related to the error that can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error that 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",
    "properties":{
        "code":{
            "type":"string",
            "description":"Possible list of error codes returned as part of ProductOrder API response."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error that 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."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used when an API throws an error. Typically, with an 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
  Possible list of error codes returned as part of ProductOrder API response.
• message: string
  More details and corrective actions related to the error that can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error that 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",
    "properties":{
        "code":{
            "type":"string",
            "description":"Possible list of error codes returned as part of ProductOrder API response."
        },
        "reason":{
            "type":"string",
            "description":"Explanation of the reason for the error that can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error that 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."
        }
    },
    "description":"Used when an API throws an error. Typically, with an HTTP error response-code (3xx, 4xx, 5xx)."
}

Back to Top