Jump to

• Request
• Response
• Examples

Replace a gatekeeping rule

put

/admin/gatekeepingRules/{id}

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• destination-selection: array destination-selection
• endpoint-name: string
• external-event-emitter-identification: string
• internal-event-emitter-ref: string
• listener-registration-refs: array listener-registration-refs
• rule-name: string

{
    "type":"object",
    "properties":{
        "endpoint-name":{
            "type":"string"
        },
        "rule-name":{
            "type":"string"
        },
        "external-event-emitter-identification":{
            "type":"string"
        },
        "listener-registration-refs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "internal-event-emitter-ref":{
            "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 : listener-registration-refs

Type: array

Show Source

• Array of: string

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : schema

Type: object

Show Source

• destination-selection: array destination-selection
• endpoint-name: string
• external-event-emitter-identification: string
• internal-event-emitter-ref: string
• listener-registration-refs: array listener-registration-refs
• rule-name: string

{
    "type":"object",
    "properties":{
        "endpoint-name":{
            "type":"string"
        },
        "rule-name":{
            "type":"string"
        },
        "external-event-emitter-identification":{
            "type":"string"
        },
        "listener-registration-refs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "internal-event-emitter-ref":{
            "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 : listener-registration-refs

Type: array

Show Source

• Array of: string

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

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

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

cURL Command

The following example shows how to replace a gatekeeping rule by submitting a PUT request on the REST resource using cURL.

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

Example of Request Body

The following shows an example of the request body.

{
    "endpoint-name": "tmf632",
    "rule-name": "Generated gatekeeping rule for endpoint tmf632",
    "gatekeeping-apis": [
        {
"api-id":"tmf-632",
            "api-name": "Party",
            "api-version": "v4",
            "api-resources": [
                {
                    "resource-name": "Individual",
                    "gatekeeping-criteria": {
                        "criteria": "(ID pr or /event/individual/familyName pr or /event/individual/id pr or /event/organization/tradingName pr or /event/organization/id pr or /tradingName pr or /familyName pr or (OP eq \"GET\" and not (ID pr)))",
                        "rank": 1
                    }
                },
                {
                    "resource-name": "Organization",
                    "gatekeeping-criteria": {
                        "criteria": "*",
                        "rank": 1
                    }
                }
            ]
        }
    ]
}

Example of Response Body

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

{
    "endpoint-name": "tmf632",
    "rule-name": "Generated gatekeeping rule for endpoint tmf632",
    "gatekeeping-apis": [
        {
            "api-id": "tmf-632",
            "api-name": "Party",
            "api-version": "v4",
            "api-resources": [
                {
                    "resource-name": "Individual",
                    "gatekeeping-criteria": {
                        "criteria": "(ID pr or /event/individual/familyName pr or /event/individual/id pr or /event/organization/tradingName pr or /event/organization/id pr or /tradingName pr or /familyName pr or (OP eq \"GET\" and not (ID pr)))",
                        "rank": 1
                    }
                },
                {
                    "resource-name": "Organization",
                    "gatekeeping-criteria": {
                        "criteria": "*",
                        "rank": 1
                    }
                }
            ]
        }
    ],
    "id": "gkr-wm55r"
}

Back to Top