機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. 地理

すべての地理の取得

get

/crmRestApi/resources/11.13.18.05/geographiesLOV

リクエスト

問合せパラメータ
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey : 指定された地理識別子を持つ地理を検索します。
      ファインダ変数:
      • GeographyId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActualContentSource; string;地理のコンテンツ・ソース。 この属性は使用しないでください。
    • ChildId; number;子の一意の識別子。 この属性は使用しないでください。
    • ChildObjectType; string;子オブジェクト・タイプ。 この属性は使用しないでください。
    • ChildTableName; string;子表の名前。 この属性は使用しないでください。
    • ConflictId; integer;競合の一意の識別子。 この属性は使用しないでください。
    • CountryCode; string;地理に関連付けられた国コード。 この属性は使用しないでください。
    • CreatedBy; string; レコードを作成したユーザー。 この属性は使用しないでください。
    • CreatedByModule; string;モジュールによって作成されます。 この属性は使用しないでください。
    • CreationDate; string;レコードが作成された日付。 この属性は使用しないでください。
    • EffectiveEndDate; string;レコードの有効終了日。 この属性は使用しないでください。
    • EffectiveStartDate; string;レコードの有効開始日。 この属性は使用しないでください。
    • EndDate; string;地理の終了日。 この属性は使用しないでください。
    • GeographyId; integer;サービスされる地理の一意の識別子。
    • GeographyName; string;サービスされる地理の名前。
    • GeographyType; string;地理タイプ。
    • GeographyUse; string;地理の使用。 この属性は使用しないでください。
    • HierarchyNodeId; integer; 階層ノードの一意の識別子。 この属性は使用しないでください。
    • HierarchyType; string;階層型。 この属性は使用しないでください。
    • LastUpdateDate; string; レコードが最後に更新された日付。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • LevelNumber; number;地理のレベル番号。 この属性は使用しないでください。
    • ObjectVersionNumber; integer;地理のオブジェクト・バージョン番号。 この属性は使用しないでください。
    • ParentId; number;親の一意の識別子。 この属性は使用しないでください。
    • ParentObjectType; string;レコードの親オブジェクト・タイプ。 この属性は使用しないでください。
    • ParentTableName; string;親表の名前。 この属性は使用しないでください。
    • RelationshipId; number;関係の一意の識別子。 この属性は使用しないでください。
    • StartDate; string;地理の開始日。 この属性は使用しないでください。
    • ステータス、文字列、地理のステータス。 この属性は使用しないでください。
    • UserLastUpdateDate; string;ユーザーが最後にレコードを更新した日付。 この属性は使用しないでください。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : geographiesLOV
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : geographiesLOV-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    最大長: 30
    地理のコンテンツ・ソース。 この属性は使用しないでください。
  • 読取り専用: true
    子の一意の識別子。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    子オブジェクト・タイプ。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    子表の名前。 この属性は使用しないでください。
  • 読取り専用: true
    競合の一意の識別子。 この属性は使用しないでください。
  • タイトル: Code
    読取り専用: true
    最大長: 2
    地理に関連付けられた国コード。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 64
    レコードを作成したユーザー。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    作成者モジュール。 この属性は使用しないでください。
  • 読取り専用: true
    レコードが作成された日付。 この属性は使用しないでください。
  • 読取り専用: true
    レコードの有効終了日。 この属性は使用しないでください。
  • 読取り専用: true
    レコードの有効開始日。 この属性は使用しないでください。
  • タイトル: End Date
    読取り専用: true
    地理の終了日。 この属性は使用しないでください。
  • 読取り専用: true
    サービスされる地理の一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 360
    サービスされる地理の名前。
  • タイトル: Geography Type
    読取り専用: true
    最大長: 30
    地理タイプ。
  • 読取り専用: true
    最大長: 30
    地理の使用。 この属性は使用しないでください。
  • 読取り専用: true
    階層ノードの一意の識別子。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    階層タイプ。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    地理の識別子タイプ。 この属性は使用しないでください。
  • 読取り専用: true
    レコードが最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • 読取り専用: true
    地理のレベル番号。 この属性は使用しないでください。
  • Links
  • 読取り専用: true
    地理のオブジェクト・バージョン番号。 この属性は使用しないでください。
  • 読取り専用: true
    親の一意の識別子。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    レコードの親オブジェクト・タイプ。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 30
    親表の名前。 この属性は使用しないでください。
  • 読取り専用: true
    関係の一意の識別子。 この属性は使用しないでください。
  • タイトル: Start Date
    読取り専用: true
    地理の開始日。 この属性は使用しないでください。
  • 読取り専用: true
    最大長: 1
    地理のステータス。 この属性は使用しないでください。
  • 読取り専用: true
    ユーザーがレコードを最後に更新した日付。 この属性は使用しないでください。
「トップに戻る」