Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

アクション条件の作成

post

/crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition

リクエスト

パス・パラメータ

ActionNumber(required): string

アクションの代替一意識別子。

ヘッダー・パラメータ

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: integer (int64)

タイトル: Action ID

アクションの一意の識別子。
ActionNumber: string

タイトル: Action Number

最大長: 64

アクションの代替一意識別子。
ActionStatusCd: string

タイトル: Action Status

最大長: 30

条件が満たされたかどうかに基づく処理のステータスを示すコード。有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
ActionStatusCdMeaning: string

タイトル: Action Status Value

最大長: 255

処理条件の処理ステータス参照コードに対応する表示値。
CompletionFlag: boolean

タイトル: CompletionFlag

最大長: 1

条件を履行して処理が完了したかどうかを示します。デフォルト値はfalseです。
Condition: string

タイトル: Condition

最大長: 1000

条件が満たされているかどうかを示す式。
Description: string

タイトル: Description

最大長: 1000

アクション条件の説明。
Name: string

タイトル: Name

最大長: 400

アクション条件の名前。

{
    "type":"object",
    "properties":{
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression indicating whether the condition is met or not.",
            "nullable":false
        },
        "CompletionFlag":{
            "title":"CompletionFlag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action was completed by fulfilling the condition. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action condition.",
            "nullable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action condition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            }
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action condition.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : actions-actionCondition-item-response

タイプ: object

ソースを表示

ActionConditionId: integer (int64)

タイトル: Action Condition ID

読取り専用: true

アクション条件の一意の識別子。
ActionId: integer (int64)

タイトル: Action ID

アクションの一意の識別子。
ActionNumber: string

タイトル: Action Number

最大長: 64

アクションの代替一意識別子。
ActionStatusCd: string

タイトル: Action Status

最大長: 30

条件が満たされたかどうかに基づく処理のステータスを示すコード。有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
ActionStatusCdMeaning: string

タイトル: Action Status Value

最大長: 255

処理条件の処理ステータス参照コードに対応する表示値。
CompletionFlag: boolean

タイトル: CompletionFlag

最大長: 1

条件を履行して処理が完了したかどうかを示します。デフォルト値はfalseです。
Condition: string

タイトル: Condition

最大長: 1000

条件が満たされているかどうかを示す式。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

アクション条件を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

条件が作成された日時。
DeleteFlag: boolean

読取り専用: true

処理条件を削除できるかどうかを示します。
Description: string

タイトル: Description

最大長: 1000

アクション条件の説明。
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

リソース・インスタンスに関連付けられたリンク関係。
Name: string

タイトル: Name

最大長: 400

アクション条件の名前。
UpdateFlag: boolean

読取り専用: true

処理条件を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression indicating whether the condition is met or not.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action condition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action condition.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionFlag":{
            "title":"CompletionFlag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action was completed by fulfilling the condition. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action condition can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActionConditionId":{
            "title":"Action Condition ID",
            "type":"integer",
            "description":"The unique identifier of the action condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action condition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the action condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

ActionStatusCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD

処理条件のステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: ActionStatusCd;ターゲット属性: LookupCode
表示属性: LookupCode

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

処理の完了ステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: CompletionFlag;ターゲット属性: LookupCode
表示属性: LookupCode

トップに戻る

例:

次の例は、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/actions/ACT0000044368/child/actionCondition

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"ActionStatusCd": "ORA_SVC_COMPLETED",
"Condition": "(Location LIKE '%KM_Completed%')",
"Description": null,
"Name":null
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
"items": [
  {
"ActionConditionId": 300100118621887,
"ActionId": 300100118621849,
"ActionStatusCd": "ORA_SVC_COMPLETED",
"Condition": "(Location LIKE '%KM_Completed%')",
"CompletionFlag": true,
"CreatedBy": "xuidrill2",
"CreationDate": "2017-09-25T06:47:18.957+00:00",
"Description": null,
"LastUpdateDate": "2017-09-25T07:49:50+00:00",
"LastUpdateLogin": "59FCEEEABAA256BBE0538E09F20A384F",
"LastUpdatedBy": "xuidrill2",
"Name": null,
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
}

「トップに戻る」