すべての住所の取得
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address
リクエスト
パス・パラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- AddressIdAltKey : 住所識別子を使用して住所を検索します。
ファインダ変数:- AddressId; integer; アドレスの一意の識別子。
- AddressNumberAltKey : 住所番号を使用して住所を検索します。
ファインダ変数:- AddressNumber; string; 作成中に内部的に生成されるアドレスの内部一意識別子。
- AddressNumberRF : 住所の一意の識別子を持つ住所を検索します。
ファインダ変数:- AddressNumber; string; 作成中に内部的に生成されるアドレスの内部一意識別子。
- PrimaryKey : 住所の主キー情報を含む住所を検索します。
ファインダ変数:- AddressId; integer; アドレスの一意の識別子。
- LocationId; integer; 場所の一意の識別子。
- SourceSystemReferenceAltKey : 住所のソース・システム情報を含む住所を検索します。
ファインダ変数:- SourceSystem; string; アドレスがインポートされる外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムで構成された値。
- SourceSystemReferenceValue; string; 属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
- AddressIdAltKey : 住所識別子を使用して住所を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- AddrElementAttribute1; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute2; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute3; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute4; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- AddrElementAttribute5; string;柔軟なアドレス形式をサポートするための追加のアドレス要素。
- Address1; string; アドレスの最初の行。
- Address2; string; addressの2行目。
- Address3; string; addressの3行目。
- Address4; string; addressの4行目。
- AddressId; integer; アドレスの一意の識別子。
- AddressLinesPhonetic; string;漢字アドレス行の表記またはカナ。 これは日本の住所に使用されます。
- AddressNumber; string; 作成中に内部的に生成されるアドレスの代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
- 建物;文字列;住所の建物名または番号。
- City; string;住所の市区町村。
- ClliCode; string;アドレスの共通言語のロケーション識別子(CLLI)コード。 このコードは、住所の所在地を指定するために北米内で使用されます。
- コメント;文字列;ユーザーが入力したアドレスに対するコメント。
- ConflictId; integer;競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
- CorpCurrencyCode; string; アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- Country; string;住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。
- 郡;文字列;住所の郡。
- CreatedBy; string; アカウント・レコードを作成したユーザー。
- CreatedByModule1; string; モジュールを作成したユーザー。
- CreationDate; string;レコードが作成された日付。
- CurcyConvRateType; string;通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- CurrencyCode; string;通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- DateValidated; string; アドレスが最後に検証された日付。
- 説明;文字列;ロケーションの説明。
- DoNotValidateFlag; boolean。現在の検証ステータス・コードに関係なく、特定のロケーションが住所検証に適格でないことを示します。
- DunsNumberC; string;事業所のD-U-N-S番号。
- EffectiveDate; string; アドレスがアクティブになる日付。
- EndDateActive; string; アドレスが非アクティブになる日付。
- FloorNumber; string;アドレスの階数。
- HouseType; string;アドレス内の建物のタイプ。 有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
- LastUpdateDate; string; レコードが最後に更新された日付。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 緯度;数値;住所の緯度情報。 ロケーションの緯度情報は、空間近接および包含目的で使用されます。
- LocationDirections; string; 住所の場所への方向。
- LocationId; integer; 場所の一意の識別子。
- 経度、数値、住所の経度情報。 ロケーションの経度情報は、空間的近接性および包含目的で使用されます。
- Mailstop; string;組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
- ObjectVersionNumber; integer;ロックの実装に使用される数値。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- ObjectVersionNumber1; integer;オプティミスティック・ロックの実装に使用される数値。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
- PartyId; integer; 住所に関連付けられたアカウントの一意の識別子。
- PartyNumber; string; アドレスに関連付けられたアカウントの一意の代替識別子。 非アクティブなレコードは更新できません。
- PartySiteName; string; アドレスのユーザー定義名。
- PartySourceSystem; string; アカウント・パーティがアドレスに関連付けられている外部ソース・システムの名前。 値は、設定タスク取引先コミュニティ・ソース・システムで構成できます。
- PartySourceSystemReferenceValue; string; 属性PartySourceSystemで指定された外部ソース・システムからの、アドレスに関連付けられたアカウントの一意の識別子。
- PostalCode; string;住所の郵便番号。
- PostalPlus4Code; string; 住所のアメリカ合衆国郵便番号の4桁の拡張子。
- PrimaryFlag; boolean;これがアカウントのプライマリ住所かどうかを示します。 値がYの場合、この住所はアカウントのプライマリ住所です。 デフォルト値はNです。
- 州;文字列;住所の都道府県。
- SSROwnerTableName; string; レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
- SSRPartyOwnerTableName; string; パーティ・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
- SourceSystem; string; アドレスがインポートされる外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムで構成された値。
- SourceSystemReferenceValue; string; 属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
- StartDateActive; string; アドレスがアクティブになる日付。
- State; string;アドレスの状態。
- Status; string;アドレスのステータスを示す内部フラグ。 ステータス・コードは、参照HZ_STATUSによって定義されます。
- ValidatedFlag; boolean。ロケーションが検証されるかどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。
- ValidationStatusCode; string; 検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- 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
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : accounts-Address-item-response
タイプ:
ソースを表示
object
-
AddrElementAttribute1: string
タイトル:
Additional Address Element 1
最大長:150
柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute2: string
タイトル:
Additional Address Element 2
最大長:150
柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute3: string
タイトル:
Additional Address Element 3
最大長:150
柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute4: string
タイトル:
Additional Address Element 4
最大長:150
柔軟な住所書式をサポートするための追加の住所要素。 -
AddrElementAttribute5: string
タイトル:
Additional Address Element 5
最大長:150
柔軟な住所書式をサポートするための追加の住所要素。 -
Address1: string
タイトル:
Address Line 1
最大長:240
住所の最初の行。 -
Address2: string
タイトル:
Address Line 2
最大長:240
住所の2行目。 -
Address3: string
タイトル:
Address Line 3
最大長:240
住所の3行目。 -
Address4: string
タイトル:
Address Line 4
最大長:240
住所の4行目。 -
AddressId: integer (int64)
読取り専用:
true
住所の一意の識別子。 -
AddressLinesPhonetic: string
タイトル:
Address Lines Phonetic
最大長:560
漢字の住所行の表記またはカナ。 これは日本の住所に使用されます。 -
AddressLocale: array Address Locales
タイトル:
Address Locales
アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。 -
AddressNumber: string
タイトル:
Site Number
最大長:30
作成中に内部的に生成された住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 -
AddressPurpose: array Address Purposes
タイトル:
Address Purposes
住所目的リソースは、住所目的の表示、作成、更新および削除に使用されます。 住所目的は、出荷先住所や請求先住所などの住所のタイプを記述します。 -
AddressType: string
タイトル:
Type
住所のタイプ。 -
Building: string
タイトル:
Building
最大長:240
住所の建物名または番号。 -
CalculateFormattedAddress: boolean
フォーマットされたアドレス。
-
City: string
タイトル:
City
最大長:60
住所の市区町村。 -
ClliCode: string
タイトル:
CLLI Code
最大長:60
住所の共通言語のロケーション識別子(CLLI)コード。 このコードは、住所の所在地を指定するために北米内で使用されます。 -
Comments: string
タイトル:
Comments
最大長:2000
住所に対するユーザー指定のコメント。 -
ConflictId: integer (int64)
デフォルト値:
0
競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency
最大長:15
アカウントに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
Country: string
タイトル:
Country
最大長:2
住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。 -
County: string
タイトル:
County
最大長:60
住所の郡。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
取引先レコードを作成したユーザー。 -
CreatedByModule: string
デフォルト値:
HZ_WS
住所レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。 -
CreatedByModule1: string
タイトル:
Created by Application
最大長:30
モジュールを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency Code
最大長:15
通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DateValidated: 文字列(日付)
タイトル:
Validated Date
住所が最後に検証された日付。 -
Description: string
タイトル:
Description
最大長:2000
事業所の摘要。 -
DoNotMailFlag: boolean
タイトル:
Contact Preferences
デフォルト値:false
住所を郵送に使用しないかどうかを示します。 -
DoNotValidateFlag: boolean
タイトル:
Don't Validate
最大長:1
現在の検証ステータス・コードに関係なく、特定の事業所が住所検証に適格でないことを示します。 -
DunsNumberC: string
タイトル:
D-U-N-S Number
最大長:30
事業所のD-U-N-S番号。 -
EffectiveDate: 文字列(日付)
住所がアクティブになる日付。
-
EndDateActive: 文字列(日付)
タイトル:
End Date
住所が非アクティブになる日付。 -
FloorNumber: string
タイトル:
Floor
最大長:40
住所の階数。 -
FormattedAddress: string
タイトル:
Address
読取り専用:true
住所の書式付きバージョン。 -
FormattedAddress1: string
タイトル:
Formatted Address 1
読取り専用:true
担当者住所レコードのフォーマット済住所。 -
FormattedMultilineAddress: string
タイトル:
Address
読取り専用:true
住所の書式付き複数行バージョン。 -
FormattedMultilineAddress1: string
タイトル:
Address
読取り専用:true
担当者住所レコードの複数行に書式設定された住所。 -
HouseType: string
タイトル:
House Type
最大長:30
住所の建物タイプ。 有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
緯度: number
タイトル:
Latitude
住所の緯度情報。 ロケーションの緯度情報は、空間近接および包含目的で使用されます。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LocationDirections: string
タイトル:
Location Directions
最大長:640
住所のロケーションへの道順。 -
LocationId: integer (int64)
タイトル:
Location ID
事業所の一意の識別子。 -
経度: number
タイトル:
Longitude
住所の経度情報。 ロケーションの経度情報は、空間的近接性および包含目的で使用されます。 -
Mailstop: string
タイトル:
Mail Stop
最大長:60
組織内のメール・ドロップ・ポイントを示すユーザー定義コード。 -
ObjectVersionNumber: 整数(int32)
ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
ObjectVersionNumber1: 整数(int32)
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
-
PartyId: integer (int64)
タイトル:
Party ID
住所に関連付けられたアカウントの一意の識別子。 -
PartyNumber: string
タイトル:
Party Number
住所に関連付けられたアカウントの一意の代替識別子。 非アクティブなレコードは更新できません。 -
PartySiteName: string
タイトル:
Site Name
最大長:240
住所のユーザー定義名。 -
PartySourceSystem: string
タイトル:
Party Source System
住所に関連付けられたアカウント・パーティがインポートされる外部ソース・システムの名前。 値は、設定タスク取引先コミュニティ・ソース・システムで構成できます。 -
PartySourceSystemReferenceValue: string
タイトル:
Party Source System Reference Value
属性PartySourceSystemで指定された外部ソース・システムからの、住所に関連付けられたアカウントの一意の識別子。 -
PostalCode: string
タイトル:
Postal Code
最大長:60
住所の郵便番号。 -
PostalPlus4Code: string
タイトル:
Postal Code Extension
最大長:20
住所の米国郵便番号への4桁の内線番号。 -
PrimaryFlag: boolean
タイトル:
Primary
最大長:1
デフォルト値:false
これがアカウントのプライマリ住所かどうかを示します。 値がYの場合、この住所はアカウントのプライマリ住所です。 デフォルト値はNです。 -
Province: string
タイトル:
Province
最大長:60
住所の州。 -
SourceSystem: string
住所のインポート元の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムで構成された値。
-
SourceSystemReferenceValue: string
属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
-
SSROwnerTableName: string
読取り専用:
true
最大長:255
レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。 -
SSRPartyOwnerTableName: string
読取り専用:
true
最大長:255
デフォルト値:HZ_PARTIES
パーティ・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。 -
StartDateActive: 文字列(日付)
タイトル:
Start Date
住所がアクティブになる日付。 -
State: string
タイトル:
State
最大長:60
住所の状態。 -
Status: string
タイトル:
Status
最大長:1
デフォルト値:A
住所のステータスを示す内部フラグ。 ステータス・コードは、参照HZ_STATUSによって定義されます。 -
ValidatedFlag: boolean
タイトル:
Validated
最大長:1
デフォルト値:false
事業所が検証済かどうかを示します。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 値がYの場合、住所が検証されます。 デフォルト値はNです。 -
ValidationStartDate: 文字列(日付)
読取り専用:
true
検証がアクティブになる日付。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 -
ValidationStatusCode: string
タイトル:
Validation Status
最大長:30
検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
ネストされたスキーマ : 住所ロケール
タイプ:
array
タイトル:
Address Locales
アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。
ソースを表示
ネストされたスキーマ : 住所目的
タイプ:
array
タイトル:
Address Purposes
住所目的リソースは、住所目的の表示、作成、更新および削除に使用されます。 住所目的は、出荷先住所や請求先住所などの住所のタイプを記述します。
ソースを表示
ネストされたスキーマ : 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値を変更します。
ネストされたスキーマ : accounts-Address-AddressPurpose-item-response
タイプ:
ソースを表示
object
-
AddressId: integer (int64)
作成中に内部的に生成される一意の住所識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス目的レコードを識別します。
-
AddressNumber: string
タイトル:
Site Number
読取り専用:true
最大長:30
作成中に内部的に生成される一意の住所識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス目的レコードを識別します。 -
AddressPurposeId: integer (int64)
読取り専用:
true
住所目的の一意の識別子。 -
Comments: string
タイトル:
Comments
最大長:2000
住所目的のユーザー・コメント。 -
CreatedBy: string
読取り専用:
true
最大長:64
住所目的レコードを作成したユーザー。 -
CreatedByModule: string
最大長:
30
デフォルト値:HZ_WS
この住所目的レコードを作成したアプリケーション・モジュール。 CreatedByModuleのデフォルト値は、すべてのWebサービス・ベースの作成でHZ_WSです。 受け入れられる値のリストは、参照タイプHZ_CREATED_BY_MODULESで定義されます。 この属性の値は、設定およびメンテナンス・タスク作業領域の取引先コミュニティ共通参照の管理タスクを使用してレビューおよび更新できます。 -
CreationDate: string (date-time)
読取り専用:
true
住所目的レコードが作成された日時。 -
DeleteFlag: boolean
住所目的を削除するかどうかを示します。 値がYの場合、住所目的を削除する必要があります。 デフォルト値はNです。
-
EndDate: 文字列(日付)
タイトル:
To Date
住所目的が無効になった日付。 -
LastUpdateDate: string (date-time)
読取り専用:
true
住所目的が最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
住所目的レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
住所目的レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PrimaryPerType: string
タイトル:
Primary
最大長:1
デフォルト値:N
これがサイトの主用途であるかどうかを示します。 Yはプライマリ・サイトを表し、Nは他のすべてのサイトを表します。 -
Purpose: string
タイトル:
Purpose
最大長:30
住所の目的。 有効な値のリストは参照PARTY_SITE_USE_CODEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。 -
SiteSourceSystem: string
システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
SiteSourceSystemReferenceValue: string
外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
SourceSystem: string
システム設定の一部として管理者が定義する、コードで示される住所目的の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、アドレスの目的を識別するための外部キーとして使用されます。
-
SourceSystemReferenceValue: string
外部ソースからの住所目的の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
StartDate: 文字列(日付)
タイトル:
From Date
住所目的が有効である開始日。 -
Status: string
タイトル:
Status
最大長:1
デフォルト値:A
関連付けられた住所レコードに対して住所目的がまだ有効かどうかを示します。 値Aはアクティブを示し、Iは非アクティブを示します。
例:
次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行して、すべてのアドレスを取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_336853/child/Address
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "PartyId" : 300100046354520, "PartyNumber" : "CDRM_336853", ... { ... "AddressId" : 300100046354531, "AddressNumber" : "CDRM_100235", "CreatedByModule" : "HZ_WS", "FormattedAddress" : "REDWOOD SHORES, CA", "FormattedMultilineAddress" : "REDWOOD SHORES, CA", "City" : "Redwood Shores", "Country" : "US", "State" : "CA", ... } }