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

機械翻訳について

プログラム特典の作成

post

/crmRestApi/resources/11.13.18.05/partnerProgramBenefits

リクエスト

ヘッダー・パラメータ

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

ソースを表示

BenefitListTypeValues: array Benefit List Values

タイトル: Benefit List Values

福利厚生リスト値リソースは、プログラム特典をパートナ・プログラムに関連付けるために必要な福利厚生リスト値を表示、作成、更新および削除するために使用します。
CategoryCode: string

タイトル: Category

最大長: 30

特典のカテゴリを示すコード。たとえば、Financial、Sales、Marketingなどです。
DataType(required): string

タイトル: Value Type

最大長: 30

特典の値タイプ。たとえば、パーセント、金額またはテキストです。
Description: string

タイトル: Description

最大長: 1000

特典を説明するテキスト。
Name(required): string

タイトル: Name

最大長: 155

パートナ・プログラム特典の名前。
ProgramBenefitId: integer (int64)

システム生成の一意の識別子および特典の主キー。

{
    "required":[
        "DataType",
        "Name"
    ],
    "type":"object",
    "properties":{
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the benefit. For example, Financial, Sales, or Marketing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the benefit. For example, Percent, Amount, or Text.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the benefit.",
            "nullable":true
        },
        "BenefitListTypeValues":{
            "title":"Benefit List Values",
            "type":"array",
            "description":"The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.",
            "items":{
                "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-post-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the partner program benefit.",
            "nullable":false
        }
    }
}

ネストされたスキーマ : 福利厚生リスト値

タイプ: array

タイトル: Benefit List Values

福利厚生リスト値リソースは、プログラム特典をパートナ・プログラムに関連付けるために必要な福利厚生リスト値を表示、作成、更新および削除するために使用します。

ソースを表示

Array of: object schema

{
    "title":"Benefit List Values",
    "type":"array",
    "description":"The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.",
    "items":{
        "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-post-request"
    }
}

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

タイプ: object

ソースを表示

BenefitListTypeValId: integer (int64)

システム生成の一意の識別子および特典の主キー。
ProgramBenefitId: integer (int64)

プログラム特典の一意の識別子。
ValueName: string

タイトル: Value

最大長: 155

福利厚生リスト・タイプ値の名前。

{
    "type":"object",
    "properties":{
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The unique identifier of the program benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BenefitListTypeValId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ValueName":{
            "title":"Value",
            "maxLength":155,
            "type":"string",
            "description":"The name of the benefit list type value.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : partnerProgramBenefits-item-response

タイプ: object

ソースを表示

BenefitListTypeValues: array Benefit List Values

タイトル: Benefit List Values

福利厚生リスト値リソースは、プログラム特典をパートナ・プログラムに関連付けるために必要な福利厚生リスト値を表示、作成、更新および削除するために使用します。
CategoryCode: string

タイトル: Category

最大長: 30

特典のカテゴリを示すコード。たとえば、Financial、Sales、Marketingなどです。
CreatedBy: string

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

行が作成された日時。
DataType: string

タイトル: Value Type

最大長: 30

特典の値タイプ。たとえば、パーセント、金額またはテキストです。
DeleteFlag: boolean

読取り専用: true

特典を削除できるかどうかを示します。デフォルト値はtrueです。
Description: string

タイトル: Description

最大長: 1000

特典を説明するテキスト。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LastUpdatedByName: string

タイトル: Updater Name

読取り専用: true

行を最後に更新したユーザーの名前。
LastUpdateLogin: string

読取り専用: true

最大長: 32

プログラム特典を最後に更新したユーザーのログイン詳細。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 155

パートナ・プログラム特典の名前。
ProgramBenefitId: integer (int64)

システム生成の一意の識別子および特典の主キー。
UpdateFlag: boolean

読取り専用: true

特典を更新できるかどうかを示します。デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the benefit. For example, Financial, Sales, or Marketing.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the benefit.",
            "nullable":true,
            "x-queryable":true
        },
        "BenefitListTypeValues":{
            "title":"Benefit List Values",
            "type":"array",
            "description":"The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.",
            "items":{
                "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-response"
            }
        },
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the benefit can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the partner program benefit.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the benefit can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the benefit. For example, Percent, Amount, or Text.",
            "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"
            }
        },
        "LastUpdatedByName":{
            "title":"Updater Name",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the program benefit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : 福利厚生リスト値

タイプ: array

タイトル: Benefit List Values

ソースを表示

Array of: object partnerProgramBenefits-BenefitListTypeValues-item-response

{
    "title":"Benefit List Values",
    "type":"array",
    "description":"The benefit list values resource is used to view, create, update, and delete the benefit list values that are required to associate a program benefit with a partner program.",
    "items":{
        "$ref":"#/components/schemas/partnerProgramBenefits-BenefitListTypeValues-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

ネストされたスキーマ : partnerProgramBenefits-BenefitListTypeValues-item-response

タイプ: object

ソースを表示

BenefitListTypeValId: integer (int64)

システム生成の一意の識別子および特典の主キー。
CreatedBy: string

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

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

読取り専用: true

福利厚生リスト・タイプ値を削除する必要があるかどうかを示します。値がtrueの場合、福利厚生リスト・タイプ値を削除できます。デフォルト値はtrueです。
LastUpdateDate: string (date-time)

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ProgramBenefitId: integer (int64)

プログラム特典の一意の識別子。
UpdateFlag: boolean

読取り専用: true

福利厚生リスト・タイプ値を更新できるかどうかを示します。値がtrueの場合は、福利厚生リスト・タイプの値を更新できます。デフォルト値はtrueです。
ValueName: string

タイトル: Value

最大長: 155

福利厚生リスト・タイプ値の名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the benefit list type value can be updated. If the value is true, then the benefit list type value can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ValueName":{
            "title":"Value",
            "maxLength":155,
            "type":"string",
            "description":"The name of the benefit list type value.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramBenefitId":{
            "type":"integer",
            "description":"The unique identifier of the program benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BenefitListTypeValId":{
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the benefit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the benefit list type value should be deleted. If the value is true, then the benefit list type value can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

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

リンク

BenefitCategoryCodes

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZPM_BENEFIT_CATEGORY%2CBindLookupCode%3D{CategoryCode}

財務、営業またはマーケティングなど、特典のカテゴリを示す値リスト。

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

ソース属性: CategoryCode;ターゲット属性: LookupCode
表示属性: 意味

BenefitDataTypes

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZPM_BENEFIT_DATA_TYPE%2CBindLookupCode%3D{DataType}

金額、リスト、数値、パーセント、テキストなど、福利厚生の値タイプを示す値リスト。

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

ソース属性: DataType;ターゲット属性: LookupCode
表示属性: 意味

BenefitListTypeValues

操作: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits/{ProgramBenefitId}/child/BenefitListTypeValues

パラメータ:

ProgramBenefitId: $request.path.ProgramBenefitId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行することによってプログラム・ベネフィットを作成する方法を示しています。

cURLコマンド

curl -v -u Username:Password -H "content-type:application/vnd.oracle.adf.resourceitem+json" -X POST "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/partnerProgramBenefits/" -d '{request_payload}'

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "Name":"Discount Sale",
    "DataType":"ORA_NUMBER"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "ProgramBenefitId" : 300100071293747,
  "DataType" : "ORA_NUMBER",
  "Name" : "Discount Sale",
  "Description" : "".
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T12:28:14-08:00",
  "LastUpdateDate" : "2016-02-17T12:28:14-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "DeleteFlag" : "true",
  "UpdateFlag" : "true",
...
}

「トップに戻る」