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

機械翻訳について

すべての商談チームを取得

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityTeam

リクエスト

パス・パラメータ

OptyNumber(required): string

商談の一意の代替識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 1人の商談チーム・メンバーを取得するための結合キー。
  ファインダ変数:
  - OptyId; integer; 商談チームに関連付けられている商談の一意の識別子。
  - ResourceId; integer; 商談チームのあるリソースの一意の識別子。
  - TerritoryVersionId; integer;商談チームのあるテリトリ・バージョンの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AccessLevelCode; string; リソース階層内の組織の商談チーム・メンバー、マネージャおよび管理者に付与されるアクセス・レベル。
- AsgnTerrBasedInd; string; テリトリが自動テリトリ・ベース割当を使用して割り当てられることを示します。
- AsgnTerritoryVersionId; integer;テリトリ・ベース割当を介して商談に割り当てられたリソースのテリトリのバージョン識別子。
- City; string;リソースの市。
- ConflictId; integer; この値は、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成された場合に、行の一意性を保証するために使用されます。
- Country; string;リソースの国コード。
- CreatedBy; string; 商談リソース・レコードを作成したユーザー。
- CreationDate; string;商談リソース・レコードの作成日時。
- DealExpirationDate; string; 商談チーム・メンバーのディール保護期間の終了日。この日付は、テリトリ再編成のために商談から削除されたテリトリのメンバーに対して設定されます。
- DealProtectedDate; string; 商談チーム・メンバーのディール保護期間の開始日。この日付は、テリトリ再編成のために商談から削除されたテリトリのメンバーに対して設定されます。
- EmailAddress; string;リソースの電子メール・アドレス。
- ForecastParticipationCode; string;テリトリの予測参加タイプ。
- FunctionCode; string;テリトリ・チーム・メンバーの機能またはロールのコード。
- LastUpdateDate; string;商談リソース・レコードの最終更新日時。
- LastUpdateLogin; string; 商談リソース・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
- LastUpdatedBy; string; 商談リソース・レコードを最後に更新したユーザー。
- LockAssignmentFlag;ブール。自動割当によって商談チーム・メンバーをチームから削除できるかどうかを示します。
- MemberFunctionCode; string; インテグレータ、エグゼクティブ・スポンサ、テクニカル・アカウント・マネージャなど、商談におけるチーム・メンバーのロール。
- OptyId; integer;商談の一意の識別子。
- OptyNumber; string; 商談チームに関連付けられている商談の代替の一意の識別子。
- OptyResourceId; integer;商談リソースの一意の識別子。
- OptyResourceNumber;文字列。商談とリソース(通常は商談営業チーム・メンバー)との関連を表示するラベル。
- PartnerOrgId; integer;パートナ・リソースが属するパートナ組織の一意のパーティ識別子。
- PartnerPartyName; string; パートナ・リソースが属するパートナ組織の名前。
- PartyName; string;商談チーム・メンバーの氏名。
- PersonFirstName; string;商談チーム・メンバーの名。
- PersonLastName; string;商談チーム・メンバーの姓。
- PrimaryPhoneNumber; string; リソースのプライマリ書式の電話番号。
- ResourceId; integer;リソースの一意の識別子。
- ResourcePartyNumber; string;商談チーム・メンバーのリソース・パーティ番号。
- State; string;リソースの状態。
- TerritoryFunctionCode; string;テリトリのビジネス機能のコード。
- TerritoryName; string;テリトリの名前。
- TerritoryVersionId; integer;テリトリ・ベース割当を介して商談に割り当てられたリソースのテリトリの一意のバージョン識別子。
- TypeCode; string;テリトリのタイプのコード。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : opportunities-OpportunityTeam

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

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

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OpportunityTeam-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object opportunities-OpportunityTeam-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OpportunityTeam-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"
    }
}

ネストされたスキーマ : opportunities-OpportunityTeam-item-response

タイプ: object

ソースを表示

AccessLevelCode: string

タイトル: Access

読取り専用: true

最大長: 30

リソース階層内の組織の商談チーム・メンバー、マネージャおよび管理者に付与されるアクセス・レベル。
AsgnTerrBasedInd: string

読取り専用: true

最大長: 1

テリトリが自動テリトリ・ベース割当を使用して割り当てられていることを示します。
AsgnTerritoryVersionId: integer (int64)

タイトル: Territory

読取り専用: true

テリトリ・ベース割当を介して商談に割り当てられたリソースのテリトリのバージョン識別子。
AssignmentType: string

タイトル: Assignment Type

読取り専用: true

リソースが商談チームに追加される方法を示します。たとえば、アドホックは、リソースが手動またはルール・ベース割当によって追加されることを示します。テリトリは、テリトリ・ベース割当を介してリソースが追加されることを意味します。
City: string

タイトル: City

読取り専用: true

最大長: 60

リソースの市区町村。
ConflictId: integer (int64)

読取り専用: true

デフォルト値: 0

