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

機械翻訳について

取引チーム・メンバーを更新

patch

/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources/{DealResourceId}

リクエスト

パス・パラメータ

DealResourceId(required): integer(int64)

ディール・チーム・メンバーの一意の識別子。
dealsUniqID(required): string

これは、ディール登録リソースのコンポジット・キーを構成し、ディール登録のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはディール登録の特定のインスタンスに移動してハッシュ・キーを取得するために、ディール登録コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

ディール・チーム・メンバーのアクセス・レベルを示すコード。たとえば、表示のみ、編集または完全です。有効な値のリストは、参照ORA_MKL_DEAL_ACCESS_LEVELで定義されます。
DealId: integer (int64)

ディール登録の一意の識別子。
DealResourceId: integer (int64)

ディール・チーム・メンバーの一意の識別子。
MemberFunctionCode: string

タイトル: Function

最大長: 30

ディール・チーム・メンバーの機能を示すコード。たとえば、チャネル・マネージャ、エンジニアリング所有者、エグゼクティブ・スポンサ、プライマリ営業担当、製品スペシャリスト、サポート・アカウント・マネージャ、テクニカル・アカウント・マネージャ、テクニカル・マーケティング・マネージャ、テクニカル・スペシャリストなどです。有効な値のリストは、参照ZCA_RESOURCE_FUNCTIONで定義されます。
OwnerFlag: boolean

タイトル: Owner

ディール・チーム・メンバーがディール登録の所有者であるかどうかを示します。
PartnerOrgId: integer (int64)

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

従業員リソースの一意の識別子。
ResourceUsername: string

タイトル: User Name

ディール登録に関連付けられているディール・チーム・メンバーのログイン・ユーザー名。

{
    "type":"object",
    "properties":{
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the employee resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealResourceId":{
            "type":"integer",
            "description":"The unique identifier of the deal team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the deal team member is the owner of the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceUsername":{
            "title":"User Name",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : deals-DealResources-item-response

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

最大長: 30

ディール・チーム・メンバーのアクセス・レベルを示すコード。たとえば、表示のみ、編集または完全です。有効な値のリストは、参照ORA_MKL_DEAL_ACCESS_LEVELで定義されます。
CreatedBy: string

読取り専用: true

最大長: 64

取引チーム・メンバー・レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

取引チーム・メンバー・レコードが作成された日時。
DealId: integer (int64)

ディール登録の一意の識別子。
DealNumber: string

タイトル: Registration Number

最大長: 30

ディール・リソース・チームのディール登録の公開一意識別子
DealResourceId: integer (int64)

ディール・チーム・メンバーの一意の識別子。
EmailAddress: string

タイトル: Email

読取り専用: true

最大長: 320

ディール登録に関連付けられているディール・チーム・メンバーのEメール・アドレス。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

取引交渉登録に関連付けられている取引チーム・メンバーの電話番号。
LastUpdateDate: string (date-time)

読取り専用: true

取引チーム・メンバー・レコードが最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

取引チーム・メンバー・レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

取引チーム・メンバー・レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Function

最大長: 30

ディール・チーム・メンバーの機能を示すコード。たとえば、チャネル・マネージャ、エンジニアリング所有者、エグゼクティブ・スポンサ、プライマリ営業担当、製品スペシャリスト、サポート・アカウント・マネージャ、テクニカル・アカウント・マネージャ、テクニカル・マーケティング・マネージャ、テクニカル・スペシャリストなどです。有効な値のリストは、参照ZCA_RESOURCE_FUNCTIONで定義されます。
OwnerFlag: boolean

タイトル: Owner

ディール・チーム・メンバーがディール登録の所有者であるかどうかを示します。
PartnerOrgId: integer (int64)

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

従業員リソースの一意の識別子。
ResourceName: string

タイトル: Name

読取り専用: true

最大長: 360

取引交渉登録に関連付けられている取引チーム・メンバーの名前。
ResourcePartyNumber: string

タイトル: Resource Number

読取り専用: true

最大長: 30

ディール・リソース・チームのリソース・パーティの公開一意識別子
ResourceUsername: string

タイトル: User Name

ディール登録に関連付けられているディール・チーム・メンバーのログイン・ユーザー名。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the deal team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the deal team member record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the deal team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the deal team member associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Deal Registration on the Deal Resource Team",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the deal team member is the owner of the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "ResourceUsername":{
            "title":"User Name",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the employee resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealResourceId":{
            "type":"integer",
            "description":"The unique identifier of the deal team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Resource Party on the Deal Resource Team",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.",
            "nullable":true,
            "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"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the deal team member record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the deal team member 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."
        }
    }
}

リンク

AccessLevelCodesVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

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

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

MemberFunctionCodesVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DZCA_RESOURCE_FUNCTION

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

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによって、ディール・チーム・メンバーを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/deals/300100071395747/child/DealResources/300100071407735

リクエスト本文の例

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

{
  "AccessLevelCode": "300"
}

レスポンス本文の例

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

{
  DealResourceId: 300100071407735
  DealId: 300100071395747
  ResourceId: 100000016934086
  AccessLevelCode: "300"
  ...
}

「トップに戻る」