Create Connector Rule

POST 
/connector-rules

Creates a new connector rule. A token with ORG_ADMIN authority is required to call this API.

Request

application/json

Body

required

The connector rule to create

name stringrequired

Possible values: non-empty and <= 128 characters

the name of the rule

description string

a description of the rule's purpose

type stringrequired

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[]

required

Array [

name stringrequired

the name of the argument

description string

the description of the argument

type stringnullable

the programmatic type of the argument

]

output

object

nullable

name stringrequired

the name of the argument

description string

the description of the argument

type stringnullable

the programmatic type of the argument

sourceCode

object

required

SourceCode

version stringrequired

the version of the code

script stringrequired

The code

attributes objectnullable

a map of string to objects

Responses

201

The created connector rule

application/json

Schema

Schema

name stringrequired

Possible values: non-empty and <= 128 characters

the name of the rule

description string

a description of the rule's purpose

type stringrequired

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[]

required

Array [

name stringrequired

the name of the argument

description string

the description of the argument

type stringnullable

the programmatic type of the argument

]

output

object

nullable

name stringrequired

the name of the argument

description string

the description of the argument

type stringnullable

the programmatic type of the argument

sourceCode

object

required

SourceCode

version stringrequired

the version of the code

script stringrequired

The code

attributes objectnullable

a map of string to objects

id stringrequired

the ID of the rule

created stringrequired

an ISO 8601 UTC timestamp when this rule was created

modified stringnullable

an ISO 8601 UTC timestamp when this rule was last modified

Example (from schema)

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

400

Client Error - Returned if the request body is invalid.

application/json

Schema

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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 string

Actual 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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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 string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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 string

Actual 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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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 string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

403

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

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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 string

Actual 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

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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 string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...