Jump to

• Request
• Response

Update a Webhook

put

/system/api/v1/webhooks/{id}

with the given payload. User should have Admin role to update Webhook. User should have access to the Webhook for updating it. User should have manager access to any of the configured objectsfor updating Webhook.

CSRF token header (X-CSRF-TOKEN) is needed for updating Webhooks. Token can be obtained from token REST service.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer(int64)
  id of the Webhook.

Body ()

Webhook Object

Root Schema : Webhook

Type: object

Webhook Configuration Data

Show Source

• category(optional): string
  Category of the webhook. List of supported categories are
  ASSET_PUBLISHING
  ASSET_LIFECYCLE

  Example: Asset Lifecycle
• createdAt(optional): string
  Date and time at which the webhook was created. Date and time values are in ISO 8601 format with UTC timezone.
• createdBy(optional): object User
  User Metadata Model.
• description(optional): string
  Description of the V1WebhookRestInfo.

  Example: foo description
• enabled(optional): boolean
  Flag to turn on/off a webhook. If the webhook is not enabled, Target URL will not be invoked when the event happens
• eventDetails(optional): array eventDetails
  Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required
• id(optional): integer(int64)
  Unique id of the webhook.It is a required property to read, update and delete a webhook.

  Example: 2367
• links(optional): array links
  Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
• name(optional): string
  Name of the webhook.

  Example: foo
• payload(optional): object Payload
  Payload configuration for the Webhook. Supported pay load names are:
  empty
  brief
  detailed
• target(optional): object Target
  Target end point details for the Webhook.
• updatedAt(optional): string
  Date and time at which the webhook was updated. Date and time values are in ISO 8601 format with UTC timezone.
• updatedBy(optional): object User
  User Metadata Model.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "example":2367,
            "description":"Unique id of the webhook.It is a required property to read, update and delete a webhook."
        },
        "name":{
            "type":"string",
            "example":"foo",
            "description":"Name of the webhook."
        },
        "description":{
            "type":"string",
            "example":"foo description",
            "description":"Description of the V1WebhookRestInfo."
        },
        "createdBy":{
            "description":"User who created the webhook.",
            "$ref":"#/definitions/User"
        },
        "createdAt":{
            "type":"string",
            "description":"Date and time at which the webhook was created. Date and time values are in ISO 8601 format with UTC timezone."
        },
        "updatedAt":{
            "type":"string",
            "description":"Date and time at which the webhook was updated. Date and time values are in ISO 8601 format with UTC timezone."
        },
        "updatedBy":{
            "description":"User who updated the webhook.",
            "$ref":"#/definitions/User"
        },
        "category":{
            "type":"string",
            "example":"Asset Lifecycle",
            "description":"Category of the webhook. List of supported categories are <br>ASSET_PUBLISHING<br>ASSET_LIFECYCLE"
        },
        "enabled":{
            "type":"boolean",
            "description":"Flag to turn on/off a webhook. If the webhook is not enabled, Target URL will not be invoked when the event happens"
        },
        "eventDetails":{
            "type":"array",
            "description":"Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required",
            "items":{
                "$ref":"#/definitions/Webhook Events"
            }
        },
        "payload":{
            "example":"id:brief",
            "description":"This property is used to configure the payload that system send to the webhook.Default is brief",
            "$ref":"#/definitions/Payload"
        },
        "target":{
            "description":"Details about the webhook end point. This is a required property",
            "$ref":"#/definitions/Target"
        },
        "links":{
            "type":"array",
            "description":"Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Webhook Configuration Data"
}

Nested Schema : User

Type: object

User Metadata Model.

Show Source

• displayName(optional): string
  The display name of the user.

  Example: My Display Name
• id(optional): string
  The id of the user.

  Example: 10002
• name(optional): string
  The name of the user.

  Example: [e-mail]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "example":"10002",
            "description":"The id of the user."
        },
        "name":{
            "type":"string",
            "example":"[e-mail]",
            "description":"The name of the user."
        },
        "displayName":{
            "type":"string",
            "example":"My Display Name",
            "description":"The display name of the user."
        }
    },
    "description":"User Metadata Model."
}

Nested Schema : eventDetails

Type: array

Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required

Show Source

• Array of: object Webhook Events
  Event details for Webhook.

{
    "type":"array",
    "description":"Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required",
    "items":{
        "$ref":"#/definitions/Webhook Events"
    }
}

Nested Schema : links

Type: array

Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: object Link
  REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "type":"array",
    "description":"Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Payload

Type: object

Payload configuration for the Webhook. Supported pay load names are:
empty
brief
detailed

