REST API for Oracle Digital Experience for Communications Industry Fabric

Update a gatekeeping rule annex

patch

/admin/gatekeepingRuleAnnexes/{id}

Request

Path Parameters

id(required): string

The id of the GatekeepingRuleAnnex to be updated

Supported Media Types

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.

Response

Supported Media Types

application/json

200 Response

Root Schema : GatekeepingRuleAnnexResponse

Type: object

Show Source

destination-selection(required): array destination-selection
gatekeepingrule-name(required): string
id: string

{
    "type":"object",
    "required":[
        "gatekeepingrule-name",
        "destination-selection"
    ],
    "properties":{
        "gatekeepingrule-name":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "destination-selection":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DestinationSelection"
            }
        }
    }
}

Nested Schema : destination-selection

Type: array

Show Source

Array of: object DestinationSelection

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

Nested Schema : DestinationSelection

Type: object

Show Source

api-id: string

Pattern: ^[a-z0-9]{1,8}-[0-9]{1,4}$
api-version: string
criteria: array criteria
description: string
include-in-sparse-query-results: object include-in-sparse-query-results

{
    "type":"object",
    "properties":{
        "api-id":{
            "type":"string",
            "nullable":false,
            "pattern":"^[a-z0-9]{1,8}-[0-9]{1,4}$"
        },
        "description":{
            "type":"string"
        },
        "api-version":{
            "type":"string",
            "nullable":false
        },
        "criteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GenericRoutingCriteria"
            }
        },
        "include-in-sparse-query-results":{
            "type":"object",
            "properties":{
                "enabled":{
                    "type":"boolean"
                },
                "by-criterion":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : criteria

Type: array

Show Source

Array of: object GenericRoutingCriteria

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

Nested Schema : include-in-sparse-query-results

Type: object

Show Source

by-criterion: string
enabled: boolean

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "by-criterion":{
            "type":"string"
        }
    }
}

Nested Schema : GenericRoutingCriteria

Type: object

Show Source

criteria-link: string
rank: integer
resource-ids: array resource-ids

{
    "type":"object",
    "properties":{
        "resource-ids":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "criteria-link":{
            "type":"string"
        },
        "rank":{
            "type":"integer"
        }
    }
}

Nested Schema : resource-ids

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "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."
        }
    }
}

409 Response

Conflict

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 update a gatekeeping rule annex by submitting a post request on the REST resource using cURL.

cURL Command

curl --<username:password> --request PATCH '{FABRIC_HOST}/admin/gatekeepingRuleAnnexes/{id}' --header 'Authorization: Bearer <accessToken> --header 'Content-Type: application/json'

Example of Request Body

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

[
{
    "op": "replace",
    "path": "/destination-selection/0/criteria/0/rank",
    "value": "21"
  }
]

Example of Response Body

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

{
    "gatekeepingrule-name": "gkr-external-rest-buying",
    "destination-selection": [
        {
            "api-id": "tmf-671",
            "api-version": "v4",
            "criteria": [
                {
                    "rank": 21,
                    "resource-ids": [
                        "promotion"
                    ],
                    "criterion-link": "WILDCARD"
                }
            ],
            "include-in-sparse-query-results": {
                "enabled": true
            }
        }
    ],
    "id": "gkr-external-rest-buying-annex-gragsw66"
}