この値は、モバイル・データベースやサーバーなどの異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用されます。
Country: string

タイトル: Country

読取り専用: true

最大長: 2

リソースの国コード。
CreatedBy: string

読取り専用: true

最大長: 64

商談リソース・レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

商談リソース・レコードの作成日時。
DealExpirationDate: 文字列(日付)

タイトル: Deal Protected to Date

読取り専用: true

商談チーム・メンバーのディール保護期間の終了日。この日付は、テリトリ再編成のために商談から削除されたテリトリのメンバーに対して設定されます。
DealProtectedDate: 文字列(日付)

タイトル: Deal Protected from Date

読取り専用: true

商談チーム・メンバーのディール保護期間の開始日。この日付は、テリトリ再編成のために商談から削除されたテリトリのメンバーに対して設定されます。
EmailAddress: string

読取り専用: true

最大長: 320

リソースのEメール・アドレス。
ForecastParticipationCode: string

タイトル: Enable Forecasting

読取り専用: true

最大長: 30

デフォルト値: REVENUE

テリトリの予測参加タイプ。
FormattedPhoneNumber: string

タイトル: Primary Phone

読取り専用: true

商談チーム・メンバーの書式設定された電話番号。
FunctionCode: string

タイトル: Function

読取り専用: true

最大長: 30

テリトリ・チーム・メンバーの機能またはロールのコード。
LastUpdateDate: string (date-time)

読取り専用: true

商談リソース・レコードの最終更新日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

商談リソース・レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

商談リソース・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
links: array Links

タイトル: Links

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

タイトル: Lock Assignment

読取り専用: true

最大長: 1

デフォルト値: true

自動割当によって商談チーム・メンバーをチームから削除できるかどうかを示します。
MemberFunctionCode: string

タイトル: Function

読取り専用: true

最大長: 30

インテグレータ、エグゼクティブ・スポンサ、テクニカル・アカウント・マネージャなど、商談のチーム・メンバーのロール。
OptyId: integer (int64)

商談の一意の識別子。
OptyNumber: string

タイトル: Opportunity Number

読取り専用: true

最大長: 30

商談チームに関連付けられている商談の代替の一意の識別子。
OptyResourceId: integer (int64)

タイトル: Opportunity Resource ID

読取り専用: true

商談リソースの一意の識別子。
OptyResourceNumber: string

タイトル: Opportunity Resource Number

読取り専用: true

最大長: 30

商談とリソース(通常は商談営業チーム・メンバー)間の関連を表示するラベル。
OptyTeamId: string

読取り専用: true

最大長: 255

商談チーム・メンバーを識別する一意のキー。
OwnerFlag: boolean

タイトル: Primary

読取り専用: true

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

読取り専用: true

パートナ・リソースが属するパートナ組織の一意のパーティ識別子。
PartnerPartyName: string

読取り専用: true

最大長: 360

パートナ・リソースが属するパートナ組織の名前。
PartyName: string

タイトル: Name

読取り専用: true

最大長: 360

商談チーム・メンバーの正式名。
PersonFirstName: string

タイトル: First Name

読取り専用: true

最大長: 150

商談チーム・メンバーの名。
PersonLastName: string

タイトル: Last Name

読取り専用: true

最大長: 150

商談チーム・メンバーの姓。
PrimaryPhoneNumber: string

読取り専用: true

最大長: 40

リソースのプライマリ書式付き電話番号。
ResourceId: integer (int64)

リソースの一意の識別子。
ResourcePartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

商談チーム・メンバーのリソース・パーティ番号。
RoleName: string

読取り専用: true

最大長: 255

リソースのロール。
State: string

タイトル: State

読取り専用: true

最大長: 60

リソースの状態。
TerritoryFunctionCode: string

タイトル: Territory Function

読取り専用: true

最大長: 30

テリトリのビジネス機能のコード。
TerritoryName: string

タイトル: Territory Name

読取り専用: true

最大長: 60

テリトリの名前。
TerritoryOwnerFlag: boolean

読取り専用: true

商談チーム・メンバーがテリトリ所有者であるかどうかを示します。
TerritoryVersionId: integer (int64)

テリトリ・ベース割当を介して商談に割り当てられたリソースのテリトリの一意のバージョン識別子。
TypeCode: string

タイトル: Type

読取り専用: true

最大長: 30

デフォルト値: PRIME

テリトリ・タイプのコード。

