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

パートナ・プログラムのプログラム特典の更新

patch

/crmRestApi/resources/11.13.18.05/partnerPrograms/{ProgramNumber}/child/ProgramBenefitDetails/{ProgramBenefitDetailId}

リクエスト

パス・パラメータ

ProgramBenefitDetailId(required): integer

システム生成の一意の識別子およびプログラム階層特典の主キー。
ProgramNumber(required): string

プログラムごとに生成される代替キー識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

BenefitListValue: string

プログラム特典の値タイプが「リスト」の場合のプログラム階層特典のリスト値。
BenefitValue: string

タイトル: Benefit Value

最大長: 150

プログラム階層の値には、プログラム・ベネフィットの値タイプに適した書式の利点があります。
TierId: integer (int64)

タイトル: Tier

プログラム階層特典が適用される階層の一意の識別子。

{
    "type":"object",
    "properties":{
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The unique identifier for a tier to which a program tier benefit applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.TierVO",
                "precision":18,
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TierId"
            }
        },
        "BenefitValue":{
            "title":"Benefit Value",
            "maxLength":150,
            "type":"string",
            "description":"The value of a program tier benefit in a format appropriate for the program benefit's value type.",
            "nullable":true,
            "x-hints":{
                "ExtnEventActionProperty":"UpdateInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "BenefitListValue":{
            "type":"string",
            "description":"The list value of the program tier benefit when the value type of program benefit is \"List\".",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : partnerPrograms-ProgramBenefitDetails-item-response

タイプ: object

ソースを表示

BenefitListValue: string

プログラム特典の値タイプが「リスト」の場合のプログラム階層特典のリスト値。
BenefitValue: string

タイトル: Benefit Value

最大長: 150

プログラム階層の値には、プログラム・ベネフィットの値タイプに適した書式の利点があります。
CategoryCode: string

タイトル: Category

読取り専用: true

最大長: 30

プログラム特典のカテゴリを示すコード。有効な値のリストは、参照ORA_ZPM_BENEFIT_CATEGORYで定義されます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Value Type

読取り専用: true

最大長: 30

プログラム特典の値タイプ。
DeleteFlag: boolean

読取り専用: true

プログラム特典を削除できるかどうかを示します。値がYの場合、プログラム特典は削除できます。デフォルト値はNです。
Description: string

タイトル: Benefits Description

読取り専用: true

最大長: 1000

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

タイトル: Last Updated Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Update Login

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Name

最大長: 155

プログラム階層特典の名前。
PartnerProgramId: integer (int64)

タイトル: Program

プログラム階層特典が追加されたパートナ・プログラムの一意の識別子。
ProgramBenefitDetailId: integer

タイトル: Program Benefit Details

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

タイトル: Benefit

プログラムまたはプログラム階層に追加されるプログラム・ベネフィットの一意の識別子。
TierId: integer (int64)

タイトル: Tier

プログラム階層特典が適用される階層の一意の識別子。
TierName: string

タイトル: Name

読取り専用: true

最大長: 155

プログラム階層特典が適用される階層の名前。
UpdateFlag: boolean

読取り専用: true

プログラム特典を更新できるかどうかを示します。値がYの場合、プログラム特典を更新できます。デフォルト値はNです。

{
    "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-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the category of the program benefit. A list of valid values is defined in the lookup ORA_ZPM_BENEFIT_CATEGORY.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Benefits Description",
            "maxLength":1000,
            "type":"string",
            "description":"The text describing the program benefit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier for the partner program to which the program tier benefit has been added.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.PartnerProgramsVO",
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"ProgramName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"PartnerProgramId"
            },
            "x-queryable":true
        },
        "BenefitListValue":{
            "type":"string",
            "description":"The list value of the program tier benefit when the value type of program benefit is \"List\".",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ProgramBenefitId":{
            "title":"Benefit",
            "type":"integer",
            "description":"The unique identifier for a program benefit added to a program or program tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.ProgramBenefitsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ProgramBenefitId"
            },
            "x-queryable":true
        },
        "BenefitValue":{
            "title":"Benefit Value",
            "maxLength":150,
            "type":"string",
            "description":"The value of a program tier benefit in a format appropriate for the program benefit's value type.",
            "nullable":true,
            "x-hints":{
                "ExtnEventActionProperty":"UpdateInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the program benefit can be deleted. If the value is Y, then the program benefit can be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the program benefit can be updated. If the value is Y, then the program benefit can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "TierId":{
            "title":"Tier",
            "type":"integer",
            "description":"The unique identifier for a tier to which a program tier benefit applies.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.partnerMgmt.partnerProgram.management.partnerProgramService.view.TierVO",
                "precision":18,
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_WHEREATTR":"TierId"
            },
            "x-queryable":true
        },
        "TierName":{
            "title":"Name",
            "maxLength":155,
            "type":"string",
            "description":"The name of a tier to which a program tier benefit applies.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DataType":{
            "title":"Value Type",
            "maxLength":30,
            "type":"string",
            "description":"The value type of the program benefit.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramBenefitDetailId":{
            "title":"Program Benefit Details",
            "type":"integer",
            "description":"The system-generated unique identifier and primary key of the program tier benefit.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ExtnEventActionProperty":"HideInFieldUpdate;",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the program benefit detail.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInFieldUpdate;HideInEmailTemplate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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."
        }
    }
}

リンク

BenefitCategoryCodes

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

財務、営業、マーケティングなど、パートナ・プログラムまたはプログラム階層特典のカテゴリを示す値リスト。

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

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

BenefitListTypeValues

操作: /crmRestApi/resources/11.13.18.05/benefitListTypeValuesLOV

プログラム・ベネフィットの値タイプがリストの場合のプログラムまたはプログラム階層ベネフィットを示す値リスト。リスト値は、福利厚生定義の一部としてユーザーによって事前に作成されています。

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

ソース属性: BenefitListValue;ターゲット属性: BenefitListTypeValId
表示属性: ValueName

福利厚生

操作: /crmRestApi/resources/11.13.18.05/partnerProgramBenefits

追加割引やウェルカム・キットなど、パートナ・プログラム・ベネフィット名を示す値リスト。即時利用可能な値がありません。福利厚生はユーザーが作成します。

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

ソース属性: 名前;ターゲット属性: 名前
表示属性: 名前

ProgramTiers

操作: /crmRestApi/resources/11.13.18.05/programTiersLOV

プラチナ、ゴールド、シルバーなど、プログラム階層特典が適用されるパートナ・プログラム階層を示す値リスト。階層はユーザーによって作成されます。

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

ソース属性: TierId;ターゲット属性: TierId
表示属性: 名前

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、パートナ・プログラムのプログラム特典を更新する方法を示しています。

cURLコマンド

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

リクエスト本文の例

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

{

  "BenefitValue": "123"

}

レスポンス本文の例

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

{
  "BenefitValue" : "123",
  "CreatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "CreationDate" : "2016-02-17T16:53:58-08:00",
  "LastUpdateDate" : "2016-02-17T17:05:35-08:00",
  "LastUpdatedBy" : "CHANNEL_OPERATIONS_MANAGER",
  "PartnerProgramId" : 300100071293754,
  "ProgramBenefitDetailId" : 300100071293762,
  "ProgramBenefitId" : 300100071293761,
...
}

「トップに戻る」