Get a gatekeeping rule.
get
/admin/gatekeepingRules/{id}
Retrieves the gatekeeping rule identified by the path parameter.
Request
Path Parameters
-
id(required): string
The ID of the GatekeepingRule.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : GatekeepingRules
Type:
arrayContains a collection of gatekeeping rules.
Show Source
-
Array of:
object GatekeepingRule
Defines a gatekeeping rule used to evaluate and route requests.
Nested Schema : GatekeepingRule
Type:
objectDefines a gatekeeping rule used to evaluate and route requests.
Show Source
Nested Schema : DestinationSelection
Type:
Show Source
object-
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
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed 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.
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed 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.
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed 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.
404 Response
Not Found
Root Schema : Error
Type:
objectUsed 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.
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed 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.
Examples
The following example shows how to get a gatekeeping rule by submitting a GET request on the REST resource using cURL
curl -H 'Authorization: Bearer <Token>' -X GET
https://{FABRIC_HOST}/admin/gatekeepingRules/{id} -H
"Content-Type: application/json" | json_pp
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"
}