Webフック管理用のREST API

Webフックの更新

put

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

指定されたペイロードの場合。 Webフックを更新するには、ユーザーに管理ロールが必要です。ユーザーにはWebフックを更新するためのアクセス権が必要です。ユーザーには、構成されたWebフックの更新に対応するマネージャ・アクセス権が必要です。

Webフックの更新にはCSRFトークン・ヘッダー(X-CSRF-TOKEN)が必要です。トークンはトークンRESTサービスから取得できます。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

id: integer(int64)

webフックのID。

Webフック・オブジェクト

ルート・スキーマ : Webhook

型: object

Webフック構成データ

Show Source

category(optional): string

webフックのカテゴリ。サポートされているカテゴリのリスト
ASSET_PUBLISHING
ASSET_LIFECYCLE

例: Asset Lifecycle
createdAt(optional): string

webフックが作成された日時。日付値と時間値はUTCタイムゾーンを使用したISO 8601形式です。
createdBy(optional): object User

ユーザーMetadataモデル。
description(optional): string

V1WebhookRestInfoの説明。

例: foo description
enabled(optional): boolean

webフックのオン/オフを切り替えるフラグ。 webフックが有効になっていない場合、イベントが発生したときにターゲットURLは呼び出されません
eventDetails(optional): array eventDetails

Webフックがサブスクライブしているイベントの詳細。これは必須プロパティです。少なくとも1つのイベントが必要です
id(optional): integer(int64)

webフックの一意のID。Webフックを読み取り、更新、および削除するための必須プロパティです。

例: 2367
links(optional): array links

このリソースの関連リソースおよびアクションへのリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
name(optional): string

webフックの名前。

例: foo
payload(optional): object Payload

Webフックのペイロード構成。サポートされているペイロード名は:
empty
brief
detailed
target(optional): object Target

Webフックのターゲット・エンド・ポイントの詳細。
updatedAt(optional): string

webフックが更新された日時。日付値と時間値はUTCタイムゾーンを使用したISO 8601形式です。
updatedBy(optional): object User

ユーザーMetadataモデル。

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

ネストされたスキーマ: User

型: object

ユーザーMetadataモデル。

Show Source

displayName(optional): string

ユーザーの表示名。

例: My Display Name
id(optional): string

ユーザーのId。

例: 10002
name(optional): string

ユーザーの名前。

例: example@myorg.com

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "example":"10002",
            "description":"The id of the user."
        },
        "name":{
            "type":"string",
            "example":"example@myorg.com",
            "description":"The name of the user."
        },
        "displayName":{
            "type":"string",
            "example":"My Display Name",
            "description":"The display name of the user."
        }
    },
    "description":"User Metadata Model."
}

ネストされたスキーマ : eventDetails

型: array

Webフックがサブスクライブしているイベントの詳細。これは必須プロパティです。少なくとも1つのイベントが必要です

Show Source

Array of: object Webhook Events

Webフックのイベント詳細。

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

ネストされたスキーマ: links

型: array

このリソースの関連リソースおよびアクションへのリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

Show Source

Array of: object Link

RESTリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

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

ネストされたスキーマ : ペイロード

型: object

Webフックのペイロード構成。サポートされているペイロード名は:
empty
brief
detailed

Show Source

name(optional): string

ペイロードの名前。簡易は、webフックのデフォルト値であるペイロードが設定されていません

例: 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 "
}

ネストされたスキーマ : ターゲット

型: object

Webフックのターゲット・エンド・ポイントの詳細。

Show Source

security(optional): object Security

Webフック・ターゲット・エンドポイントのセキュリティ構成。
url(optional): string

webフック・エンドポイントのURL

例: 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."
}

ネストされたスキーマ : Webフック・イベント

型: object

Webフックのイベント詳細。

Show Source

eventNames(optional): array eventNames

イベントのリスト。イベント名は/events/types?expand=allエンド・ポイントから取得できます
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."
}