Show Source

• name(optional): string
  Name for the payload. Brief is the default value for webhook is payload is not set

  Example: brief

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"brief",
            "description":"Name for the payload. Brief is the default value for webhook is payload is not set"
        }
    },
    "description":"Payload configuration for the Webhook. Supported pay load names are: <br>empty<br>brief<br>detailed "
}

Nested Schema : Target

Type: object

Target end point details for the Webhook.

Show Source

• security(optional): object Security
  Security configuration for the Webhook target end point.
• url(optional): string
  URL of the webhook end point

  Example: http://www.myserver.com/foo

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "example":"http://www.myserver.com/foo",
            "description":"URL of the webhook end point"
        },
        "security":{
            "example":" \"basicAuth\": {\n        \"username\": \"string\",\n        \"password\": \"string\",\n        \"realm\": \"string\"\n      },",
            "description":"Security details for the webhook. Security can be Basic Auth or Header based",
            "$ref":"#/definitions/Security"
        }
    },
    "description":"Target end point details for the Webhook."
}

Nested Schema : Webhook Events

Type: object

Event details for Webhook.

Show Source

• eventNames(optional): array eventNames
  List of events. Event names can be retrieved from /events/types?expand=all end point
• filter(optional): object Filter

{
    "type":"object",
    "properties":{
        "eventNames":{
            "type":"array",
            "example":"contentitem_created,contentitem_published,digitalasset_created",
            "description":"List of events. Event names can be retrieved from /events/types?expand=all end point",
            "items":{
                "type":"string"
            }
        },
        "filter":{
            "description":"List of sources that triggers this event. It can be list of repositories or channels",
            "$ref":"#/definitions/Filter"
        }
    },
    "description":"Event details for Webhook."
}

Nested Schema : eventNames

Type: array

List of events. Event names can be retrieved from /events/types?expand=all end point

Show Source

• Array of: string

{
    "type":"array",
    "example":"contentitem_created,contentitem_published,digitalasset_created",
    "description":"List of events. Event names can be retrieved from /events/types?expand=all end point",
    "items":{
        "type":"string"
    }
}

Example:

contentitem_created,contentitem_published,digitalasset_created

Nested Schema : Filter

Type: object

Show Source

• objectIds(optional): array objectIds
  List of ids of the objectType.
• objectType(optional): string
  Filter objectType name. It can be repository or channel.

  Example: repository

{
    "type":"object",
    "properties":{
        "objectType":{
            "type":"string",
            "example":"repository",
            "description":"Filter objectType name. It can be repository or channel."
        },
        "objectIds":{
            "type":"array",
            "example":"{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}",
            "description":"List of ids of the objectType.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : objectIds

Type: array

List of ids of the objectType.

Show Source

• Array of: string

{
    "type":"array",
    "example":"{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}",
    "description":"List of ids of the objectType.",
    "items":{
        "type":"string"
    }
}

Example:

{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}

Nested Schema : Link

Type: object

REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string
  The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`.
• mediaType(optional): string
  Link target. Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  Link target HTTP method. HTTP method for requesting the target of the link. * `none` - Indicates no valid HTTP method * `OPTIONS` - HTTP OPTIONS * `HEAD` - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
• profile(optional): string
  Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
• rel(optional): string
  Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details.
• templated(optional): boolean
  Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details."
        },
        "href":{
            "type":"string",
            "description":"The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`."
        },
        "templated":{
            "type":"boolean",
            "description":"Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present."
        },
        "mediaType":{
            "type":"string",
            "description":"Link target. Media type, as defined by RFC 2046, describing the link target."
        },
        "method":{
            "type":"string",
            "description":"Link target HTTP method. HTTP method for requesting the target of the link.  *  `none` - Indicates no valid HTTP method *  `OPTIONS` - HTTP OPTIONS *  `HEAD` - HTTP HEAD *  `GET` - HTTP GET *  `POST` - HTTP POST *  `PUT` - HTTP PUT *  `PATCH` - HTTP PATCH *  `DELETE` - HTTP DELETE"
        },
        "profile":{
            "type":"string",
            "description":"Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource."
        }
    },
    "description":"REST link and related meta data.  If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure."
}

Nested Schema : Security

Type: object

Security configuration for the Webhook target end point.

Show Source

• basicAuth(optional): object BasicAuth
  Basic authentication configuration details. The details will be sent in Authorization header
• headerAuth(optional): object Headers
  Header based authorization configuration details.
• signatureSecurity(optional): object SignatureSecurity
  Signature based security configuration details.

