Jump to

• Request
• Response
• Examples

Update an API

patch

/admin/apis/{id}

Request

Path Parameters

• id(required): string
  The id of the API to be updated

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: object PatchDocument
  A JSONPatch document as defined by RFC 6902

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

Nested Schema : PatchDocument

Type: object

A JSONPatch document as defined by RFC 6902

Show Source

• from: string
  A string containing a JSON Pointer value.
• op(required): string
  Allowed Values: [ "add", "remove", "replace", "move", "copy", "test" ]

  The operation to be performed
• path(required): string
  A JSON-Pointer
• value: object value
  The value to be used within the operations.

{
    "description":"A JSONPatch document as defined by RFC 6902",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "description":"The operation to be performed",
            "enum":[
                "add",
                "remove",
                "replace",
                "move",
                "copy",
                "test"
            ]
        },
        "path":{
            "type":"string",
            "description":"A JSON-Pointer"
        },
        "value":{
            "type":"object",
            "description":"The value to be used within the operations."
        },
        "from":{
            "type":"string",
            "description":"A string containing a JSON Pointer value."
        }
    }
}

Nested Schema : value

Type: object

The value to be used within the operations.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: object

Show Source

• alternative-root-path: string
• api-events: array api-events
• api-id: string
• api-name: string
• api-resources: array api-resources
• api-version: string
• callback-registration-path: string
• id: string
• openapi-document-url: string

{
    "type":"object",
    "properties":{
        "api-name":{
            "type":"string"
        },
        "api-id":{
            "type":"string"
        },
        "api-version":{
            "type":"string"
        },
        "api-resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Api-generic-resource"
            }
        },
        "api-events":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Api-event"
            }
        },
        "alternative-root-path":{
            "type":"string"
        },
        "callback-registration-path":{
            "type":"string"
        },
        "openapi-document-url":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : api-events

Type: array

Show Source

• Array of: object Api-event

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

Nested Schema : api-resources

Type: array

Show Source

• Array of: object Api-generic-resource

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

Nested Schema : Api-event

Type: object

Show Source

• api-resource: string
• name: string

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

Nested Schema : Api-generic-resource

Type: object

Show Source

• cors-preflight-handling: string
  Allowed Values: [ "fabric", "routing-target" ]
• http-methods: array http-methods
• interaction-context-enrichment-specification: string
• name: string
• path-parameters: array path-parameters
• resource-id: string
• resource-path: string
• routing-ambiguity-resolution-strategy: string
  Allowed Values: [ "HTTP400BadRequest", "HTTP300MultipleChoices", "QueryHighestPriority", "QueryAllFirstMatch", "QueryAllRankedMatch", "QueryAllConflictFail" ]

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

Nested Schema : http-methods

Type: array

Show Source

• Array of: object Api-http-method

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

Nested Schema : path-parameters

Type: array

Show Source

• Array of: object Api-path-parameter

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

Nested Schema : Api-http-method

Type: object

Show Source

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

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

Nested Schema : multi-record-methods

Type: array

Show Source

• Array of: object Http-method

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

Nested Schema : single-record-methods

Type: array

Show Source

• Array of: object Http-method

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

Nested Schema : Http-method

Type: object

Show Source

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

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

Nested Schema : Api-path-parameter

Type: object

Show Source

• description: string
• is-record-id: boolean
• parameter-name: string
• parameter-type: string
  Allowed Values: [ "string", "number", "none" ]

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

400 Response

Bad Request

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

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

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

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

403 Response

Forbidden

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

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

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

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

409 Response

Conflict

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

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

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

Show Source

• @baseType: string
  When sub-classing, this defines the super-class.
• @schemaLocation: string (uri)
  A URI to a JSON-Schema file that defines additional attributes and relationships
• @type: string
  When sub-classing, this defines the sub-class entity name.
• code(required): string
  Application relevant detail, defined in the API or a common list.
• message: string
  More details and corrective actions related to the error which can be shown to a client user.
• reason(required): string
  Explanation of the reason for the error which can be shown to a client user.
• referenceError: string (uri)
  URI of documentation describing the error.
• status: string
  HTTP Error code extension

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

Back to Top

Examples

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

cURL Command

curl -H 'Authorization: Bearer <Token>' -X PATCH https://{FABRIC_HOST}/admin/apis/{id} -H "Content-Type: application/json" -D @update_adminapi.json| json_pp

Example of Request Body

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

[
  {
    "op": "replace",
    "path": "/alternative-root-path",
    "value": "contacts"
  }
]

Example of Response Body

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

{
    "api-name": "fa-api-contacts",
    "api-id": "fa-101",
    "api-version": "v1",
    "api-resources": [
        {
            "resource-id": "contacts",
            "name": "contacts",
            "resource-path": "{party-number}",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": true
                }
            ],
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_SourceSystemRef",
            "name": "contacts_SourceSystemRef",
            "resource-path": "{party-number}/child/SourceSystemReference",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_ContactPoint",
            "name": "contacts_ContactPoint",
            "resource-path": "{party-number}/child/ContactPoint",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_SourceSystemRef_Id",
            "name": "contacts_SourceSystemRef_Id",
            "resource-path": "{party-number}/child/SourceSystemReference/{sourcesystem-refid}",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                },
                {
                    "parameter-name": "sourcesystem-refid",
                    "parameter-type": "string",
                    "is-record-id": false
                }
            ],
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        },
        {
            "resource-id": "contacts_ContactPoint_Id",
            "name": "contacts_ContactPoint_Id",
            "resource-path": "{party-number}/child/ContactPoint/{contactpoint-id}",
            "path-parameters": [
                {
                    "parameter-name": "party-number",
                    "parameter-type": "string",
                    "is-record-id": false
                },
                {
                    "parameter-name": "contactpoint-id",
                    "parameter-type": "string",
                    "is-record-id": true
                }
            ],
            "cors-preflight-handling": "fabric",
            "routing-ambiguity-resolution-strategy": "HTTP400BadRequest"
        }
    ],
    "alternative-root-path": "contacts",
    "api-events": [],
    "openapi-document-url": "https://do-nothing",
    "id": "fa-api-contactst4dd9",
    "type": "custom"
}

Back to Top