ネストされたスキーマ : eventNames

型: array

イベントのリスト。イベント名は/events/types?expand=allエンド・ポイントから取得できます

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

例:

contentitem_created,contentitem_published,digitalasset_created

ネストされたスキーマ: Filter

型: object

Show Source

objectIds(optional): array objectIds

objectTypeのidのリスト。
objectType(optional): string

objectType名をフィルタ処理します。これは、リポジトリまたはチャネルです。

例: 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"
            }
        }
    }
}

ネストされたスキーマ : objectIds

型: array

objectTypeのidのリスト。

Show Source

Array of: string

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

例:

{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}

ネストされたスキーマ : リンク

型: object

RESTリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Show Source

href(optional): string

ターゲット・リソースのURI URI *RFC3986*またはURIテンプレート*RFC6570*。値がURIテンプレートに設定されている場合、`templated`プロパティを`true`に設定する必要があります。
mediaType(optional): string

リンク・ターゲット。メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string

ターゲットHTTPメソッドをリンクします。リンクのターゲットをリクエストするためのHTTPメソッド。* `none` - 有効なHTTPメソッド*'OPTIONS`がないことを示します - HTTP OPTIONS * `HEAD - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
profile(optional): string

リンク・メタデータのロケーション。ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンク関係。リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefテンプレートのリンク・フラグ。 `href`プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、このプロパティは`false`と想定できます。

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

ネストされたスキーマ : セキュリティ

型: object

Webフック・ターゲット・エンドポイントのセキュリティ構成。

Show Source

basicAuth(optional): object BasicAuth

基本認証の構成の詳細。詳細は認可ヘッダーで送信されます
headerAuth(optional): object Headers

ヘッダー・ベースの認可構成の詳細。
signatureSecurity(optional): object SignatureSecurity

シグネチャ・ベースのセキュリティ構成詳細。

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

ネストされたスキーマ : BasicAuth

型: object

基本認証の構成の詳細。詳細は認可ヘッダーで送信されます

Show Source

password(optional): string

basic認証のパスワード
realm(optional): string

basic認証のレルム
username(optional): string

basic認証用ユーザー名

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

ネストされたスキーマ : ヘッダー

型: object

ヘッダー・ベースの認可構成の詳細。

Show Source

headers(optional): array headers

ヘッダーのリスト。

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

ネストされたスキーマ : SignatureSecurity

型: object

シグネチャ・ベースのセキュリティ構成詳細。

Show Source

signatureToken(optional): string

シグネチャ・トークンは、長さ32の小文字の英数字[a-z、0-9]文字列である必要があります。

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

ネストされたスキーマ: headers

型: array

ヘッダーのリスト。

Show Source

Array of: object Request Header

リクエスト・ヘッダー

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

ネストされたスキーマ : リクエスト・ヘッダー

型: object

リクエスト・ヘッダー

Show Source

key(optional): string

ヘッダーのキー
value(optional): string

ヘッダーの値

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

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

ルート・スキーマ : Webhook

型: object

Webフック構成データ

Show Source

category(optional): string

webフックのカテゴリ。サポートされているカテゴリのリスト
ASSET_PUBLISHING
ASSET_LIFECYCLE

例: Asset Lifecycle
createdAt(optional): string

webフックが作成された日時。日付値と時間値はUTCタイムゾーンを使用したISO 8601形式です。
createdBy(optional): object User

ユーザーMetadataモデル。
description(optional): string

V1WebhookRestInfoの説明。

例: foo description
enabled(optional): boolean

webフックのオン/オフを切り替えるフラグ。 webフックが有効になっていない場合、イベントが発生したときにターゲットURLは呼び出されません
eventDetails(optional): array eventDetails

Webフックがサブスクライブしているイベントの詳細。これは必須プロパティです。少なくとも1つのイベントが必要です
id(optional): integer(int64)