{
    "type":"object",
    "properties":{
        "basicAuth":{
            "description":"Basic authentication configuration.",
            "$ref":"#/definitions/BasicAuth"
        },
        "headerAuth":{
            "description":"Header based authorization configuration.",
            "$ref":"#/definitions/Headers"
        },
        "signatureSecurity":{
            "description":"Signature based security configuration.",
            "$ref":"#/definitions/SignatureSecurity"
        }
    },
    "description":"Security configuration for the Webhook target end point."
}

Nested Schema : BasicAuth

Type: object

Basic authentication configuration details. The details will be sent in Authorization header

Show Source

• password(optional): string
  password for basic authentication
• realm(optional): string
  realm for basic authentication
• username(optional): string
  username for basic authentication

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string",
            "description":"username for basic authentication"
        },
        "password":{
            "type":"string",
            "description":"password for basic authentication"
        },
        "realm":{
            "type":"string",
            "description":"realm for basic authentication"
        }
    },
    "description":"Basic authentication configuration details. The details will be sent in Authorization header"
}

Nested Schema : Headers

Type: object

Header based authorization configuration details.

Show Source

• headers(optional): array headers
  List of headers.

{
    "type":"object",
    "properties":{
        "headers":{
            "type":"array",
            "description":"List of headers.",
            "items":{
                "$ref":"#/definitions/Request Header"
            }
        }
    },
    "description":"Header based authorization configuration details."
}

Nested Schema : SignatureSecurity

Type: object

Signature based security configuration details.

Show Source

• signatureToken(optional): string
  Signature Token should be lowercase alphanumeric [a-z, 0-9] string of length 32.

{
    "type":"object",
    "properties":{
        "signatureToken":{
            "type":"string",
            "description":"Signature Token should be lowercase alphanumeric [a-z, 0-9] string of length 32."
        }
    },
    "description":"Signature based security configuration details."
}

Nested Schema : headers

Type: array

List of headers.

Show Source

• Array of: object Request Header
  Request Header

{
    "type":"array",
    "description":"List of headers.",
    "items":{
        "$ref":"#/definitions/Request Header"
    }
}

Nested Schema : Request Header

Type: object

Request Header

Show Source

• key(optional): string
  Key of the header
• value(optional): string
  Value of the header

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key of the header"
        },
        "value":{
            "type":"string",
            "description":"Value of the header"
        }
    },
    "description":"Request Header"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Webhook

Type: object

Webhook Configuration Data

Show Source

• category(optional): string
  Category of the webhook. List of supported categories are
  ASSET_PUBLISHING
  ASSET_LIFECYCLE

  Example: Asset Lifecycle
• createdAt(optional): string
  Date and time at which the webhook was created. Date and time values are in ISO 8601 format with UTC timezone.
• createdBy(optional): object User
  User Metadata Model.
• description(optional): string
  Description of the V1WebhookRestInfo.

  Example: foo description
• enabled(optional): boolean
  Flag to turn on/off a webhook. If the webhook is not enabled, Target URL will not be invoked when the event happens
• eventDetails(optional): array eventDetails
  Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required
• id(optional): integer(int64)
  Unique id of the webhook.It is a required property to read, update and delete a webhook.

  Example: 2367
• links(optional): array links
  Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
• name(optional): string
  Name of the webhook.

  Example: foo
• payload(optional): object Payload
  Payload configuration for the Webhook. Supported pay load names are:
  empty
  brief
  detailed
• target(optional): object Target
  Target end point details for the Webhook.
• updatedAt(optional): string
  Date and time at which the webhook was updated. Date and time values are in ISO 8601 format with UTC timezone.
• updatedBy(optional): object User
  User Metadata Model.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "example":2367,
            "description":"Unique id of the webhook.It is a required property to read, update and delete a webhook."
        },
        "name":{
            "type":"string",
            "example":"foo",
            "description":"Name of the webhook."
        },
        "description":{
            "type":"string",
            "example":"foo description",
            "description":"Description of the V1WebhookRestInfo."
        },
        "createdBy":{
            "description":"User who created the webhook.",
            "$ref":"#/definitions/User"
        },
        "createdAt":{
            "type":"string",
            "description":"Date and time at which the webhook was created. Date and time values are in ISO 8601 format with UTC timezone."
        },
        "updatedAt":{
            "type":"string",
            "description":"Date and time at which the webhook was updated. Date and time values are in ISO 8601 format with UTC timezone."
        },
        "updatedBy":{
            "description":"User who updated the webhook.",
            "$ref":"#/definitions/User"
        },
        "category":{
            "type":"string",
            "example":"Asset Lifecycle",
            "description":"Category of the webhook. List of supported categories are <br>ASSET_PUBLISHING<br>ASSET_LIFECYCLE"
        },
        "enabled":{
            "type":"boolean",
            "description":"Flag to turn on/off a webhook. If the webhook is not enabled, Target URL will not be invoked when the event happens"
        },
        "eventDetails":{
            "type":"array",
            "description":"Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required",
            "items":{
                "$ref":"#/definitions/Webhook Events"
            }
        },
        "payload":{
            "example":"id:brief",
            "description":"This property is used to configure the payload that system send to the webhook.Default is brief",
            "$ref":"#/definitions/Payload"
        },
        "target":{
            "description":"Details about the webhook end point. This is a required property",
            "$ref":"#/definitions/Target"
        },
        "links":{
            "type":"array",
            "description":"Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Webhook Configuration Data"
}

