住所ロケールを取得
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
リクエスト
パス・パラメータ
- AddressNumber(required): string
作成中に内部的に生成された住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
- LocationLocaleId(required): integer(int64)
このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
- PartyNumber(required): string
アカウント・パーティの一意の代替識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。 デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。 非アクティブなレコードは更新できません。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : accounts-Address-AddressLocale-item-response
タイプ:
ソースを表示
object
-
AddrElementAttribute1: string
タイトル:
Address Element Attribute 1
最大長:150
フレキシブル住所書式をローカル言語でサポートする追加住所要素1。 -
AddrElementAttribute2: string
タイトル:
Address Element Attribute 2
最大長:150
フレキシブル住所書式をローカル言語でサポートする追加住所要素2。 -
AddrElementAttribute3: string
タイトル:
Address Element Attribute 3
最大長:150
フレキシブル住所書式をローカル言語でサポートする追加住所要素3。 -
AddrElementAttribute4: string
タイトル:
Address Element Attribute 4
最大長:150
フレキシブル住所書式をローカル言語でサポートする追加住所要素4。 -
AddrElementAttribute5: string
タイトル:
Address Element Attribute 5
最大長:150
フレキシブル住所書式をローカル言語でサポートする追加住所要素5。 -
Address1: string
タイトル:
Address Line 1
最大長:240
ローカル言語での住所の1行目。 -
Address2: string
タイトル:
Address Line 2
最大長:240
ローカル言語での住所の2行目。 -
Address3: string
タイトル:
Address Line 3
最大長:240
ローカル言語での住所の3行目。 -
Address4: string
タイトル:
Address Line 4
最大長:240
ローカル言語での住所の4行目。 -
AddressNumber: string
タイトル:
Site Number
読取り専用:true
最大長:30
作成中に内部的に生成される一意の住所識別子。 次のキーのいずれかを使用して、更新時に住所目的レコードを識別: AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValue。 -
Building: string
タイトル:
Building
最大長:240
ローカル言語での特定の住所の特定の建物名または番号。 -
City: string
タイトル:
City
最大長:60
市区町村の名前(現地言語)。 -
Country: string
タイトル:
Country
読取り専用:true
最大長:2
ローカル言語での国の特定の名前。 -
County: string
タイトル:
County
最大長:60
ローカル言語での郡の固有名。 -
CreatedBy: string
読取り専用:
true
最大長:64
住所ロケール・レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
住所ロケール・レコードが作成された日時。 -
FloorNumber: string
タイトル:
Floor
最大長:240
建物番号がローカル言語で提供されている場合、特定の住所または特定の建物における特定の階数。 -
FormattedAddress: string
読取り専用:
true
ロケール・アドレスの書式付き読取り専用バージョン。 -
LastUpdateDate: string (date-time)
読取り専用:
true
住所ロケールが最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
住所ロケール・レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
住所ロケール・レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LocationId: integer (int64)
事業所レコードの一意の識別子。
-
LocationLocaleId: integer (int64)
読取り専用:
true
事業所ロケール・レコードの一意の識別子。 -
PostalCode: string
タイトル:
Postal Code
最大長:60
ロケールの郵便番号。 郵便番号は、郵便番号、郵便番号、または郵便番号として様々な国で知られているもので、郵便を現地言語で並べ替える目的で、郵送先住所に追加される一連の文字または数字です。 -
PostalPlus4code: string
タイトル:
Postal Code Extension
最大長:20
ローカルの言語でのアメリカ合衆国郵便番号の4桁の拡張。 -
Province: string
タイトル:
Province
最大長:60
ローカル言語での都道府県名。 -
SiteSourceSystem: string
システム設定の一部として管理者が定義する、コードによって示される親住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
SiteSourceSystemReferenceValue: string
外部ソースからの親住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
State: string
タイトル:
State
最大長:60
ローカル言語での都道府県名。 -
TransliterationLanguage: string
タイトル:
Transliteration Language
最大長:4
翻訳言語は、外国語で単語や名前を発音するのに役立ちます。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。 サンプル値はUS、NL、DKです。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
リンク
- TransliterationLanguageLOV
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: TransliterationLanguage;ターゲット属性: LanguageCode
- 表示属性: 説明