テンプレート・アクションの作成
post
/crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction
リクエスト
パス・パラメータ
- TemplateId(required): integer(int64)
処理プラン・テンプレートの一意の識別子。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
- Upsert-Mode:
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object
-
ActionId(required): integer (int64)
タイトル:
Action ID
アクションの一意の識別子。 -
ActionNumber(required): string
タイトル:
Action Number
最大長:64
処理の参照番号。 -
actionRelation: array Action Relations
タイトル:
Action Relations
処理関係リソースは、処理プラン・テンプレート内の他の処理に対する処理の依存関係を表示、作成、更新および削除するために使用されます。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
テンプレート処理が削除されたかどうかを示します。 デフォルト値はfalseです。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
デフォルト値:true
処理プランの処理が必須かどうかを示します。 デフォルト値はtrueです。 -
OrderNumber(required): integer (int64)
タイトル:
Sort Number
アクション・テンプレート内のアクションの表示順序。 -
TemplateActionNumber: string
タイトル:
Template Action Number
最大長:30
テンプレート処理参照番号。 -
TemplateId(required): integer (int64)
タイトル:
Template ID
処理プラン・テンプレートの一意の識別子。 -
TemplateNumber(required): string
タイトル:
Template Number
最大長:30
処理プラン・テンプレートの参照番号。
ネストされたスキーマ : 処理関連
タイプ:
array
タイトル:
Action Relations
処理関係リソースは、処理プラン・テンプレート内の他の処理に対する処理の依存関係を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : スキーマ
タイプ:
ソースを表示
object
-
ActionStatusCd: string
タイトル:
Action Status
最大長:30
デフォルト値:ORA_SVC_COMPLETED
処理関係の依存関係条件を示すステータス・コード。 有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。 -
ActionStatusCdMeaning: string
タイトル:
Action Status Value
最大長:255
処理関係の処理ステータス参照コードに対応する表示値。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。 -
DepTemplateActionId: integer (int64)
タイトル:
Dependent Template Action ID
処理プラン内の依存処理の一意の識別子です。 -
DepTemplateActionNumber: string
タイトル:
Dependent Template Action Number
最大長:30
依存処理のテンプレート処理参照番号です。 -
RelationId: integer (int64)
タイトル:
Relation ID
処理プラン内の処理間の関係の一意の識別子。 -
TemplateActionId: integer (int64)
タイトル:
Template Action ID
テンプレート処理の一意の識別子。 -
TemplateActionNumber: string
タイトル:
Template Action Number
最大長:30
テンプレート処理参照番号。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : actiontemplates-templateAction-item-response
タイプ:
ソースを表示
object
-
ActionId: integer (int64)
タイトル:
Action ID
アクションの一意の識別子。 -
ActionNumber: string
タイトル:
Action Number
最大長:64
処理の参照番号。 -
actionRelation: array Action Relations
タイトル:
Action Relations
処理関係リソースは、処理プラン・テンプレート内の他の処理に対する処理の依存関係を表示、作成、更新および削除するために使用されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクションをテンプレートに追加したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクションがテンプレートに追加された日時。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
テンプレート処理が削除されたかどうかを示します。 デフォルト値はfalseです。 -
DeleteFlag: boolean
読取り専用:
true
テンプレート処理を削除できるかどうかを示します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
テンプレート・アクションが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
テンプレート処理を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
テンプレート処理を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
デフォルト値:true
処理プランの処理が必須かどうかを示します。 デフォルト値はtrueです。 -
OrderNumber: integer (int64)
タイトル:
Sort Number
アクション・テンプレート内のアクションの表示順序。 -
Prerequisites: string
読取り専用:
true
アクションの前提条件のアクション・ステップ。 -
TemplateActionId: integer (int64)
タイトル:
Template Action ID
読取り専用:true
テンプレート処理の一意の識別子。 -
TemplateActionNumber: string
タイトル:
Template Action Number
最大長:30
テンプレート処理参照番号。 -
TemplateId: integer (int64)
タイトル:
Template ID
処理プラン・テンプレートの一意の識別子。 -
TemplateNumber: string
タイトル:
Template Number
最大長:30
処理プラン・テンプレートの参照番号。 -
Tier: integer
読取り専用:
true
アクション・プラン・ダイアグラムで適切なレベルのアクション・ノードを表示するために使用する層。 -
UpdateFlag: boolean
読取り専用:
true
テンプレート処理を更新できるかどうかを示します。
ネストされたスキーマ : 処理関連
タイプ:
array
タイトル:
Action Relations
処理関係リソースは、処理プラン・テンプレート内の他の処理に対する処理の依存関係を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : actiontemplates-templateAction-actionRelation-item-response
タイプ:
ソースを表示
object
-
ActionStatusCd: string
タイトル:
Action Status
最大長:30
デフォルト値:ORA_SVC_COMPLETED
処理関係の依存関係条件を示すステータス・コード。 有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。 -
ActionStatusCdMeaning: string
タイトル:
Action Status Value
最大長:255
処理関係の処理ステータス参照コードに対応する表示値。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
アクションの依存関係を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
アクション依存関係が作成された日時。 -
DeletedFlag: boolean
タイトル:
Deleted
最大長:1
デフォルト値:false
処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。 -
DeleteFlag: boolean
読取り専用:
true
処理関連を削除できるかどうかを示します。 -
DepTemplateActionId: integer (int64)
タイトル:
Dependent Template Action ID
処理プラン内の依存処理の一意の識別子です。 -
DepTemplateActionNumber: string
タイトル:
Dependent Template Action Number
最大長:30
依存処理のテンプレート処理参照番号です。 -
DepTmpActionOrderNumber: integer (int64)
タイトル:
Sort Number
読取り専用:true
アクション・テンプレート内のアクションの表示順序。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
アクションの依存関係が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
アクションの依存関係を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
アクションの依存関係を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
RelationId: integer (int64)
タイトル:
Relation ID
処理プラン内の処理間の関係の一意の識別子。 -
TemplateActionId: integer (int64)
タイトル:
Template Action ID
テンプレート処理の一意の識別子。 -
TemplateActionNumber: string
タイトル:
Template Action Number
最大長:30
テンプレート処理参照番号。 -
UpdateFlag: boolean
読取り専用:
true
処理関連を更新できるかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- YesNoLookup
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DYES_NO
テンプレート処理が必須かどうかを示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: MandatoryFlag;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- actionRelation
-
パラメータ:
- TemplateActionId:
$request.path.TemplateActionId
- TemplateId:
$request.path.TemplateId
処理プラン・テンプレートの処理間の関係を示します。 - TemplateActionId:
例:
次の例は、cURLを使用してRESTリソースに対してPOSTリクエストを発行することによって、アクション・テンプレートにアクションを作成する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actiontemplates/300100118669128/child/templateAction/
リクエスト本文の例
次の例は、JSON形式のリクエスト本文のコンテンツを示しています。
{ "ActionId": 300100117426507, "OrderNumber":"189" }
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "ActionId": 300100117426507, "CreatedBy": "SALES_ADMIN", "CreationDate": "2017-10-09T12:02:45+00:00", "DeletedFlag": false, "LastUpdateDate": "2017-10-09T12:02:45.015+00:00", "LastUpdateLogin": "5B1C798066630C0DE0538E09F20A9CA0", "LastUpdatedBy": "SALES_ADMIN", "MandatoryFlag": true, "OrderNumber": 189, "TemplateActionId": 300100120240863, "TemplateId": 300100118669128, "UpdateFlag": true, "DeleteFlag": true, "Prerequisites": null, "Tier": 0, "links": [ ... ] }