Nested Schema : User

Type: object

User Metadata Model.

Show Source

• displayName(optional): string
  The display name of the user.

  Example: My Display Name
• id(optional): string
  The id of the user.

  Example: 10002
• name(optional): string
  The name of the user.

  Example: [e-mail]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "example":"10002",
            "description":"The id of the user."
        },
        "name":{
            "type":"string",
            "example":"[e-mail]",
            "description":"The name of the user."
        },
        "displayName":{
            "type":"string",
            "example":"My Display Name",
            "description":"The display name of the user."
        }
    },
    "description":"User Metadata Model."
}

Nested Schema : eventDetails

Type: array

Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required

Show Source

• Array of: object Webhook Events
  Event details for Webhook.

{
    "type":"array",
    "description":"Event details that the Webhook is subscribing to. This is a required property. Atleast one event is required",
    "items":{
        "$ref":"#/definitions/Webhook Events"
    }
}

Nested Schema : links

Type: array

Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: object Link
  REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "type":"array",
    "description":"Link to related resources and actions or actions, on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Payload

Type: object

Payload configuration for the Webhook. Supported pay load names are:
empty
brief
detailed

Show Source

• name(optional): string
  Name for the payload. Brief is the default value for webhook is payload is not set

  Example: brief

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "example":"brief",
            "description":"Name for the payload. Brief is the default value for webhook is payload is not set"
        }
    },
    "description":"Payload configuration for the Webhook. Supported pay load names are: <br>empty<br>brief<br>detailed "
}

Nested Schema : Target

Type: object

Target end point details for the Webhook.

Show Source

• security(optional): object Security
  Security configuration for the Webhook target end point.
• url(optional): string
  URL of the webhook end point

  Example: http://www.myserver.com/foo

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "example":"http://www.myserver.com/foo",
            "description":"URL of the webhook end point"
        },
        "security":{
            "example":" \"basicAuth\": {\n        \"username\": \"string\",\n        \"password\": \"string\",\n        \"realm\": \"string\"\n      },",
            "description":"Security details for the webhook. Security can be Basic Auth or Header based",
            "$ref":"#/definitions/Security"
        }
    },
    "description":"Target end point details for the Webhook."
}

Nested Schema : Webhook Events

Type: object

Event details for Webhook.

Show Source

• eventNames(optional): array eventNames
  List of events. Event names can be retrieved from /events/types?expand=all end point
• filter(optional): object Filter

{
    "type":"object",
    "properties":{
        "eventNames":{
            "type":"array",
            "example":"contentitem_created,contentitem_published,digitalasset_created",
            "description":"List of events. Event names can be retrieved from /events/types?expand=all end point",
            "items":{
                "type":"string"
            }
        },
        "filter":{
            "description":"List of sources that triggers this event. It can be list of repositories or channels",
            "$ref":"#/definitions/Filter"
        }
    },
    "description":"Event details for Webhook."
}

Nested Schema : eventNames

Type: array

List of events. Event names can be retrieved from /events/types?expand=all end point

Show Source

• Array of: string

{
    "type":"array",
    "example":"contentitem_created,contentitem_published,digitalasset_created",
    "description":"List of events. Event names can be retrieved from /events/types?expand=all end point",
    "items":{
        "type":"string"
    }
}

Example:

contentitem_created,contentitem_published,digitalasset_created

Nested Schema : Filter

Type: object

Show Source

• objectIds(optional): array objectIds
  List of ids of the objectType.
• objectType(optional): string
  Filter objectType name. It can be repository or channel.

  Example: repository