webフックの一意のID。Webフックを読み取り、更新、および削除するための必須プロパティです。

例: 2367
links(optional): array links

このリソースの関連リソースおよびアクションへのリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
name(optional): string

webフックの名前。

例: foo
payload(optional): object Payload

Webフックのペイロード構成。サポートされているペイロード名は:
empty
brief
detailed
target(optional): object Target

Webフックのターゲット・エンド・ポイントの詳細。
updatedAt(optional): string

webフックが更新された日時。日付値と時間値はUTCタイムゾーンを使用したISO 8601形式です。
updatedBy(optional): object User

ユーザーMetadataモデル。

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

ネストされたスキーマ: User

型: object

ユーザーMetadataモデル。

Show Source

displayName(optional): string

ユーザーの表示名。

例: My Display Name
id(optional): string

ユーザーのId。

例: 10002
name(optional): string

ユーザーの名前。

例: example@myorg.com

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "example":"10002",
            "description":"The id of the user."
        },
        "name":{
            "type":"string",
            "example":"example@myorg.com",
            "description":"The name of the user."
        },
        "displayName":{
            "type":"string",
            "example":"My Display Name",
            "description":"The display name of the user."
        }
    },
    "description":"User Metadata Model."
}

ネストされたスキーマ : eventDetails

型: array

Webフックがサブスクライブしているイベントの詳細。これは必須プロパティです。少なくとも1つのイベントが必要です

Show Source

Array of: object Webhook Events

Webフックのイベント詳細。

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

ネストされたスキーマ: links

型: array

Show Source

Array of: object Link

RESTリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

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

ネストされたスキーマ : ペイロード

型: object

Webフックのペイロード構成。サポートされているペイロード名は:
empty
brief
detailed

Show Source

name(optional): string

ペイロードの名前。簡易は、webフックのデフォルト値であるペイロードが設定されていません

例: 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 "
}

ネストされたスキーマ : ターゲット

型: object

Webフックのターゲット・エンド・ポイントの詳細。

Show Source

security(optional): object Security

Webフック・ターゲット・エンドポイントのセキュリティ構成。
url(optional): string

webフック・エンドポイントのURL

例: 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."
}

ネストされたスキーマ : Webフック・イベント

型: object

Webフックのイベント詳細。

Show Source

eventNames(optional): array eventNames

イベントのリスト。イベント名は/events/types?expand=allエンド・ポイントから取得できます
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."
}

ネストされたスキーマ : eventNames

型: array

イベントのリスト。イベント名は/events/types?expand=allエンド・ポイントから取得できます

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

例:

contentitem_created,contentitem_published,digitalasset_created

ネストされたスキーマ: Filter

型: object

Show Source

objectIds(optional): array objectIds

objectTypeのidのリスト。
objectType(optional): string

objectType名をフィルタ処理します。これは、リポジトリまたはチャネルです。

例: 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"
            }
        }
    }
}

ネストされたスキーマ : objectIds

型: array

objectTypeのidのリスト。

Show Source

Array of: string

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

例:

{F1B337DC2AF3DBCC98701AB86D1F21FC05E8AB20694D}

ネストされたスキーマ : リンク

型: object

Show Source

href(optional): string

ターゲット・リソースのURI URI *RFC3986*またはURIテンプレート*RFC6570*。値がURIテンプレートに設定されている場合、`templated`プロパティを`true`に設定する必要があります。
mediaType(optional): string

リンク・ターゲット。メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string

ターゲットHTTPメソッドをリンクします。リンクのターゲットをリクエストするためのHTTPメソッド。* `none` - 有効なHTTPメソッド*'OPTIONS`がないことを示します - HTTP OPTIONS * `HEAD - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
profile(optional): string

リンク・メタデータのロケーション。ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンク関係。リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefテンプレートのリンク・フラグ。 `href`プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、このプロパティは`false`と想定できます。

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

ネストされたスキーマ : セキュリティ

