クイックアクション
ビジネス オブジェクトに対してクイック アクションを実行します。 たとえば、インシデントまたは問題をクローズ、複製、または解決します。
クイック アクションとクイック アクションのリストの表示の詳細については、「 ビジネスオブジェクトのクイックアクションのリストを表示するを参照してください。
ベース URL:
https://{tenant url}/api/odata/businessobject/{business object name}('{business object unique key}')/{quick action name}
- ビジネス オブジェクト名の末尾に「s」が付いていることを確認します。
- クイックアクション ID は、 メタデータ APIから取得できます。
クイックアクションを使用してインシデントをクローズする例を次に示します。
メールアドレス | https://{tenant url}/api/odata/businessobject/incidents('{Incident Rec ID}')/Close_Incident |
|---|---|
方法 | 役職 |
ヘッダー名 | 認証: JTW トークン/セッション キー/REST API キー |
リクエストペイロード | { "ActionId":"3492dbcc-e502-44fd-9790-e3e45cb26c45", "保存すべき":true, "ActionParams":{ "FormParams":{ "actionId":"3492dbcc-e502-44fd-9790-e3e45cb26c45", "actualObjectType":"Incident#", "オブジェクトID":"CAA8B29A4D24464FA68DBF281D7505B9" }, "GridParams":null }, "PromptParams":[ { "__type":"DataLayer.PromptData", "ActionId":null, "ActionObjectId":null, "PromptObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "ActionObjectType":"Incident#", "PromptObjectType":"Incident#", "値":"閉じた", "FieldName":"Status", "IsNewPrompt":true }, { "__type":"DataLayer.PromptData", "ラベル":"原因コードを選択", "ActionId":"3492dbcc-e502-44fd-9790-e3e45cb26c45", "ActionObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "PromptObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "ActionObjectType":"Incident#", "PromptObjectType":"Incident#", "値":"ドキュメント要求", "ValidList":"インシデント原因コード", "FieldName":"CauseCode", "FieldType":"list", "FieldLength":40, 「精度」:0, "FieldAreaWidth":400, "FieldAreaHeight":200, 「パスワード」:false、 "必須":true, "DefaultValue":"", 「非表示」:false、 "IsNewPrompt":true }, { "__type":"DataLayer.PromptData", "ラベル":"最初の通話で解決しましたか?", "ActionId":"3492dbcc-e502-44fd-9790-e3e45cb26c45", "ActionObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "PromptObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "ActionObjectType":"Incident#", "PromptObjectType":"Incident#", "値":null, "有効なリスト":"", "FieldName":"FirstCallResolution", "FieldType":"boolean", "FieldLength":0, 「精度」:0, "FieldAreaWidth":0, "FieldAreaHeight":0, 「パスワード」:false、 「必須」:false、 "DefaultValue":null, 「非表示」:false、 "IsNewPrompt":true }, { "__type":"DataLayer.PromptData", "ラベル":"解像度", "ActionId":"3492dbcc-e502-44fd-9790-e3e45cb26c45", "ActionObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "PromptObjectId":"CAA8B29A4D24464FA68DBF281D7505B9", "ActionObjectType":"Incident#", "PromptObjectType":"Incident#", "値":"テスト", "有効なリスト":"", "FieldName":"Resolution", "FieldType":"text", "FieldLength":4000, 「精度」:0, "FieldAreaWidth":400, "FieldAreaHeight":200, 「パスワード」:false、 "必須":true, "DefaultValue":"", 「非表示」:false、 "IsNewPrompt":true } ] } |
ステータスコード | 200 |
クイックアクションを使用してインシデントを割り当てる例を次に示します。
メールアドレス | https://{tenant url}/api/odata/businessobject/incidents('{Incident Rec ID')/Assign_Incident |
|---|---|
方法 | 役職 |
ヘッダー名 | 認証: JTW トークン/セッション キー/REST API キー |
リクエストペイロード | { "ActionId": "ec205b17-09ab-4405-87aa-246f2dce3960", 「保存すべき」: true、 "ActionParams": { "GridParams": null, "FormParams": { "actionId": "ec205b17-09ab-4405-87aa-246f2dce3960", "オブジェクトID": "C1B35DCEA41542E1AD0ED58775795ABA", "actualObjectType": "Incident#" } }, "promptParams": null } |
ステータスコード | 200 |
クイックアクションを使用してタスクを受け入れる例を次に示します。
メールアドレス | https://{tenant url}/api/odata/businessobject/tasks('{Task Rec ID}')/Accept_Task |
|---|---|
方法 | 役職 |
ヘッダー名 | 認証: JTW トークン/セッション キー/REST API キー |
リクエストペイロード | { "ActionId": "e383dc0e-28b4-4e7a-9ac2-66248f991d71", 「保存すべき」: true、 "ActionParams": { "GridParams": { "actionId": "e383dc0e-28b4-4e7a-9ac2-66248f991d71", 「レコードID」: [ { "RecordId": "C6CCA4CEC8094724900EF60993662A44", "ObjectType": "タスク } ] }, "FormParams": null }, "PromptParams": null } |
ステータスコード | 200 |
応答に失敗しました
シナリオ: 必須フィールドの情報を提供せずにインシデントをクローズしようとしています。
https://{tenant url}/api/odata/businessobject/incidents('E44D7F1B97534363B5FAD9DAAAFAECF1')/Close_Incident
ヘッダー名:
認証: セッションキー
コード | ISM_4000 |
|---|---|
説明 | 無効なリクエストペイロード |
メッセージ | [ 「必須プロンプトパラメータ「ステータス」がありません」 「必須プロンプトパラメータ「CauseCode」がありません」 「必須プロンプトパラメータ 'FirstCallResolution' がありません」 「必要なプロンプトパラメータ「解決」がありません」 「 ] |
HTTP ステータス コード | 400 |