{
    "type":"object",
    "properties":{
        "objectType":{
            "type":"string",
            "example":"repository",
            "description":"Filter objectType name. It can be repository or channel."
        },
        "objectIds":{
            "type":"array",
            "example":"{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}",
            "description":"List of ids of the objectType.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : objectIds

Type: array

List of ids of the objectType.

Show Source

• Array of: string

{
    "type":"array",
    "example":"{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}",
    "description":"List of ids of the objectType.",
    "items":{
        "type":"string"
    }
}

Example:

{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}

Nested Schema : Link

Type: object

REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string
  The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`.
• mediaType(optional): string
  Link target. Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  Link target HTTP method. HTTP method for requesting the target of the link. * `none` - Indicates no valid HTTP method * `OPTIONS` - HTTP OPTIONS * `HEAD` - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
• profile(optional): string
  Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
• rel(optional): string
  Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details.
• templated(optional): boolean
  Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details."
        },
        "href":{
            "type":"string",
            "description":"The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`."
        },
        "templated":{
            "type":"boolean",
            "description":"Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present."
        },
        "mediaType":{
            "type":"string",
            "description":"Link target. Media type, as defined by RFC 2046, describing the link target."
        },
        "method":{
            "type":"string",
            "description":"Link target HTTP method. HTTP method for requesting the target of the link.  *  `none` - Indicates no valid HTTP method *  `OPTIONS` - HTTP OPTIONS *  `HEAD` - HTTP HEAD *  `GET` - HTTP GET *  `POST` - HTTP POST *  `PUT` - HTTP PUT *  `PATCH` - HTTP PATCH *  `DELETE` - HTTP DELETE"
        },
        "profile":{
            "type":"string",
            "description":"Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource."
        }
    },
    "description":"REST link and related meta data.  If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure."
}

Nested Schema : Security

Type: object

Security configuration for the Webhook target end point.

Show Source

• basicAuth(optional): object BasicAuth
  Basic authentication configuration details. The details will be sent in Authorization header
• headerAuth(optional): object Headers
  Header based authorization configuration details.
• signatureSecurity(optional): object SignatureSecurity
  Signature based security configuration details.

{
    "type":"object",
    "properties":{
        "basicAuth":{
            "description":"Basic authentication configuration.",
            "$ref":"#/definitions/BasicAuth"
        },
        "headerAuth":{
            "description":"Header based authorization configuration.",
            "$ref":"#/definitions/Headers"
        },
        "signatureSecurity":{
            "description":"Signature based security configuration.",
            "$ref":"#/definitions/SignatureSecurity"
        }
    },
    "description":"Security configuration for the Webhook target end point."
}

Nested Schema : BasicAuth

Type: object

Basic authentication configuration details. The details will be sent in Authorization header

Show Source

• password(optional): string
  password for basic authentication
• realm(optional): string
  realm for basic authentication
• username(optional): string
  username for basic authentication

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string",
            "description":"username for basic authentication"
        },
        "password":{
            "type":"string",
            "description":"password for basic authentication"
        },
        "realm":{
            "type":"string",
            "description":"realm for basic authentication"
        }
    },
    "description":"Basic authentication configuration details. The details will be sent in Authorization header"
}

Nested Schema : Headers

Type: object

Header based authorization configuration details.

Show Source

• headers(optional): array headers
  List of headers.

{
    "type":"object",
    "properties":{
        "headers":{
            "type":"array",
            "description":"List of headers.",
            "items":{
                "$ref":"#/definitions/Request Header"
            }
        }
    },
    "description":"Header based authorization configuration details."
}

Nested Schema : SignatureSecurity

Type: object

Signature based security configuration details.

Show Source

• signatureToken(optional): string
  Signature Token should be lowercase alphanumeric [a-z, 0-9] string of length 32.

{
    "type":"object",
    "properties":{
        "signatureToken":{
            "type":"string",
            "description":"Signature Token should be lowercase alphanumeric [a-z, 0-9] string of length 32."
        }
    },
    "description":"Signature based security configuration details."
}

Nested Schema : headers

Type: array

List of headers.

Show Source

• Array of: object Request Header
  Request Header

{
    "type":"array",
    "description":"List of headers.",
    "items":{
        "$ref":"#/definitions/Request Header"
    }
}

Nested Schema : Request Header

Type: object

Request Header

Show Source

• key(optional): string
  Key of the header
• value(optional): string
  Value of the header

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "description":"Key of the header"
        },
        "value":{
            "type":"string",
            "description":"Value of the header"
        }
    },
    "description":"Request Header"
}

304 Response

Not Modified

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

400 Response

Bad Request

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

404 Response

Not Found

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

Back to Top