Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての住所の取得

get

/crmRestApi/resources/11.13.18.05/hubOrganizations/{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で指定された外部ソース・システムからのアドレスの一意の識別子。
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; 作成中に内部的に生成される一意のアドレス識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
- AddressLinesPhonetic; string;漢字アドレス行の表記(日本で使用)。
- AddressNumber; string; アドレスの代替の一意の識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。指定しない場合、自動的に生成されます。プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
- Building; string; 指定された住所の特定の建物名または番号。
- City; string;住所のcity要素。
- ClliCode; string;共通言語のロケーション識別子(CLLI)コード。
- コメント、文字列。アドレスのユーザー・コメント。
- ConflictId; integer;競合の一意の識別子。
- CorpCurrencyCode; string; 住所に関連付けられた企業通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。この属性は、CRM拡張フレームワークで使用されます。
- Country; string;住所の国コード。
- County; string; 住所の郡要素。
- CreatedBy; string; アドレス・レコードを作成したユーザー。
- CreatedByModule1; string; この組織レコードを作成したアプリケーション・モジュール。すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
- CreationDate; string; レコードが作成された日時。
- CurcyConvRateType; string; 住所に関連付けられた通貨換算レート・タイプ。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
- CurrencyCode; string; 住所に関連する通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照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; 住所が関連付けられているアカウント、担当者または世帯の一意の識別子。住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
- PartyNumber; string; 住所が関連付けられているアカウント、担当者または世帯の代替の一意の識別子。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値で、一意の生成された連番と連結されます。値は、プロファイル・オプションHZ_GENERATE_PARTY_NUMBERに応じて更新できます。有効な値のリストは、プロファイル・オプションHZ_GENERATE_PARTY_NUMBERで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通プロファイル・オプションの管理タスクを使用して、コードをレビューおよび更新します。非アクティブなレコードは更新できません。
- PartySiteName; string; アドレスのユーザー定義名。
- PartySourceSystem; string; 住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。取引先、担当者、または世帯レコードの代替キーの一部(PartyourceSystemReferenceValueとも)。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
- PartySourceSystemReferenceValue; string;住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子。代替キーの一部(PartySourceSystemとも)。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
- PostalCode; string;正式な国全体の郵便番号システムで定義される郵便番号。
- PostalPlus4Code; string; アメリカ合衆国の郵便番号の4桁の拡張子。
- PrimaryFlag; boolean;これが関連オブジェクトのプライマリ・アドレスかどうかを示します。プライマリ担当者の値Y、その他すべての場合はNを受け入れます。
- 地方;文字列;住所の地方要素。
- SSROwnerTableName; string; レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
- SSRPartyOwnerTableName; string; パーティ・レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
- SourceSystem; string;システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
- SourceSystemReferenceValue; string;外部ソースからのアドレスの一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
- StartDateActive; string; このアドレスがアクティブになる日付。作成時に指定されない場合は、現在のシステム日付にデフォルト設定されます。
- State; string; Addressのstate要素。
- ステータス;文字列;アドレスのステータスを示す内部アプリケーション決定フラグ。ステータス・コードは、参照HZ_STATUSによって定義されます。
- ValidatedFlag; boolean。ロケーションが検証されたかどうかを示します。 Y(検証済)、N(無効)。値がTrueの場合、ロケーションが検証されます。この値は、住所クレンジング中にシステムによって内部的に設定されます。
- 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のデフォルト・バージョンを選択します。

ルート・スキーマ : hubOrganizations-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"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/hubOrganizations-Address-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object hubOrganizations-Address-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/hubOrganizations-Address-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : hubOrganizations-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

作成中に内部的に生成される一意の住所識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
AddressLinesPhonetic: string

タイトル: Address Lines Phonetic

最大長: 560

漢字住所行の表記(日本で使用)。
AddressNumber: string

タイトル: Site Number

最大長: 30

住所の代替一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。指定しない場合、自動的に生成されます。プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
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

競合の一意の識別子。
CorpCurrencyCode: string

タイトル: Corporate Currency

最大長: 15

住所に関連付けられた企業通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。この属性は、CRM拡張フレームワークで使用されます。
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

この組織レコードを作成したアプリケーション・モジュール。すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
CurcyConvRateType: string

タイトル: Currency Conversion Rate Type

最大長: 30

住所に関連付けられた通貨換算レート・タイプ。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

タイトル: Currency Code

最大長: 15

住所に関連する通貨コード。この属性は、CRM拡張フレームワークで使用されます。有効な値のリストは、参照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

住所が関連付けられているアカウント、担当者または世帯の一意の識別子。住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
PartyNumber: string

タイトル: Party Number

住所が関連付けられているアカウント、担当者または世帯の代替の一意の識別子。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値で、一意の生成された連番と連結されます。値は、プロファイル・オプションHZ_GENERATE_PARTY_NUMBERに応じて更新できます。有効な値のリストは、プロファイル・オプションHZ_GENERATE_PARTY_NUMBERで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通プロファイル・オプションの管理タスクを使用して、コードをレビューおよび更新します。非アクティブなレコードは更新できません。
PartySiteName: string

タイトル: Site Name

最大長: 240

住所のユーザー定義名。
PartySourceSystem: string

タイトル: Party Source System

住所が関連付けられている取引先、担当者または世帯の外部ソース・システムの名前。取引先、担当者、または世帯レコードの代替キーの一部(PartyourceSystemReferenceValueとも)。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
PartySourceSystemReferenceValue: string

タイトル: Party Source System Reference Value

住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子です。代替キーの一部(PartySourceSystemとも)。住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
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

システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
SourceSystemReferenceValue: string

外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
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(無効)。値がTrueの場合、ロケーションが検証されます。この値は、住所クレンジング中にシステムによって内部的に設定されます。
ValidationStartDate: 文字列(日付)

読取り専用: true

検証が開始する日付。内部的には、住所クレンジング中にシステムによって設定されます。
ValidationStatusCode: string

タイトル: Validation Status

最大長: 30

検証の結果を説明する標準化されたステータス・コード。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress1":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The attribute used to store latitude information for the location for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartySourceSystemReferenceValue":{
            "title":"Party Source System Reference Value",
            "type":"string",
            "description":"Identifier from external source system for the account, contact or household with which the address is associated. Part of Alternate Key (along with PartySourceSystem) . One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code related to the address. This attribute is used by CRM Extensibility framework. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "x-queryable":true
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":60,
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code.",
            "nullable":true,
            "x-queryable":true
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":60,
            "type":"string",
            "description":"A user-defined code to indicate a mail drop point within their organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"The user defined name for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "type":"string",
            "description":"The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "default":"HZ_WS",
            "x-queryable":false
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the addresses. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. This attribute is used by CRM Extensibility framework.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates that this address should not be used for mailing.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"An internal application determined flag indicating status of the address. Status codes are defined by the lookup HZ_STATUS.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the address record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationStartDate":{
            "type":"string",
            "description":"The date on which the validation starts. Internally set by system during address cleansing.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartySourceSystem":{
            "title":"Party Source System",
            "type":"string",
            "description":"The name of external source system of the account, contact, or household with which the address is associated. Part of Alternate Key for the account, contact, or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":30,
            "type":"string",
            "description":"The standardized status code that describes the results of the validation.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city element of Address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The attribute used to store longitude information for the location for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiple line address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province element of Address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the location was validated. Y for validated, N for invalidated. If the value is True, then the location is validated. The value is internally set by system during address cleansing.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "description":"The attribute used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date after which this address is rendered inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CalculateFormattedAddress":{
            "type":"boolean",
            "description":"The formatted address.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "SSROwnerTableName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the table that holds the record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state element of Address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the contact record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"Specific building name or number at a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. Accepts values Y for primary contact, N for all others.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"An extensive description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code as defined by the formal countrywide postal system.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county element of address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from which this address is active. Defaulted to the current system date if not provided during create.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The attribute used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"The building type. A list of valid values is defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "DunsNumberC":{
            "title":"D-U-N-S Number",
            "maxLength":30,
            "type":"string",
            "description":"The D-U-N-S number of the business location.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedByModule1":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date on which the address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user comments for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location record for this address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "type":"string",
            "description":"The alternate unique identifier of the account, contact, or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact, or household record with which the address is associated. The default value is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. The value is updateable depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of valid values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique Identifier of the account, contact, or household to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account, contact, or household record with which the address is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The type of address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"delimited_ids_choice"
            }
        },
        "SSRPartyOwnerTableName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the table that holds the party record data and is referenced to manage source system reference.",
            "nullable":true,
            "readOnly":true,
            "default":"HZ_PARTIES",
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress1":{
            "title":"Formatted Address 1",
            "type":"string",
            "description":"The formatted address information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectiveDate":{
            "type":"string",
            "description":"The effective date of the address.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

「トップに戻る」