型: object

Webフック・ターゲット・エンドポイントのセキュリティ構成。

Show Source

basicAuth(optional): object BasicAuth

基本認証の構成の詳細。詳細は認可ヘッダーで送信されます
headerAuth(optional): object Headers

ヘッダー・ベースの認可構成の詳細。
signatureSecurity(optional): object SignatureSecurity

シグネチャ・ベースのセキュリティ構成詳細。

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

ネストされたスキーマ : BasicAuth

型: object

基本認証の構成の詳細。詳細は認可ヘッダーで送信されます

Show Source

password(optional): string

basic認証のパスワード
realm(optional): string

basic認証のレルム
username(optional): string

basic認証用ユーザー名

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

ネストされたスキーマ : ヘッダー

型: object

ヘッダー・ベースの認可構成の詳細。

Show Source

headers(optional): array headers

ヘッダーのリスト。

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

ネストされたスキーマ : SignatureSecurity

型: object

シグネチャ・ベースのセキュリティ構成詳細。

Show Source

signatureToken(optional): string

シグネチャ・トークンは、長さ32の小文字の英数字[a-z、0-9]文字列である必要があります。

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

ネストされたスキーマ: headers

型: array

ヘッダーのリスト。

Show Source

Array of: object Request Header

リクエスト・ヘッダー

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

ネストされたスキーマ : リクエスト・ヘッダー

型: object

リクエスト・ヘッダー

Show Source

key(optional): string

ヘッダーのキー
value(optional): string

ヘッダーの値

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

304レスポンス

Not Modified

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
instance(optional): string

エラーの詳細を提供するURIをリンクに追加します。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

HTTPステータス・コード。例外に対応するHTTPステータス・コード。リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
title(optional): string

問題の短く、判読可能なサマリー。ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
type(optional): string

問題のタイプを識別する絶対URI。このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

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

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

Array of: object ExceptionDetail

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。追加情報はオプションですが、指定すると、例外詳細の形式になります。

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

400レスポンス

不正リクエスト

ルート・スキーマ : ExceptionDetail

型: object

Show Source

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
instance(optional): string

エラーの詳細を提供するURIをリンクに追加します。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

HTTPステータス・コード。例外に対応するHTTPステータス・コード。リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
title(optional): string

問題の短く、判読可能なサマリー。ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
type(optional): string

問題のタイプを識別する絶対URI。このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

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

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

Array of: object ExceptionDetail

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。追加情報はオプションですが、指定すると、例外詳細の形式になります。

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

404レスポンス

Not Found

ルート・スキーマ : ExceptionDetail

型: object

Show Source

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
instance(optional): string

エラーの詳細を提供するURIをリンクに追加します。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

HTTPステータス・コード。例外に対応するHTTPステータス・コード。リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
title(optional): string

問題の短く、判読可能なサマリー。ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
type(optional): string

問題のタイプを識別する絶対URI。このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

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

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

Array of: object ExceptionDetail

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。追加情報はオプションですが、指定すると、例外詳細の形式になります。

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

500レスポンス

内部サーバー・エラー

ルート・スキーマ : ExceptionDetail

型: object

Show Source

detail(optional): string

この問題の発生に固有の説明。人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
instance(optional): string

エラーの詳細を提供するURIをリンクに追加します。
o:errorCode(optional): string

アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
o:errorDetails(optional): array o:errorDetails

階層構造に複数のエラーがある場合もあります。
o:errorPath(optional): string

エラーが発生した場所を示すXPathまたはJSONパス。
status(optional): integer(int32)

HTTPステータス・コード。例外に対応するHTTPステータス・コード。リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
title(optional): string

問題の短く、判読可能なサマリー。ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
type(optional): string

問題のタイプを識別する絶対URI。このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

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

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

Array of: object ExceptionDetail

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。追加情報はオプションですが、指定すると、例外詳細の形式になります。

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

トップに戻る