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

機械翻訳について

処理属性の作成

post

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

リクエスト

パス・パラメータ

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

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

タイトル: Attribute Name

最大長: 2000

処理属性の名前。
AttributeValue: string

タイトル: Attribute Value

最大長: 1000

処理属性に設定される値。
AttributeValueContextCd: string

タイトル: Context

最大長: 30

デフォルト値: ORA_SVC_USER_DEFINED

属性値が解釈されるコンテキストを示すコード。有効な値のリストは、参照ORA_SVC_AP_CONTEXT_CDで定義されます。
AttributeValueContextCdMeaning: string

タイトル: Context Value

最大長: 255

処理属性のコンテキスト参照コードに対応する表示値。
ChildAttributeFlag: boolean

タイトル: Child Attribute Indicator

最大長: 1

デフォルト値: false

この属性が親オブジェクトまたはその子オブジェクトのいずれに属するかを示します。
DeletedFlag: boolean

タイトル: Deleted

最大長: 1

デフォルト値: false

属性処理が削除されたかどうかを示します。デフォルト値はfalseです。
UsageCd: string

タイトル: Usage

最大長: 30

デフォルト値: ORA_SVC_CREATE

属性が使用されるタイミングを示すコード。有効な値のリストは、参照ORA_SVC_AP_ATTRIBUTE_USAGE_CDで定義されます。
UsageCdMeaning: string

タイトル: Usage Value

最大長: 255

処理属性の使用参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value to be set for the action attribute.",
            "nullable":true
        },
        "UsageCd":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.",
            "nullable":false,
            "default":"ORA_SVC_CREATE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageCdMeaning":{
            "title":"Usage Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the usage lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "UsageCd"
                ]
            }
        },
        "AttributeValueContextCdMeaning":{
            "title":"Context Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the context lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueContextCd"
                ]
            }
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attribute action is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttributeValueContextCd":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup  ORA_SVC_AP_CONTEXT_CD.",
            "nullable":false,
            "default":"ORA_SVC_USER_DEFINED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":2000,
            "type":"string",
            "description":"The name of the action attribute.",
            "nullable":false
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false
        },
        "ChildAttributeFlag":{
            "title":"Child Attribute Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this attribute belongs to the parent or one of its child objects.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

ActionAttributeId: integer (int64)

タイトル: Action Attribute ID

読取り専用: true

処理属性の一意の識別子。
ActionId: integer (int64)

タイトル: Action ID

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

タイトル: Action Number

最大長: 64

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

タイトル: Attribute Name

最大長: 2000

処理属性の名前。
AttributeValue: string

タイトル: Attribute Value

最大長: 1000

処理属性に設定される値。
AttributeValueContextCd: string

タイトル: Context

最大長: 30

デフォルト値: ORA_SVC_USER_DEFINED

属性値が解釈されるコンテキストを示すコード。有効な値のリストは、参照ORA_SVC_AP_CONTEXT_CDで定義されます。
AttributeValueContextCdMeaning: string

タイトル: Context Value

最大長: 255

処理属性のコンテキスト参照コードに対応する表示値。
ChildAttributeFlag: boolean

タイトル: Child Attribute Indicator

最大長: 1

デフォルト値: false

この属性が親オブジェクトまたはその子オブジェクトのいずれに属するかを示します。
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

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

読取り専用: true

処理属性を更新できるかどうかを示します。
UsageCd: string

タイトル: Usage

最大長: 30

デフォルト値: ORA_SVC_CREATE

属性が使用されるタイミングを示すコード。有効な値のリストは、参照ORA_SVC_AP_ATTRIBUTE_USAGE_CDで定義されます。
UsageCdMeaning: string

タイトル: Usage Value

最大長: 255

処理属性の使用参照コードに対応する表示値。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value to be set for the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionAttributeId":{
            "title":"Action Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the action attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueContextCdMeaning":{
            "title":"Context Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the context lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueContextCd"
                ]
            },
            "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 attribute can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action attribute 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
        },
        "UsageCd":{
            "title":"Usage",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.",
            "nullable":false,
            "default":"ORA_SVC_CREATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageCdMeaning":{
            "title":"Usage Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the usage lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "UsageCd"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attribute action is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttributeValueContextCd":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup  ORA_SVC_AP_CONTEXT_CD.",
            "nullable":false,
            "default":"ORA_SVC_USER_DEFINED",
            "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"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":2000,
            "type":"string",
            "description":"The name of the action attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ChildAttributeFlag":{
            "title":"Child Attribute Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this attribute belongs to the parent or one of its child objects.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action attribute 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 attribute.",
            "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."
        }
    }
}

リンク

UsageCdLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

処理属性を使用するタイミングを示す値リスト。

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

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

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

この属性が親またはchidオブジェクトのいずれに属するかを示す値リスト。

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

ソース属性: ChildAttributeFlag;ターゲット属性: 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/actions/ACT0000044367/child/actionAttribute

リクエスト本文の例

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

{
"AttributeName" : "Subject",
"AttributeValueContextCd" : "ORA_SVC_CUSTOM",
"DeletedFlag" : "N",
"UsageCd" : "ORA_SVC_CREATE"
}

レスポンス本文の例

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

{
"ActionAttributeId": 300100118913154,
"ActionId": 300100118621756,
"AttributeName": "Subject",
"AttributeValue": null,
"AttributeValueContextCd": "ORA_SVC_CUSTOM",
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-09-27T12:58:24+00:00",
"DeletedFlag": false,
"LastUpdateDate": "2017-09-27T12:58:24.014+00:00",
"LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F",
"LastUpdatedBy": "SALES_ADMIN",
"UsageCd": "ORA_SVC_CREATE",
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
}

「トップに戻る」