機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 営業テリトリ
  4. リソース

テリトリのすべてのリソースの取得

get

/crmRestApi/resources/11.13.18.05/territories/{TerritoryVersionId}/child/TerritoryResource

リクエスト

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

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

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

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

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • CheckDuplicateResourceId : 重複リソースのチェックの一意の識別子。
      ファインダ変数:
      • ResourceId; integer;リソースの一意の識別子。
    • PrimaryKey : 指定した主キーでテリトリのリソースを検索します。
      ファインダ変数:
      • TerrResourceId; integer;テリトリ・リソースの一意の識別子。
    • ResourceNumberFinder : 指定されたResourceNumberでテリトリのリソースを検索します。
      ファインダ変数:
      • ResourceNumber; string;テリトリ・リソースのレジストリID。
    • TerritoryResourceAltKeyFinder : テリトリ・リソースのレジストリ識別子。
      ファインダ変数:
      • ResourceNumber; string;テリトリ・リソースのレジストリID。
      • UniqueTerritoryNumber; string;テリトリ・リソースの一意のテリトリ番号。
    • TerritoryResourceEOIdBasedAltKey : リソース・マネージャからのリソースの一意の識別子。
      ファインダ変数:
      • ResourceId; integer; リソース・マネージャからのリソースの一意の識別子。
      • TerritoryVersionId; integer;テリトリ・バージョンの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string;テリトリ・チーム・メンバーを作成したユーザー。
    • CreationDate; string;テリトリ・チーム・メンバーが作成された日付。
    • 電子メール、文字列。テリトリ・チーム・メンバーの電子メール・アドレス。
    • LastUpdateDate; string;テリトリ・チーム・メンバーが最後に更新された日付。
    • LastUpdateLogin; string;テリトリ・チーム・メンバーを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string;テリトリ・チーム・メンバーを最後に更新したユーザー。
    • ManageForecastFlag; boolean;テリトリ・リソースがテリトリの所有者にかわってテリトリ予測を管理する職責を付与されているかどうかを示します。
    • Manager; string;マネージャの名前。
    • OrganizationName; string;組織の名前。
    • ResourceId; integer; リソース・マネージャからのリソースの一意の識別子。
    • ResourceName; string;テリトリに関連付けられたリソースの名前。
    • ResourceNumber; string;テリトリ・チーム・メンバーのレジストリID。
    • TerrResourceId; integer;テリトリ・リソースの一意の識別子。
    • TerritoryVersionId; integer;テリトリ・バージョンの一意の識別子。
    • UniqueTerritoryNumber; string;テリトリ・チーム・メンバーの一意のテリトリ番号。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : territories-TerritoryResource
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : territories-TerritoryResource-item-response
タイプ: object
ソースを表示
  • タイトル: Team Member Administrator
    最大長: 1
    リソースがテリトリの管理者であるかどうかを示します。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    テリトリ・チーム・メンバーを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    テリトリ・チーム・メンバーが作成された日付。
  • タイトル: Email
    読取り専用: true
    最大長: 320
    テリトリ・チーム・メンバーのEメール・アドレス。
  • タイトル: Team Member Function
    最大長: 30
    テリトリに関連付けられたリソースの機能のコード。
  • タイトル: Last Updated Date
    読取り専用: true
    テリトリ・チーム・メンバーが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    テリトリ・チーム・メンバーを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    テリトリ・チーム・メンバーを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Forecasting Delegate
    最大長: 1
    テリトリ・リソースに、テリトリの所有者の代理でテリトリ予測を管理する職責が付与されているかどうかを示します。
  • 読取り専用: true
    最大長: 360
    マネージャの名前。
  • タイトル: Organization
    読取り専用: true
    最大長: 240
    組織の名前。
  • タイトル: Owner
    読取り専用: true
    テリトリ・チーム・メンバーが所有者かどうかを示します。
  • タイトル: Resource ID
    リソース・マネージャからのリソースの一意の識別子。
  • タイトル: Resource Name
    読取り専用: true
    最大長: 360
    テリトリに関連付けられたリソースの名前。
  • タイトル: Resource Registry ID
    読取り専用: true
    最大長: 30
    テリトリ・チーム・メンバーのレジストリID。
  • タイトル: Team Member Role
    読取り専用: true
    最大長: 60
    リソースに関連付けられているチーム・メンバー・ロールの名前。
  • タイトル: Territory Version ID
    テリトリ・バージョンの一意の識別子。
  • タイトル: Territory Resource ID
    テリトリ・リソースの一意の識別子。
  • タイトル: Unique Territory Number
    最大長: 30
    テリトリ・チーム・メンバーの一意のテリトリ番号。
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/territories/300100025000830/child/TerritoryResource

リクエスト本文の例

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

Content-Type: NA

レスポンス本文の例

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

{
items: [2]
 0:  
  {
   TerrResourceId: 300100025000832
   ResourceId: 100010037456577
   ResourceName: "Joe Buendia"
   TerritoryVersionId: 300100025000830
   OwnerFlag: "false"
   FunctionCode: null
   OrganizationName: "EMEA"
   RoleName: "Sales Vice President"
   ...
}
「トップに戻る」