Request naming API - PUT a request naming rule
Updates the specified request naming rule. If the rule with the specified ID doesn't exist—creates a new rule with this ID.
The request consumes and produces an application/json
payload.
PUT |
|
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The ID of the request naming to be updated. The ID of the request naming in the body of the request must match this ID. |
path | required |
body | RequestNaming |
The JSON body of the request containing updated parameters of the request naming. |
body | optional |
The RequestNaming object
The request naming rule.
Element | Type | Description | Required |
---|---|---|---|
metadata | ConfigurationMetadata |
Metadata useful for debugging. |
optional |
id | string |
The ID of the request naming rule. |
optional |
order | string |
The order string. Sorting request namings alphabetically by their order string determines their relative ordering. Typically this is managed by DESK internally and will not be present in GET responses nor used if present in PUT/POST requests, except where noted otherwise. |
optional |
enabled | boolean |
The rule is enabled ( |
required |
namingPattern | string |
The name to be assigned to matching requests. |
required |
conditions | Condition[] |
The set of conditions for the request naming rule usage. |
required |
placeholders | Placeholder[] |
The list of custom placeholders to be used in the naming pattern. It enables you to extract a request attribute value or other request attribute and use it in the request naming pattern. |
optional |
The Placeholder object
The custom placeholder to be used in the request rule naming pattern.
It enables you to extract a request attribute value or other request attribute and use it in the request naming pattern.
Element | Type | Description | Required |
---|---|---|---|
name | string |
The name of the placeholder. Use it in the naming pattern as |
required |
attribute | string |
The attribute to extract from. You can only use attributes of the string type. The attribute element can hold these values. |
required |
kind | string |
The type of extraction. Defines either usage of regular expression ( |
required |
delimiterOrRegex | string |
Depending on the type value:
|
required |
endDelimiter | string |
The closing delimiter string to look for. Required if the kind value is |
optional |
requestAttribute | string |
The request attribute to extract from. Required if the kind value is |
optional |
normalization | string |
The format of the extracted string. The normalization element can hold these values. |
optional |
The Condition object
The set of conditions for the request naming rule usage.
Element | Type | Description | Required |
---|---|---|---|
attribute | string |
The attribute to be matched. The attribute element can hold these values. |
required |
comparisonInfo | ComparisonInfo |
How to match the attribute. |
required |
The ComparisonInfo object
Type-specific comparison information for attributes. The actual set of fields depends on the type
of the comparison.
Element | Type | Description | Required |
---|---|---|---|
comparison | Enum |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | object |
The value to compare to. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
The Enum object
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description | Required |
---|---|---|---|
configurationVersions | integer[] |
A Sorted list of the version numbers of the configuration. |
optional |
clusterVersion | string |
DESK server version. |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"enabled": true,
"namingPattern": "renamed request",
"conditions": [
{
"attribute": "WEBREQUEST_URL_PATH",
"comparisonInfo": {
"type": "STRING",
"comparison": "BEGINS_WITH",
"value": "/url",
"negate": false,
"caseSensitive": false
}
}
]
}
Possible values
Possible values for the normalization element in the Placeholder object:
- ORIGINAL
- TO_LOWER_CASE
- TO_UPPER_CASE
Possible values for the kind element in the Placeholder object:
- AFTER_DELIMITER
- BEFORE_DELIMITER
- BETWEEN_DELIMITER
- REGEX_EXTRACTION
Possible values for the type element in the ComparisonInfo object:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the attribute element in the Condition object:
- AKKA_ACTOR_CLASS_NAME
- AKKA_ACTOR_MESSAGE_TYPE
- AKKA_ACTOR_PATH
- CICS_PROGRAM_NAME
- CICS_SYSTEM_ID
- CICS_TASK_ID
- CICS_TRANSACTION_ID
- CPU_TIME
- CTG_PROGRAM
- CTG_TRANSACTION_ID
- CUSTOMSERVICE_CLASS
- CUSTOMSERVICE_METHOD
- DATABASE_CHILD_CALL_COUNT
- DATABASE_CHILD_CALL_TIME
- ERROR_COUNT
- EXCEPTION_CLASS
- EXCEPTION_MESSAGE
- FAILED_STATE
- FAILURE_REASON
- FLAW_STATE
- HTTP_REQUEST_METHOD
- HTTP_STATUS
- HTTP_STATUS_CLASS
- IIB_APPLICATION_NAME
- IIB_INPUT_TYPE
- IIB_LIBRARY_NAME
- IIB_MESSAGE_FLOW_NAME
- IMS_PROGRAM_NAME
- IMS_TRANSACTION_ID
- IO_TIME
- LOCK_TIME
- MANAGEMENT_ZONE
- MESSAGING_DESTINATION_TYPE
- MESSAGING_IS_TEMPORARY_QUEUE
- MESSAGING_QUEUE_NAME
- MESSAGING_QUEUE_VENDOR
- NON_DATABASE_CHILD_CALL_COUNT
- NON_DATABASE_CHILD_CALL_TIME
- PROCESS_GROUP_TAG
- REMOTE_ENDPOINT
- REMOTE_METHOD
- REQUEST_NAME
- REQUEST_TYPE
- RESPONSE_TIME
- RESPONSE_TIME_CLIENT
- RMI_CLASS
- RMI_METHOD
- SERVICE_ID
- SERVICE_NAME
- SERVICE_PORT
- SERVICE_PUBLIC_DOMAIN_NAME
- SERVICE_REQUEST_ATTRIBUTE
- SERVICE_TAG
- SERVICE_WEB_APPLICATION_ID
- SERVICE_WEB_CONTEXT_ROOT
- SERVICE_WEB_SERVER_NAME
- SERVICE_WEB_SERVICE_NAME
- SERVICE_WEB_SERVICE_NAMESPACE
- SUSPENSION_TIME
- TOTAL_PROCESSING_TIME
- WAIT_TIME
- WEBREQUEST_QUERY
- WEBREQUEST_URL
- WEBREQUEST_URL_HOST
- WEBREQUEST_URL_PATH
- WEBREQUEST_URL_PORT
- WEBSERVICE_ENDPOINT
- WEBSERVICE_METHOD
- ZOS_CALL_TYPE
The StringComparisonInfo object
Type-specific comparison information for attributes of type 'STRING'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
caseSensitive | boolean |
Case sensitivity for string comparisons. |
optional |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the comparison element:
- BEGINS_WITH
- CONTAINS
- ENDS_WITH
- EQUALS
- EXISTS
- REGEX_MATCHES
The NumberComparisonInfo object
Type-specific comparison information for attributes of type 'NUMBER'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | Number |
The value to compare to. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
The Number object
Element | Type | Description | Required |
---|
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the comparison element:
- EQUALS
- EXISTS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- LOWER_THAN
- LOWER_THAN_OR_EQUAL
The BooleanComparisonInfo object
Type-specific comparison information for attributes of type 'BOOLEAN'. This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | boolean |
The value to compare to. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the comparison element:
- EQUALS
- EXISTS
The HttpMethodComparisonInfo object
Type-specific comparison information for attributes of type 'HTTP_METHOD'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. The value element can hold these values. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the value element:
- DELETE
- GET
- HEAD
- POST
- PUT
- TRACE
Possible values for the comparison element:
- EQUALS
- EXISTS
The NumberRequestAttributeComparisonInfo object
Type-specific comparison information for attributes of type 'NUMBER_REQUEST_ATTRIBUTE', specifically of generic type Number. This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | Number |
The value to compare to. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
requestAttribute | string | required |
The Number object
Element | Type | Description | Required |
---|
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the comparison element:
- EQUALS
- EXISTS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- LOWER_THAN
- LOWER_THAN_OR_EQUAL
The ZosComparisonInfo object
Type-specific comparison information for attributes of type 'ZOS_CALL_TYPE'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. The value element can hold these values. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the value element:
- CTG
- DPL
- EXPLICIT_ADK
- IMS_CONNECT
- IMS_CONNECT_API
- IMS_ITRA
- IMS_MSC
- IMS_PGM_SWITCH
- IMS_SHARED_QUEUES
- IMS_TRANS_EXEC
- MQ
- SOAP
- START
- TX
- UNKNOWN
Possible values for the comparison element:
- EQUALS
- EXISTS
The IIBInputNodeTypeComparisonInfo object
Type-specific comparison information for attributes of type 'IIB_INPUT_NODE_TYPE'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. The value element can hold these values. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the value element:
- CALLABLE_FLOW_ASYNC_RESPONSE_NODE
- CALLABLE_FLOW_INPUT_NODE
- DATABASE_INPUT_NODE
- DOTNET_INPUT_NODE
- EMAIL_INPUT_NODE
- EVENT_INPUT
- EVENT_INPUT_NODE
- FILE_INPUT_NODE
- FTE_INPUT_NODE
- HTTP_ASYNC_RESPONSE
- JD_EDWARDS_INPUT_NODE
- JMS_CLIENT_INPUT_NODE
- LABEL_NODE
- MQ_INPUT_NODE
- PEOPLE_SOFT_INPUT_NODE
- REST_ASYNC_RESPONSE
- REST_REQUEST
- SAP_INPUT_NODE
- SCA_ASYNC_RESPONSE_NODE
- SCA_INPUT_NODE
- SIEBEL_INPUT_NODE
- SOAP_INPUT_NODE
- TCPIP_CLIENT_INPUT_NODE
- TCPIP_CLIENT_REQUEST_NODE
- TCPIP_SERVER_INPUT_NODE
- TCPIP_SERVER_REQUEST_NODE
- TIMEOUT_NOTIFICATION_NODE
- WS_INPUT_NODE
Possible values for the comparison element:
- EQUALS
- EXISTS
The FailedStateComparisonInfo object
Type-specific comparison information for attributes of type 'FAILED_STATE'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. The value element can hold these values. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the value element:
- FAILED
- SUCCESSFUL
Possible values for the comparison element:
- EQUALS
- EXISTS
The FlawStateComparisonInfo object
Type-specific comparison information for attributes of type 'FLAW_STATE'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. The value element can hold these values. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the value element:
- FLAWED
- NOT_FLAWED
Possible values for the comparison element:
- EQUALS
- EXISTS
The EntityIdComparisonInfo object
Type-specific comparison information for attributes of type 'ENTITY_ID'.This model also inherits fields from the parent model ComparisonInfo.
Element | Type | Description | Required |
---|---|---|---|
comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
value | string |
The value to compare to. |
optional |
negate | boolean |
Reverse the comparison operator. For example it turns the begin with into does not begin with. |
required |
type | string |
Defines the actual set of fields depending on the value: STRING -> StringComparisonInfo NUMBER -> NumberComparisonInfo BOOLEAN -> BooleanComparisonInfo HTTP_METHOD -> HttpMethodComparisonInfo STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo ZOS_CALL_TYPE -> ZosComparisonInfo IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo TAG -> TagComparisonInfo MANAGEMENT_ZONE -> ManagementZoneComparisonInfo The type element can hold these values. |
required |
Possible values
Possible values for the type element:
- STRING
- NUMBER
- BOOLEAN
- HTTP_METHOD
- STRING_REQUEST_ATTRIBUTE
- NUMBER_REQUEST_ATTRIBUTE
- ZOS_CALL_TYPE
- IIB_INPUT_NODE_TYPE
- FAILED_STATE
- FLAW_STATE
- ENTITY_ID
- FAILURE_REASON
- HTTP_STATUS_CLASS
- TAG
- MANAGEMENT_ZONE
Possible values for the comparison element:
- EQUALS
- EXISTS
Response codes
Code | Description |
---|---|
201 | Success. Request naming rule has been created. Response contains the new request naming rule's ID and name. |
204 | Success. Request naming rule has been updated. Response doesn't have a body. |
400 | Failed. The input is invalid. |
Response format
The request returns the short representation of the updated or newly created rule.
The EntityShortRepresentation object
The short representation of a DESK entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the DESK entity. |
name | string | The name of the DESK entity. |
description | string | A short description of the DESK entity. |
{}
Validate payload
We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.
The request consumes an application/json
payload.
POST |
|
Response codes
Code | Description |
---|---|
204 | Validated. The submitted configuration is valid. Response does not have a body. |
400 | Failed. The input is invalid. |