{
    "type":"object",
    "properties":{
        "TerritoryName":{
            "title":"Territory Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the territory.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time of the creation of the opportunity resource record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The access level granted to the opportunity team member, manager, and administrator of the organizations in the resource hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The full name of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AsgnTerrBasedInd":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the territory is assigned using automatic territory-based assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases, such as mobile databases or the server.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealProtectedDate":{
            "title":"Deal Protected from Date",
            "type":"string",
            "description":"The start date of the deal protection period of an opportunity team member. This date is set for the members of territories that are removed from opportunity because of territory realignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerPartyName":{
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner organization that the partner resource belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity team member is the territory owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyResourceNumber":{
            "title":"Opportunity Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The label displaying the association between an opportunity and a resource (typically an opportunity sales team member).",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyResourceId":{
            "title":"Opportunity Resource ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerritoryFunctionCode":{
            "title":"Territory Function",
            "maxLength":30,
            "type":"string",
            "description":"The code of the business function of the territory.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique party identifier of the partner organization that the partner resource belongs to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The resource party number of the opportunity team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number for the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the opportunity associated with the opportunity team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the opportunity resource record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the type of the territory.",
            "nullable":false,
            "readOnly":true,
            "default":"PRIME",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates whether the opportunity team member is the owner of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code of the function or role of the territory team member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "DealExpirationDate":{
            "title":"Deal Protected to Date",
            "type":"string",
            "description":"The end date of the deal protection period of an opportunity team member. This date is set for members of territories that are removed from the opportunity because of territory realignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Enable Forecasting",
            "maxLength":30,
            "type":"string",
            "description":"The forecast participation type of the territory.",
            "nullable":true,
            "readOnly":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleName":{
            "maxLength":255,
            "type":"string",
            "description":"The role of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The primary formatted phone number for the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "OptyTeamId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique key to identify the opportunity team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"Indicates how the resource is added to the opportunity team, for example Ad-Hoc means resource is added manually or through rule-based assignment. Territory means resource is added through territory-based assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The role of the team member on the opportunity, such as Integrator, Executive Sponsor, Technical Account Manager.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LockAssignmentFlag":{
            "title":"Lock Assignment",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an opportunity team member can be removed from the team by automatic assignment.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "AsgnTerritoryVersionId":{
            "title":"Territory",
            "type":"integer",
            "description":"Version identifier of the territory for the resource that got assigned to the opportunity through territory-based assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time of the last update of the opportunity resource record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the opportunity resource 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."
        }
    }
}

トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべての商談チームを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

レスポンス本文の例

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

{
    "items": [
        {
            "OptyId": 300100564137678,
            "ResourceId": 100010025532672,
            "TerritoryVersionId": null,
            "PersonFirstName": "Gabrielle ",
            "PersonLastName": " Lee",
            "PrimaryPhoneNumber": "5066601",
            "EmailAddress": "sendmail-test-discard@oracle.com",
            "TerritoryName": null,
            "TypeCode": null,
            "TerritoryOwnerFlag": "false",
            "FunctionCode": null,
            "TerritoryFunctionCode": null,
            "ForecastParticipationCode": null,
            "AccessLevelCode": "300",
            "OptyResourceId": 300100564137680,
            "AssignmentType": "Ad hoc assignment",
            "LockAssignmentFlag": true,
            "AsgnTerrBasedInd": null,
            "Country": "US",
            "State": "CA",
            "City": "Belmont",
            "RoleName": null,
            "OptyTeamId": "300100564137678_100010025532672__300100564137680",
            "DealProtectedDate": null,
            "DealExpirationDate": null,
            "MemberFunctionCode": "INTEGRATOR",
            "OwnerFlag": true,
            "ConflictId": 0,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-10-28T03:49:50.836+00:00",
            "LastUpdatedBy": "SALES_ADMIN",
            "LastUpdateDate": "2022-10-28T03:49:57.983+00:00",
            "LastUpdateLogin": "EB853827FF440A52E053773AF80A4A5C",
            "FormattedPhoneNumber": "+1 (650) 506-6601",
            "PartnerOrgId": null,
            "OptyResourceNumber": "CDRM_138216",
            "ResourcePartyNumber": "100010025532672",
            "OptyNumber": "CDRM_152510",
            "PartnerPartyName": null,
            "AsgnTerritoryVersionId": null,
            "PartyName": "Gabrielle   Lee",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF",
                    "name": "OpportunityTeam",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF",
                    "name": "OpportunityTeam",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510",
                    "name": "opportunities",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TerritoryFunctionLOVViewAccessor",
                    "name": "TerritoryFunctionLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TeamMemberFunctionLOVViewAccessor",
                    "name": "TeamMemberFunctionLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/AccessLevelLOVViewAccessor",
                    "name": "AccessLevelLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TerritoryTypeLOVViewAccessor",
                    "name": "TerritoryTypeLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/TerrFcastParticipationLOVViewAccessor",
                    "name": "TerrFcastParticipationLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/MemberFunctionCodeLOVViewAccessor",
                    "name": "MemberFunctionCodeLOVViewAccessor",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam/00030000000EACED00057708000110F09B85B6CE0000000EACED0005770800005AF5660BBD00FFFFFFFF/lov/AssignmentTypeLOVViewAccessor",
                    "name": "AssignmentTypeLOVViewAccessor",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_152510/child/OpportunityTeam",
            "name": "OpportunityTeam",
            "kind": "collection"
        }
    ]
}

「トップに戻る」