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

機械翻訳について

パートナのパートナ取引先チーム・メンバーの更新

patch

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}

リクエスト

パス・パラメータ

CompanyNumber(required): string

パートナの会社の代替キー識別子。
PartnerAccountResourceId(required): integer(int64)

パートナを所有するパーティの一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

デフォルト値: 300

リソースに付与されたアクセス権のタイプと組織のマネージャを示すコード。受け入れられる値のリストは、参照ZCA_ACCESS_LEVELで定義されます。「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
AssignmentTypeCode: string

タイトル: Assignment Type

最大長: 30

デフォルト値: MANUAL

リソースがパートナ・リソース・チームにどのように割り当てられるかを示すコード。受け入れられる値のリストは、参照ZCA_ASSIGNMENT_TYPEで定義されます。「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
MemberFunctionCode: string

タイトル: Function

最大長: 30

インテグレータ、エグゼクティブ・スポンサ、技術アカウント・マネージャなど、リソース・チームの営業チーム・メンバーのロールを示すコード。受け入れられる値のリストは、参照FND_LOOKUPSで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
OrganizationRole: string

タイトル: Title

組織内のリソースのロール。
OwnerIndicator: string

パートナ取引先チーム・メンバーもこのパートナ・レコードの所有者かどうかを示します。

{
    "type":"object",
    "properties":{
        "OrganizationRole":{
            "title":"Title",
            "type":"string",
            "description":"The role of the resource in the organization.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "OwnerIndicator":{
            "type":"string",
            "description":"Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.",
            "nullable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"300",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"MANUAL"
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : partners-accountTeamMembers-item-response

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

デフォルト値: 300

リソースに付与されたアクセス権のタイプと組織のマネージャを示すコード。受け入れられる値のリストは、参照ZCA_ACCESS_LEVELで定義されます。「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
AssignmentTypeCode: string

タイトル: Assignment Type

最大長: 30

デフォルト値: MANUAL

リソースがパートナ・リソース・チームにどのように割り当てられるかを示すコード。受け入れられる値のリストは、参照ZCA_ASSIGNMENT_TYPEで定義されます。「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

リソースの電子メール・アドレス。
FormattedAddress: string

タイトル: Primary Address

読取り専用: true

住所の書式付きバージョン。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

リソースの電話番号。
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

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

タイトル: Function

最大長: 30

インテグレータ、エグゼクティブ・スポンサ、技術アカウント・マネージャなど、リソース・チームの営業チーム・メンバーのロールを示すコード。受け入れられる値のリストは、参照FND_LOOKUPSで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
OrganizationRole: string

タイトル: Title

組織内のリソースのロール。
OwnerIndicator: string

パートナ取引先チーム・メンバーもこのパートナ・レコードの所有者かどうかを示します。
PartnerAccountResourceId: integer (int64)

タイトル: Partner Account Resource ID

パートナを所有するパーティの一意の識別子。
PartnerCompanyNumber: string

タイトル: Partner Number

最大長: 30

パートナ会社の一意の識別子。
ResourceId: integer (int64)

タイトル: Account Team Member

リソースの販売プロファイルの一意の識別子。
ResourceName: string

タイトル: Name

読取り専用: true

最大長: 360

リソースの名前。
ResourcePartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

パートナ・アカウント・チームのリソースのパーティ番号。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the record 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerIndicator":{
            "type":"string",
            "description":"Indicates whether the Partner Account Team Member is also the owner of this Partner record or not.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"300",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The formatted version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyCountry",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "OrganizationRole":{
            "title":"Title",
            "type":"string",
            "description":"The role of the resource in the organization.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the resource is assigned to the partner resource team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":false,
            "default":"MANUAL",
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PartnerAccountResourceId":{
            "title":"Partner Account Resource ID",
            "type":"integer",
            "description":"The unique identifier of the party that owns the partner.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "title":"Account Team Member",
            "type":"integer",
            "description":"The unique identifier of the sale profile of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The party number for the resource of the partner account team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "="
                ],
                "dependencies":[
                    "PrimaryPhoneCountryCode",
                    "PrimaryPhoneAreaCode",
                    "PrimaryPhoneNumber",
                    "PrimaryPhoneExtension",
                    "PrimaryPhoneLineType",
                    "PrimaryPhoneContactPtId",
                    "PersonalPhoneFlag"
                ]
            }
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the partner company.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record 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 record.",
            "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."
        }
    }
}

リンク

accessLevelsLOV

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ACCESS_LEVEL%2CBindLookupCode%3D{AccessLevelCode}

参照リソースは、標準参照コードの表示に使用されます。

assignmentTypesLOV

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_ASSIGNMENT_TYPE%2CBindLookupCode%3D{AssignmentTypeCode}

参照リソースは、標準参照コードの表示に使用されます。

memberFunctionsLOV

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DZCA_RESOURCE_FUNCTION%2CBindLookupCode%3D{MemberFunctionCode}

参照リソースは、標準参照コードの表示に使用されます。

トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行して、パートナのパートナ・アカウント・チーム・メンバーを更新する方法を示しています。

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com /crmRestApi/resources/11.13.18.05/partners/100001/child/accountTeamMembers/300100003284977

リクエスト本文の例

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

{
   "OrganizationName" : "Acme, Inc.",
   "OrganizationRole" : "Global Account Manager",
   "TerritoryName" : "EMEA"
 }

レスポンス本文の例

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

{
  "PartnerAccountResourceId" : 300100003284977,
  "PartnerAccountId" : 100000020252061,
  "ResourceId" : 100010038017873,
  "PartnerPartyId" : 100000016934002,
  "OrganizationName" : "Acme, Inc.",
  "OrganizationRole" : "Global Account Manager",
  "TerritoryName" : "EMEA",
  "ResourceName" : "Account_MgrENT1 CAM",
  "AccessLevelCode" : "300",
  "AssignmentTypeCode" : "MANUAL",
  "MemberFunctionCode" : "CHANNEL_MGR",
  "EmailAddress" : "sendmail-test-discard@oracle.com",
  "FormattedPhoneNumber" : null,
  ...
}

「トップに戻る」