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

商談売上テリトリの取得

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RevenueTerritory/{RevenueTerritoryUniqID}

リクエスト

パス・パラメータ

ChildRevenueUniqID(required): string

これは、収益アイテム・リソースの複合キーを構成し、収益アイテムのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、収益アイテムの特定のインスタンスに移動してハッシュ・キーを取得するために、収益アイテム・コレクション・リソースを問い合せる必要があります。
OptyNumber(required): string

商談の一意の代替識別子。
RevenueTerritoryUniqID(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
links: string

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

例:
self,canonical
onlyData: boolean

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

ヘッダー・パラメータ

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-ChildRevenue-RevenueTerritory-item-response

タイプ: object

ソースを表示

AssignmentType: string

タイトル: Assignment Type

読取り専用: true

最大長: 15

テリトリを商談に割り当てるために使用する割当のタイプ。
CreatedBy: string

読取り専用: true

最大長: 64

収益テリトリ・レコードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

レコードが作成された日付。
EffectiveEndDate: 文字列(日付)

テリトリへのリソース組織割当が終了する日付。
EffectiveStartDate: 文字列(日付)

テリトリのリソース組織が売上明細に割り当てられた日付。
ForecastParticipationCode: string

タイトル: Forecast Participation

読取り専用: true

最大長: 30

テリトリが参加する予測タイプを識別するコード。たとえば、Revenue、Nonrevenue、RevenueとNonrevenue、Nonforecastingなどです。
LastUpdateDate: string (date-time)

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Revenue Line Territory

読取り専用: true

最大長: 60

商談が属するテリトリの名前。
Name1: string

タイトル: Organization

テリトリ・リソースが属する組織の名前。
PartyId: integer (int64)

タイトル: Party ID

読取り専用: true

テリトリを所有するリソースの一意の識別子。
PartyName: string

タイトル: Owner

読取り専用: true

最大長: 360

商談のテリトリ所有者の名前。
RevnId: integer (int64)

売上の一意の識別子。
RevnTerrId: integer (int64)

収益テリトリの一意の識別子。
RoleId: integer

リソースのロールの一意の識別子。
RoleName: string

リソースのロールの名前。
TerritoryId: integer (int64)

テリトリの一意の識別子。
TerritoryVersionId: integer (int64)

テリトリ・バージョンの一意の識別子。
TypeCode: string

タイトル: Type

読取り専用: true

最大長: 30

商談に割り当てられたテリトリのタイプを示すコード。有効な値のリストは、参照MOT_TERRITORY_TYPEで定義されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryId":{
            "type":"integer",
            "description":"The unique identifier of the territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the revenue territory record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the resource organization assignment to the territory ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of territory assigned to the opportunity. A list of valid values is defined in the lookup MOT_TERRITORY_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the territory owner for the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevnTerrId":{
            "type":"integer",
            "description":"The unique identifier of the revenue territory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Revenue Line Territory",
            "maxLength":60,
            "type":"string",
            "description":"The name of the territory that the opportunity belongs to.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ForecastParticipationCode":{
            "title":"Forecast Participation",
            "maxLength":30,
            "type":"string",
            "description":"The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TerritoryVersionId":{
            "type":"integer",
            "description":"The unique identifier of the territory version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleName":{
            "type":"string",
            "description":"The name of the resource's role.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource who owns the territory.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevnId":{
            "type":"integer",
            "description":"The unique identifier of the revenue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":15,
            "type":"string",
            "description":"The type of assignment used to assign the territory to the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the resource organization for the territory was assigned to the revenue line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Name1":{
            "title":"Organization",
            "type":"string",
            "description":"The name of the organization that the territory resource belongs to.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the 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 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."
        }
    }
}

リンク

AssignmentTypeLOV

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOO_TERR_ASSIGNMENT_TYPE

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

TerritoryTypeViewAccessor

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOT_TERRITORY_TYPE%2CBindLookupCode%3D{TypeCode}

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

ValidForecastParticipationCodeViewAccessor

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeFinder%3BBindLookupType%3DORA_MOT_TERR_ENABLE_FCASTING

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

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、商談売上テリトリを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708/child/ChildRevenue/300100035601812/child/RevenueTerittory/300100111705895

レスポンス本文の例

  {
"RevenueTerritory":    [{
    "LastUpdatedBy": "SALES_ADMIN",
    "PartyId": 100010025532672,
    "LastUpdateLogin": "FCA9E6554A370579E043F700F40A2CB7",
  	  "TerritoryVersionId": 300100026005983, 					
	  "EffectiveStartDate": null,						
	  "PartyName": "Gabrielle Lee",				
     "CreationDate": "2014-06-25 06:24:46.946"",			
	  "RevnId": 300100035601812,					
	  "AssignmentType": "MANUAL",						
	  "RoleId": null,								
	  "RevnTerrId": 300100111705895,		
   	"RoleName": null,					
	  "Name": "APAC Child1",																												
     "LastUpdateDate": "2014-06-25 06:24:59.732",																	
	  "TypeCode": "PRIME",																																			
    "EffectiveEndDate": null,																														
    "ForecastParticipationCode": "REVENUE",																													
	  "CreatedBy": "SALES_ADMIN",																																		
    "TerritoryId": 300100026005982,																													
    "Name1": "",																																				
	 "version": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"																																																																																																																																													        							 } ]       																							
   }

「トップに戻る」