地理の取得
get
/crmRestApi/resources/11.13.18.05/geographiesLOV/{geographiesLOVUniqID}
リクエスト
パス・パラメータ
- geographiesLOVUniqID(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
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、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の値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : geographiesLOV-item-response
タイプ:
ソースを表示
object-
ActualContentSource: string
読取り専用:
true最大長:30地理のコンテンツ・ソース。 この属性は使用しないでください。 -
ChildId: number
読取り専用:
true子の一意の識別子。 この属性は使用しないでください。 -
ChildObjectType: string
読取り専用:
true最大長:30子オブジェクト・タイプ。 この属性は使用しないでください。 -
ChildTableName: string
読取り専用:
true最大長:30子表の名前。 この属性は使用しないでください。 -
ConflictId: integer (int64)
読取り専用:
true競合の一意の識別子。 この属性は使用しないでください。 -
CountryCode: string
タイトル:
Code読取り専用:true最大長:2地理に関連付けられた国コード。 この属性は使用しないでください。 -
CreatedBy: string
読取り専用:
true最大長:64レコードを作成したユーザー。 この属性は使用しないでください。 -
CreatedByModule: string
読取り専用:
true最大長:30作成者モジュール。 この属性は使用しないでください。 -
CreationDate: string (date-time)
読取り専用:
trueレコードが作成された日付。 この属性は使用しないでください。 -
EffectiveEndDate: 文字列(日付)
読取り専用:
trueレコードの有効終了日。 この属性は使用しないでください。 -
EffectiveStartDate: 文字列(日付)
読取り専用:
trueレコードの有効開始日。 この属性は使用しないでください。 -
EndDate: 文字列(日付)
タイトル:
End Date読取り専用:true地理の終了日。 この属性は使用しないでください。 -
GeographyId: integer (int64)
読取り専用:
trueサービスされる地理の一意の識別子。 -
GeographyName: string
タイトル:
Name読取り専用:true最大長:360サービスされる地理の名前。 -
GeographyType: string
タイトル:
Geography Type読取り専用:true最大長:30地理タイプ。 -
GeographyUse: string
読取り専用:
true最大長:30地理の使用。 この属性は使用しないでください。 -
HierarchyNodeId: integer (int64)
読取り専用:
true階層ノードの一意の識別子。 この属性は使用しないでください。 -
HierarchyType: string
読取り専用:
true最大長:30階層タイプ。 この属性は使用しないでください。 -
IdentifierType: string
読取り専用:
true最大長:30地理の識別子タイプ。 この属性は使用しないでください。 -
LastUpdateDate: string (date-time)
読取り専用:
trueレコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true最大長:64レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true最大長:32レコードを最後に更新したユーザーのログイン。 -
LevelNumber: number
読取り専用:
true地理のレベル番号。 この属性は使用しないでください。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true地理のオブジェクト・バージョン番号。 この属性は使用しないでください。 -
ParentId: number
読取り専用:
true親の一意の識別子。 この属性は使用しないでください。 -
ParentObjectType: string
読取り専用:
true最大長:30レコードの親オブジェクト・タイプ。 この属性は使用しないでください。 -
ParentTableName: string
読取り専用:
true最大長:30親表の名前。 この属性は使用しないでください。 -
RelationshipId: number
読取り専用:
true関係の一意の識別子。 この属性は使用しないでください。 -
StartDate: 文字列(日付)
タイトル:
Start Date読取り専用:true地理の開始日。 この属性は使用しないでください。 -
Status: string
読取り専用:
true最大長:1地理のステータス。 この属性は使用しないでください。 -
UserLastUpdateDate: string (date-time)
読取り専用:
trueユーザーがレコードを最後に更新した日付。 この属性は使用しないでください。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。