Connector-Rule by ID
Returns the connector rule specified by ID. A token with ORG_ADMIN authority is required to call this API.
Path Parameters
- id string required
ID of the connector rule to retrieve
- 200
- 403
- 404
Connector rule with the given ID
- application/json
- Schema
- Example (from schema)
Schema
- name string
Possible values:
non-empty
and<= 128 characters
the name of the rule
- description string
a description of the rule's purpose
- type string
Possible values: [
BuildMap
,ConnectorAfterCreate
,ConnectorAfterDelete
,ConnectorAfterModify
,ConnectorBeforeCreate
,ConnectorBeforeDelete
,ConnectorBeforeModify
,JDBCBuildMap
,JDBCOperationProvisioning
,JDBCProvision
,PeopleSoftHRMSBuildMap
,PeopleSoftHRMSOperationProvisioning
,PeopleSoftHRMSProvision
,RACFPermissionCustomization
,SAPBuildMap
,SapHrManagerRule
,SapHrOperationProvisioning
,SapHrProvision
,SuccessFactorsOperationProvisioning
,WebServiceAfterOperationRule
,WebServiceBeforeOperationRule
]the type of rule
signature object
The rule's function signature. Describes the rule's input arguments and output (if any)
input object[]
name stringthe name of the argument
description stringthe description of the argument
type stringthe programmatic type of the argument
output object
name stringthe name of the argument
description stringthe description of the argument
type stringthe programmatic type of the argument
sourceCode object
SourceCode
version stringthe version of the code
script stringThe code
- attributes object
a map of string to objects
- id string
the ID of the rule
- created string
an ISO 8601 UTC timestamp when this rule was created
- modified string
an ISO 8601 UTC timestamp when this rule was last modified
{
"name": "WebServiceBeforeOperationRule",
"description": "This rule does that",
"type": "BuildMap",
"signature": {
"input": [
{
"name": "firstName",
"description": "the first name of the identity",
"type": "String"
}
],
"output": {
"name": "firstName",
"description": "the first name of the identity",
"type": "String"
}
},
"sourceCode": {
"version": "1.0",
"script": "return \"Mr. \" + firstName;"
},
"attributes": {},
"id": "8113d48c0b914f17b4c6072d4dcb9dfe",
"created": "021-07-22T15:59:23Z",
"modified": "021-07-22T15:59:23Z"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Not Found - returned if the request URL refers to a resource or object that does not exist
- application/json
- Schema
- Example (from schema)
- 404
Schema
- detailCode string
Fine-grained error code providing more detail of the error.
- trackingId string
Unique tracking id for the error.
messages object[]
Generic localized reason for error
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
locale stringThe locale for the message text, a BCP 47 language tag.
localeOrigin stringPossible values: [
DEFAULT
,REQUEST
]An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
text stringActual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 404 response object
{
"detailCode": "404 Not found",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server did not find a current representation for the target resource."
}
]
}