すべての世帯を取得
/crmRestApi/resources/11.13.18.05/households
リクエスト
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- HouseholdPartyNumberRF : 指定したパーティ番号を持つ世帯を検索します。
ファインダ変数:- PartyNumber; string;世帯パーティ番号。
- MyHouseholds : 自分の世帯から世帯を検索します。
ファインダ変数:- BindUserPartyId; integer;世帯の一意の識別子。
- PartyIdAltKey : 指定されたプライマリ識別子を持つ世帯を検索します。
ファインダ変数:- PartyId; integer;世帯パーティ識別子。
- PartyNumberAltKey : 指定したパーティ番号を持つ世帯を検索します。
ファインダ変数:- PartyNumber; string;世帯パーティ番号。
- PrimaryKey : 指定した主キーを持つ世帯を検索します。
ファインダ変数:- GroupPartyId; integer; グループ・パーティの一意の識別子。
- PartyId; integer;世帯パーティ識別子。
- SalesProfileId; integer;販売プロファイルの一意の識別子。
- SourceSystemReferenceAltKey : ソース・システム情報を含む世帯を検索します。
ファインダ変数:- SourceSystem; string;外部ソース・システムの名前。
- SourceSystemReferenceValue; string;外部ソース・システムからのこのレコードの識別子。
- HouseholdPartyNumberRF : 指定したパーティ番号を持つ世帯を検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AddressElementAttribute1; string;柔軟なアドレス形式をサポートするための追加のアドレス要素
- AddressElementAttribute2; string;柔軟なアドレス形式をサポートするための追加のアドレス要素
- AddressElementAttribute3; string;柔軟なアドレス形式をサポートするための追加のアドレス要素
- AddressElementAttribute4; string;柔軟なアドレス形式をサポートするための追加のアドレス要素
- AddressElementAttribute5; string;柔軟なアドレス形式をサポートするための追加のアドレス要素
- AddressLine1; string; addressの最初の行。
- AddressLine2; string; 2行目のアドレス。
- AddressLine3; string; 3行目のアドレス。
- AddressLine4; string; 4行目のアドレス。
- AddressLinesPhonetic; string;漢字アドレス行の表記(日本で使用)
- AddressNumber; string;アドレスの代替の一意の識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。
- AnnualIncome; integer;世帯の年間収入。 指定しない場合、値はNULLになります。
- AverageAge; integer;世帯の平均経過時間。
- Building; string; 指定された住所の特定の建物名または番号。
- CertificationLevel; string;世帯の認定レベル。 有効な証明レベル・コードのリストは、参照HZ_PARTY_CERT_LEVELを使用して定義されます。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通参照の管理」タスクを使用して、コードをレビューおよび更新します。
- CertificationReasonCode; string; 世帯の現在の認定レベル割当の理由。 有効な証明事由コードのリストは、参照HZ_PARTY_CERT_REASONを使用して定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
- Child0to6Number; integer;年齢範囲が0-6の子の数。
- Child13to18Number; integer;年齢範囲の子の数は13-18です。
- Child7to12Number; integer;年齢範囲の子の数は7-12です。
- City; string; addressのcity要素。
- コメント、文字列。グループの説明。
- 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で指定された値です。
- DependentsNumber; integer;世帯に対する依存の数。
- EffectiveLatestChange; string; 行に1日の最新の変更があるかどうかを示します。 値がTrueの場合、この行にはその日の最新の変更があります。
- EffectiveSequence; integer; 日中に行われた様々な変更の順序。 最下位の値は、その日の最初の変更を表します。
- EmailAddress; string; 担当者の電子メール・アドレス。
- EmailContactPointId; integer; 電子メール担当者の一意の識別子。
- EmailContactPointType; string; 電子メール担当者のタイプ。
- EmailFormat; string; HTMLやASCIIなど、世帯が優先するEメールの書式。
- FavoriteHouseholdFlag; boolean。世帯がお気に入りの世帯であるかどうかを示します。 デフォルト値はfalseです。
- FloorNumber; string;建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。
- GroupPartyId; integer; グループ・パーティの一意の識別子。
- GroupType; string;グループの型。
- HouseholdName; string; このパーティの一意の識別番号。 この属性に格納されるデータは、HZ_PARTIESのPARTY_NUMBERから取得されます。
- HouseholdProfileId; integer; 世帯プロファイルの一意の識別子。
- HouseholdSize; integer;グループのサイズ。
- LastAssignmentDate; string; 販売アカウント・テリトリ割当が割当マネージャによって最後に実行された日付。
- LastAssignmentDateTime; string; 販売アカウント・テリトリ割当が割当マネージャによって最後に実行された時点のタイムスタンプ。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン詳細。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- Mailstop; string;組織内のメール・ドロップ・ポイントを示すユーザー定義コード
- MedianAge; integer;年齢中央値。
- NamedFlag; boolean;販売アカウントが指定された販売アカウントであるかどうかを示します。 使用可能な値は、TrueまたはFalseです。 値がTrueの場合、販売アカウントは指定販売アカウントです。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
- ObjectVersionNumberEmail; integer; 電子メールの内部バージョン番号。 ロックの実装に使用される番号です。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- ObjectVersionNumberGroup; integer;グループの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- ObjectVersionNumberOwner; integer;所有者の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- ObjectVersionNumberParty; integer;パーティの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- ObjectVersionNumberPhone; integer;電話機の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- ObjectVersionNumberSalesAccount; integer; 販売アカウントの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
- OwnerEmailAddress; string;販売アカウント所有者のEメール・アドレス。 販売アカウントに所有者を割り当てるには、所有者のパーティID、パーティ番号またはEメール・アドレスを指定できます。
- OwnerName; string;販売アカウント所有者の名前。
- OwnerPartyId; integer;販売アカウント所有者の一意の識別子。 販売アカウントに所有者を割り当てるには、所有者のパーティ識別子、パーティ番号またはEメール・アドレスのいずれかを指定する必要があります。
- OwnerPartyId1; integer;所有者パーティの一意の識別子。
- OwnerPartyNumber; string;販売アカウントを所有および管理する有効な従業員リソースのパーティ番号。 販売アカウントに所有者を割り当てるには、所有者のパーティID、パーティ番号またはEメール・アドレスを指定できます。
- PartyId; integer;パーティの一意の識別子。
- PartyNumber; string;世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
- PartyNumberKey; string; 世帯パーティ・レコードの代替の一意の識別子。
- PartyStatus; string;世帯のステータス。
- PartyType; string;パーティのタイプ。
- PartyUniqueName; string; 導出列です。 組織の場合は、unique_name_aliasとサフィクスが連結されます。 個人の場合、これはperson_nameとサフィクスを連結したものです。
- PhoneAreaCode; string;電話番号の市外局番。
- PhoneContactPointId; integer;電話担当者の一意の識別子。
- PhoneContactPointType; string;電話担当者のタイプ。
- PhoneCountryCode; string; フランスの33など、電話番号の国際国コード。
- PhoneExtension; string; 内部電話システムへの初期接続後にアドレス指定される追加の番号。
- PhoneNumber; string; ローカル形式でフォーマットされた電話番号。 市外局番や国コード、内線番号を含めないでください。
- PostalCode; string;正式な国全体の郵便番号システムで定義される郵便番号。
- PostalPlus4Code; string; アメリカ合衆国の郵便番号の4桁の拡張子。
- PreferredContactMethod; string;世帯の連絡方法を示します。 参照タイプPREFERRED_CONTACT_METHODに対して検証されます。 有効なコードのリストは、参照HZ_PREFERENCEで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
- PreferredFunctionalCurrency; string;グループの優先通貨を示すコード。
- PrimaryAddressId; integer; プライマリ・アドレスの一意の識別子。
- PrimaryContactPartyId; integer;プライマリ担当者の一意の識別子。 世帯の担当者を指定するには、担当者のパーティID、PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
- PrimaryContactPartyNumber; string;主担当者の代替キー識別子。 世帯の担当者を指定するには、担当者のパーティID PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
- PrimaryContactSourceSystem; string; プライマリ担当者のSourceSystem。 世帯の担当者を指定するには、担当者のパーティID PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
- PrimaryContactSourceSystemReferenceValue; string; プライマリ担当者のSourceSystemReference。 世帯の担当者を指定するには、担当者のパーティID、PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
- 地方;文字列;住所の地方要素。
- RawPhoneNumber; string; raw電話番号。
- RecordSet; string;選択したレコード・セットの下に検索結果を表示します。
- SalesProfileId; integer;世帯レコードの販売プロファイルの一意の識別子。
- SalesProfileNumber; string;レコードの代替の一意の識別子。
- SalesProfileStatus; string;販売アカウントの有効なユーザー定義ステータス。
- SellToPartySiteId; integer;世帯レコードの販売先パーティ・サイトの一意の識別子。
- SourceSystem; string; システム設定の一部として管理者が定義する外部ソース・システムの名前。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。
- SourceSystemReferenceValue; string; 属性SourceSystemで指定された外部ソース・システムからの世帯パーティの一意の識別子。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。
- State; string; addressのstate要素。
- タイプ;文字列;世帯が販売アカウントか見込み客か、参照タイプZCA_ HOUSEHOLD _TYPEを使用して指定された他のユーザー定義パーティ・タイプかを定義する世帯パーティ・タイプ。 値が指定されていない場合は、デフォルトでZCA_CUSTOMERに設定されます。 指定可能な値は、ZCA_CUSTOMERまたはZCA_PROSPECTです。 有効な値のリストは、参照ZCA_HOUSEHOLD_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
- UniqueNameSuffix; string; PartyUniqueNameを生成するためにhouseholdName属性に連結された、システム生成または手動でオーバーライドされたサフィクス。 プライマリ住所は、サフィクスとしてデフォルト設定されます。
- WealthAmount; integer;世帯の資産金額または純資産。 指定しない場合、値はNULLになります。
- 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のデフォルト・バージョンを選択します。
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
object
-
AdditionalIdentifier: array Additional Identifiers
タイトル:
Additional Identifiers
追加の識別子リソースは、運転免許証番号やパスポート番号などの追加識別子を表示、作成、更新および削除するために使用されます。 -
AdditionalName: array Additional Names
タイトル:
Additional Names
追加の名前リソースは、アカウントに関連付けられた追加の名前を表示、作成、更新および削除するために使用されます。 このリソースを使用すると、旧姓やブランド名など、アカウントに関連付けられた他の名前を取得できます。 -
Address: array Addresses
タイトル:
Addresses
世帯の住所を表示、作成、更新および削除するために、住所リソースが使用されます。 住所には、世帯の詳細なロケーション情報が含まれます。 -
AddressElementAttribute1: string
タイトル:
Additional Address Element 1
最大長:150
柔軟な住所書式をサポートする追加住所要素 -
AddressElementAttribute2: string
タイトル:
Additional Address Element 2
最大長:150
柔軟な住所書式をサポートする追加住所要素 -
AddressElementAttribute3: string
タイトル:
Additional Address Element 3
最大長:150
柔軟な住所書式をサポートする追加住所要素 -
AddressElementAttribute4: string
タイトル:
Additional Address Element 4
最大長:150
柔軟な住所書式をサポートする追加住所要素 -
AddressElementAttribute5: string
タイトル:
Additional Address Element 5
最大長:150
柔軟な住所書式をサポートする追加住所要素 -
AddressLine1: string
タイトル:
Address Line 1
最大長:240
住所の最初の行。 -
AddressLine2: string
タイトル:
Address Line 2
最大長:240
住所の2行目。 -
AddressLine3: string
タイトル:
Address Line 3
最大長:240
住所の3行目。 -
AddressLine4: string
タイトル:
Address Line 4
最大長:240
住所の4行目。 -
AddressLinesPhonetic: string
タイトル:
Address Lines Phonetic
最大長:560
漢字住所行の表記(日本で使用) -
AddressNumber: string
タイトル:
Site Number
最大長:30
住所の代替一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。 -
AddressType: string
タイトル:
Type
BillTo、ShipToなどのアドレスのタイプとしての追加情報。 -
AnnualIncome: integer (int64)
タイトル:
Annual Income
世帯の年間所得。 指定しない場合、値はNULLになります。 -
AssignmentExceptionFlag: boolean
タイトル:
Assignment Exception Indicator
読取り専用:true
最大長:1
デフォルト値:false
割当マネージャがテリトリを販売アカウントに割り当てられるために必要なディメンションが販売アカウントにあるかどうかを示します。 デフォルト値はfalseです。 -
Attachment: array Attachments
タイトル:
Attachments
添付リソースは、世帯の添付の表示、作成、更新および削除に使用されます。 添付には、世帯に関する追加情報が含まれます。 -
AverageAge: integer (int64)
タイトル:
Average Age
世帯の平均年齢。 -
Building: string
タイトル:
Building
最大長:240
特定の住所の特定の建物名または番号。 -
CertificationLevel: string
タイトル:
Certification Level
最大長:30
世帯の認定レベル。 有効な証明レベル・コードのリストは、参照HZ_PARTY_CERT_LEVELを使用して定義されます。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通参照の管理」タスクを使用して、コードをレビューおよび更新します。 -
CertificationReasonCode: string
タイトル:
Certification Reason
最大長:30
世帯の現在の認定レベル割当の理由。 有効な証明事由コードのリストは、参照HZ_PARTY_CERT_REASONを使用して定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。 -
Child0to6Number: integer (int64)
タイトル:
Children Below 7 Years of Age
0-6歳の子供の数。 -
Child13to18Number: integer (int64)
タイトル:
Children Aged 13 to 18 Years
13-18歳の子供数。 -
Child7to12Number: integer (int64)
タイトル:
Children Aged 7 to 12 Years
7 ~ 12歳の子供の数。 -
City: string
タイトル:
City
最大長:60
住所の市区町村要素。 -
ClassificationCategory: string
タイトル:
Classification Category
プライマリとしてマークされ、管理者が定義する世帯の有効な分類カテゴリ・コード。 -
ClassificationCode: string
タイトル:
Classification Code
分類カテゴリに対応する有効な分類コードで、プライマリとしてマークされます。 -
Comments: string
タイトル:
Comments
最大長:2000
グループの摘要。 -
ConflictId: integer (int64)
デフォルト値:
0
世帯データ・レコードに対する競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
ContactPoint: array Contact Points
タイトル:
Contact Points
担当者リソースは、アカウントの担当者を表示、作成、更新および削除するために使用されます。 連絡先は、地理的住所、電話番号、電子メールID、URL、メッセンジャIDなどになります。 -
CorpCurrencyCode: string
最大長:
15
世帯に関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
Country: string
タイトル:
Country
最大長:2
住所の国コード。 -
County: string
タイトル:
County
最大長:60
住所の郡要素。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreatedByModule: string
タイトル:
Created by Application
デフォルト値:HZ_WS
この組織レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。 -
CreatedByModule1: string
最大長:
30
世帯レコードを作成したアプリケーション・モジュール。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CurcyConvRateType: string
最大長:
30
世帯に関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
世帯に関連付けられている通貨コード。 デフォルト値は、プロファイル・オプションZCA_COMMON_CORPORATE_CURRENCYで指定された値です。 -
CustomerClassification: array Aux Classifications
タイトル:
Aux Classifications
aux分類リソースは、世帯に関連付けられている顧客の補助分類を表示、作成、更新および削除するために使用されます。 補助分類を使用すると、顧客を商用や非公開などの様々なグループに分類できます。 -
DeleteFlag: boolean
読取り専用:
true
世帯を削除できるかどうかを示します。 デフォルト値はfalseです。 -
DependentsNumber: integer (int64)
タイトル:
Number of Dependents
世帯に対する扶養家族の数。 -
EffectiveLatestChange: string
最大長:
1
デフォルト値:Y
その日の行が最新の変更であるかどうかを示します。 値がTrueの場合、この行にはその日の最新の変更があります。 -
EffectiveSequence: 整数(int32)
日中に行われた様々な変更の順序。 最下位の値は、その日の最初の変更を表します。
-
EmailAddress: string
タイトル:
Email
最大長:320
担当者のEメール・アドレス。 -
EmailContactPointId: integer (int64)
読取り専用:
true
Eメール担当者の一意の識別子。 -
EmailContactPointType: string
タイトル:
Type
読取り専用:true
最大長:30
デフォルト値:EMAIL
Eメール担当者のタイプ。 -
EmailFormat: string
タイトル:
Email Format
最大長:30
HTMLやASCIIなど、世帯が希望するEメールの書式。 -
EmailVerificationDate: 文字列(日付)
タイトル:
Email Verification Date
Eメール・アドレスが最後に検証された日付。 -
EmailVerificationStatus: string
タイトル:
Email Verification Status
最大長:30
Eメール・アドレス検証のステータス・コード。 参照に基づく値は、Eメールに対して有効、無効または一部無効です。 -
ExistingCustomerFlag: boolean
タイトル:
Existing Sales Account
読取り専用:true
最大長:1
デフォルト値:false
販売アカウントとの既存の販売関係または請求関係があるかどうかを示します。 デフォルト値はfalseです。 -
ExistingCustomerFlagLastUpdateDate: 文字列(日付)
タイトル:
Existing Indicator Last Update Date
読取り専用:true
既存の顧客フラグが最後に変更された日付。 -
FavoriteHouseholdFlag: boolean
タイトル:
Favorite
最大長:10
デフォルト値:false
世帯がお気に入りの世帯であるかどうかを示します。 デフォルト値はfalseです。 -
FloorNumber: string
タイトル:
Floor
最大長:40
建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。 -
FormattedAddress: string
タイトル:
Address
読取り専用:true
プライマリ住所のフォーマット済バージョン。 -
FormattedPhoneNumber: string
タイトル:
Phone Number
読取り専用:true
書式設定された電話番号情報。 -
GroupPartyId: integer (int64)
グループ・パーティの一意の識別子。
-
GroupType: string
タイトル:
Type
読取り専用:true
最大長:30
デフォルト値:HOUSEHOLD
グループのタイプ。 -
HouseholdName: string
タイトル:
Name
最大長:360
このパーティの一意の識別番号。 この属性に格納されるデータは、HZ_PARTIESのPARTY_NUMBERから取得されます。 -
HouseholdProfileId: integer (int64)
世帯プロファイルの一意の識別子。
-
HouseholdSize: integer (int64)
タイトル:
Size
グループのサイズ。 -
LastAssignmentDate: 文字列(日付)
タイトル:
Last Assigned Date
読取り専用:true
販売アカウント・テリトリ割当が割当マネージャによって最後に実行された日付。 -
LastAssignmentDateTime: string (date-time)
読取り専用:
true
販売アカウント・テリトリ割当が割当マネージャによって最後に実行された時点のタイムスタンプ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Mailstop: string
タイトル:
Mail Stop
最大長:60
組織内のメール・ドロップ・ポイントを示すユーザー定義コード -
MedianAge: integer (int64)
タイトル:
Median Age
中央年齢。 -
NamedFlag: boolean
タイトル:
Named Household
最大長:1
デフォルト値:false
販売アカウントが指定された販売アカウントであるかどうかを示します。 使用可能な値は、TrueまたはFalseです。 値がTrueの場合、販売アカウントは指定販売アカウントです。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。 -
Note: array Notes
タイトル:
Notes
ノート・リソースは、世帯に関連付けられたノートの表示、作成、更新および削除に使用されます。 ノートは、世帯に関連するコメント、情報またはインストラクションを取得します。 -
ObjectVersionNumberEmail: 整数(int32)
Eメールの内部バージョン番号。 ロックの実装に使用される番号です。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
ObjectVersionNumberGroup: 整数(int32)
グループの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
ObjectVersionNumberOwner: 整数(int32)
読取り専用:
true
所有者の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。 -
ObjectVersionNumberParty: 整数(int32)
パーティの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
ObjectVersionNumberPhone: 整数(int32)
電話の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
ObjectVersionNumberSalesAccount: 整数(int32)
販売アカウントの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
OwnerEmailAddress: string
読取り専用:
true
最大長:320
販売アカウント所有者のEメール・アドレス。 販売アカウントに所有者を割り当てるには、所有者のパーティID、パーティ番号またはEメール・アドレスを指定できます。 -
OwnerName: string
読取り専用:
true
最大長:360
販売アカウント所有者の名前。 -
OwnerPartyId: integer (int64)
タイトル:
Owner ID
販売アカウント所有者の一意の識別子。 販売アカウントに所有者を割り当てるには、所有者のパーティ識別子、パーティ番号またはEメール・アドレスのいずれかを指定する必要があります。 -
OwnerPartyId1: integer (int64)
読取り専用:
true
所有者パーティの一意の識別子。 -
OwnerPartyNumber: string
読取り専用:
true
最大長:30
販売アカウントを所有および管理する有効な従業員リソースのパーティ番号。 販売アカウントに所有者を割り当てるには、所有者のパーティID、パーティ番号またはEメール・アドレスを指定できます。 -
PartyId: integer (int64)
タイトル:
Party ID
読取り専用:true
パーティの一意識別子 -
PartyNumber: string
タイトル:
Registry ID
最大長:30
世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。 -
PartyNumberKey: string
タイトル:
Registry ID
最大長:30
世帯パーティ・レコードの代替一意識別子。 -
PartyStatus: string
読取り専用:
true
最大長:1
デフォルト値:A
世帯の状況。 -
PartyType: string
タイトル:
Party Type
読取り専用:true
最大長:30
デフォルト値:GROUP
パーティのタイプ。 -
PartyUniqueName: string
タイトル:
Name
読取り専用:true
最大長:900
これは導出列です。 組織の場合は、unique_name_aliasとサフィクスが連結されます。 個人の場合、これはperson_nameとサフィクスを連結したものです。 -
PhoneAreaCode: string
タイトル:
Area Code
最大長:20
電話番号の市外局番。 -
PhoneContactPointId: integer (int64)
読取り専用:
true
電話担当者の一意の識別子。 -
PhoneContactPointType: string
タイトル:
Type
読取り専用:true
最大長:30
デフォルト値:PHONE
電話担当者のタイプ。 -
PhoneCountryCode: string
タイトル:
Phone Country Code
最大長:10
電話番号の国際国コード(フランスの場合は33など)。 -
PhoneExtension: string
タイトル:
Extension
最大長:20
内部電話システムへの初期接続後にアドレス指定された追加番号。 -
PhoneNumber: string
タイトル:
Phone
最大長:40
ローカル書式で書式設定された電話番号。 市外局番や国コード、内線番号を含めないでください。 -
PhoneVerificationDate: 文字列(日付)
タイトル:
Phone Verification Date
電話番号が最後に検証された日付。 -
PhoneVerificationStatus: string
タイトル:
Phone Verification Status
最大長:30
電話番号検証のステータス・コード。 参照に基づく値は有効であり、電話に対して無効です。 -
PostalCode: string
タイトル:
Postal Code
最大長:60
正式な国全体の郵便番号システムによって定義された郵便番号。 -
PostalPlus4Code: string
タイトル:
Postal Code Extension
最大長:20
米国の郵便番号に対する4桁の拡張。 -
PreferredContactMethod: string
タイトル:
Preferred Contact Method
最大長:30
世帯の連絡方法を示します。 参照タイプPREFERRED_CONTACT_METHODに対して検証されます。 有効なコードのリストは、参照HZ_PREFERENCEで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。 -
PreferredFunctionalCurrency: string
タイトル:
Preferred Functional Currency
最大長:15
グループの優先通貨を示すコード。 -
PrimaryAddress: array Primary Addresses
タイトル:
Primary Addresses
プライマリ住所リソースは、世帯のプライマリ住所を表示、作成、更新および削除するために使用されます。 プライマリ住所は、世帯のデフォルトの通信住所です。 -
PrimaryAddressId: integer (int64)
読取り専用:
true
プライマリ住所の一意の識別子。 -
PrimaryContactEmail: string
タイトル:
Contact Email
読取り専用:true
プライマリ担当者のEメール・アドレス。 -
PrimaryContactName: string
読取り専用:
true
最大長:255
プライマリ担当者の名前。 -
PrimaryContactPartyId: integer (int64)
プライマリ担当者の一意の識別子。 世帯の担当者を指定するには、担当者のパーティID、PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
-
PrimaryContactPartyNumber: string
主担当者の代替キー識別子。 世帯の担当者を指定するには、担当者のパーティID PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
-
PrimaryContactPhone: string
タイトル:
Contact Phone
読取り専用:true
プライマリ担当者の電話番号。 -
PrimaryContactSourceSystem: string
プライマリ担当者のSourceSystem。 世帯の担当者を指定するには、担当者のパーティID PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
-
PrimaryContactSourceSystemReferenceValue: string
プライマリ担当者のSourceSystemReference。 世帯の担当者を指定するには、担当者のパーティID、PartyNumberまたは(SourceSystem、SourceSystemReference)のいずれかを指定できます。
-
Province: string
タイトル:
Province
最大長:60
住所の州要素。 -
RawPhoneNumber: string
タイトル:
Raw Phone Number
最大長:60
生の電話番号。 -
RecordSet: string
タイトル:
Record Set
読取り専用:true
最大長:30
選択したレコード・セットの下の検索結果を表示します。 -
Relationship: array Relationships
タイトル:
Relationships
関係リソースは、世帯関係を表示、作成および更新するために使用されます。 世帯関係は、従業員や役員など、パーティ間の相互接続です。 -
SalesProfileId: integer (int64)
世帯レコードの販売プロファイルの一意の識別子。
-
SalesProfileNumber: string
タイトル:
Sales Account Number
最大長:30
レコードの代替一意識別子。 -
SalesProfileStatus: string
タイトル:
Status
最大長:30
販売アカウントの有効なユーザー定義ステータスです。 -
SalesTeamMember: array Sales Account Resources
タイトル:
Sales Account Resources
販売アカウント・リソースは、販売アカウント・チームに割り当てられているリソース・パーティの表示、作成、更新および削除に使用されます。 販売アカウント・チーム・メンバーには、販売アカウントに対して定義されたアクセス・ロールがあります。 -
SellToPartySiteId: integer (int64)
タイトル:
Sell to Address
読取り専用:true
世帯レコードの販売先パーティ・サイトの一意の識別子。 -
SourceObjectType: string
読取り専用:
true
最大長:255
デフォルト値:SALES_PARTY
ソース・オブジェクトのタイプ。 -
SourceSystem: string
タイトル:
Source System
システム設定の一部として管理者が定義する外部ソース・システムの名前。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。 -
SourceSystemReference: array Source System References
タイトル:
Source System References
ソース・システム参照リソースは、ソース・システムの表示、作成、更新および削除に使用されます。 ソース・システムは、データをインポートする外部システムです。 -
SourceSystemReferenceValue: string
タイトル:
Source System Reference
属性SourceSystemで指定された外部ソース・システムからの世帯パーティの一意の識別子。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。 -
SSROwnerTableName: string
読取り専用:
true
最大長:30
デフォルト値:HZ_PARTIES
レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。 -
State: string
タイトル:
State
最大長:60
住所の州要素。 -
StringPartyId: string
読取り専用:
true
最大長:255
世帯レコードの文字列の一意の識別子。 -
Type: string
タイトル:
Type
最大長:30
世帯が販売アカウントか見込み客か、参照タイプZCA_ HOUSEHOLD _TYPEを使用して指定されたその他のユーザー定義パーティ・タイプのいずれであるかを定義する世帯パーティ・タイプ。 値が指定されていない場合は、デフォルトでZCA_CUSTOMERに設定されます。 指定可能な値は、ZCA_CUSTOMERまたはZCA_PROSPECTです。 有効な値のリストは、参照ZCA_HOUSEHOLD_TYPEで定義されます。 「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。 -
UniqueNameSuffix: string
タイトル:
Name Suffix
最大長:540
PartyUniqueNameを生成するためにhouseholdName属性に連結された、システム生成または手動でオーバーライドされたサフィクス。 プライマリ住所は、サフィクスとしてデフォルト設定されます。 -
UpdateFlag: boolean
読取り専用:
true
レコードを更新できるかどうかを示します。 デフォルト値はfalseです。 -
WealthAmount: integer
タイトル:
Total Wealth
世帯の資産金額または純資産。 指定しない場合、値はNULLになります。
array
Additional Identifiers
array
Additional Names
array
Addresses
array
Attachments
array
Contact Points
array
Aux Classifications
array
Notes
array
Primary Addresses
array
Relationships
array
Sales Account Resources
array
Source System References
object
-
Country: string
タイトル:
Issuing Country
最大長:2
追加識別子の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。 -
CreatedBy: string
読取り専用:
true
最大長:64
追加識別子を作成したユーザー。 -
CreatedByModule: string
デフォルト値:
HZ_WS
この組織レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。 -
CreationDate: string (date-time)
読取り専用:
true
追加識別子が作成された日付。 -
Description: string
タイトル:
Description
最大長:240
追加識別子の摘要。 -
ExpirationDate: 文字列(日付)
タイトル:
Expiration Date
追加識別子が失効する日付。 -
IssueDate: 文字列(日付)
タイトル:
Issue Date
追加識別子が発行された日付。 -
IssuingAuthorityName: string
タイトル:
Issuing Authority Name
最大長:500
追加識別子の発行機関の名前。 -
IssuingAuthorityPartyId: integer (int64)
発行機関パーティの一意の識別子。
-
LastUpdateDate: string (date-time)
読取り専用:
true
追加識別子が最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
追加識別子を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
追加識別子を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。 -
PartyId: integer (int64)
パーティの一意識別子
-
PartyIdentifierId: integer (int64)
読取り専用:
true
パーティの一意識別子 -
PartyIdentifierType: string
タイトル:
Identifier Type
最大長:30
パーティ識別子のタイプ。 -
PartyIdentifierValue: string
タイトル:
Identifier Value
最大長:60
パーティ識別子の値。 -
PartyNumber: string
追加識別子のパーティ番号。 非アクティブなレコードは更新できません。
-
PartySourceSystem: string
住所が関連付けられている取引先、担当者または世帯の外部ソース・システムの名前。 取引先、担当者または世帯レコードの代替キーの一部(PartyourceSystemReferenceValueとも)。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
-
PartySourceSystemReferenceValue: string
外部ソース・システムからのレコードの識別子。
-
SourceSystem: string
システム設定の一部として管理者が定義する外部ソース・システムの名前。 これは、(SourceSystemReferenceとともに)代替キーの一部であり、更新でPKまたはpartyNumberBusinessKeyが渡されない場合は必須です。
-
SourceSystemReferenceValue: string
外部ソース・システムからの関係の一意の識別子。
-
StateProvince: string
タイトル:
Issuing State
最大長:60
地理設定に基づくパスポートや運転免許などの特定のタイプの識別子に使用されます。 -
StatusCode: string
最大長:
1
デフォルト値:A
追加識別子のステータス・コード。
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.
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
object
-
AcademicTitle: string
タイトル:
Academic Title
最大長:30
学業資格を示す個人のタイトルの一部です(Dr. Jane Smithなど)。 -
ConflictId: integer (int64)
デフォルト値:
0
属性値は、異なるデータベースに重複が作成される場合に、行の一意性を保証するために使用されます。 -
CreatedBy: string
読取り専用:
true
最大長:64
追加の名前レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
追加の名前レコードが作成された日付。 -
Description: string
タイトル:
Description
最大長:240
追加名レコードの説明 -
FirstName: string
タイトル:
First Name
最大長:150
個人の名。 -
LastName: string
タイトル:
Last Name
最大長:150
個人の姓。 -
LastUpdateDate: string (date-time)
読取り専用:
true
追加名レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
追加名レコードを最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MiddleName: string
タイトル:
Middle Name
最大長:60
個人のミドル・ネーム。 -
Name: string
タイトル:
Additional Name
最大長:360
レコードの名前。 -
NameId: integer (int64)
読取り専用:
true
名前の一意の識別子。 -
NameType: string
タイトル:
Additional Name Type
最大長:30
AdditionalNameタイプを決定します。 HZ_NAME_AND_ID_TYPES_VL.TYPE_CODEに対して検証できます。 サンプル値: LEGAL,PRIMARY etc.. -
PartyId: integer (int64)
パーティの一意識別子
-
PartyNumber: string
タイトル:
Registry ID
読取り専用:true
最大長:30
パーティの公開一意識別子。 -
PartySourceSystem: string
ソース・システム名。
-
PartySourceSystemReferenceValue: string
元のシステムからのレコードの識別子。
-
PreferredFlag: boolean
タイトル:
Preferred Indicator
最大長:1
デフォルト値:false
この名前タイプ内で、このパーティの優先名として名前を識別します。 指定可能な値は'Y'および'N'です。 デフォルトはNです。 -
SourceSystem: string
関連パーティのソース・システムの名前。
-
SourceSystemReferenceValue: string
関連パーティのソース・システム参照の識別子。
-
StatusFlag: boolean
最大長:
1
デフォルト値:true
レコードをソフト削除するために使用するレコード・ステータス。 受け入れられる値は、アクティブの場合はA、非アクティブの場合はIです。 デフォルト値はAです。 -
Title: string
タイトル:
Title
最大長:60
DonやThe Right Honorableなどの専門職または家族のタイトル -
TransliterationLanguage: string
タイトル:
Transliteration Language
最大長:4
TransliterationLanguageは、外国語で単語や名前の発音に役立ちます。 FND_LANGUAGES.LANGUAGE_CODEに対して検証されます。 サンプル値: US,NL,DK etc.
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
漢字住所行の表記(日本で使用)。 -
AddressLocale: array Address Locales
タイトル:
Address Locales
アドレス・ロケール・リソースは、ローカル・アドレスの表示、作成、更新および削除に使用されます。 住所ロケールには、ローカル言語でのロケーションまたは住所に関する詳細が含まれます。 -
AddressNumber: string
タイトル:
Site Number
最大長:30
住所の代替一意識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プロファイル・オプションZCA_PUID_PREFIXで定義されているプリフィクスは、内部で生成された一意のシーケンス番号と連結されます。 -
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
住所を郵送に使用しないかどうかを示します。 値がYの場合、住所は担当者に郵送するために使用しないでください。 デフォルト値はNです。 住所の作成時にこの属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。 -
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キーのいずれかが必要です。 プロファイル・オプション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
これが関連オブジェクトのプライマリ住所かどうかを示します。 値がTrueの場合、これがプライマリ住所です。 デフォルト値は「False」です。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。 -
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
事業所が検証されたかどうかを示します。 値がTrueの場合、ロケーションが検証されます。 デフォルト値はfalseです。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 -
ValidationStartDate: 文字列(日付)
読取り専用:
true
検証が開始する日付。 この属性は、住所クレンジング中にシステムによって内部的に設定されます。 -
ValidationStatusCode: string
タイトル:
Validation Status
最大長:30
検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
array
Address Locales
array
Address Purposes
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
-
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
住所目的を削除するかどうかを示します。 値がTrueの場合は、住所目的が削除されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。
-
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は非アクティブを示します。
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付文書の一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリの名前。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
添付を作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
添付をアップロードした個人のユーザー名。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
添付レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示すコード。 たとえば、webページです。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の現在のバージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・タイプ(ある場合)を示すコード。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツが失効する日付。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
添付のURL。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
添付を最後に更新した個人のユーザー名。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルの長さ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
添付のテキスト。 -
Uri: string
タイトル:
Uri
最大長:4000
添付のURI。 -
Url: string
タイトル:
Url
最大長:4000
添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付に関連付けられているログイン。
object
-
ConflictId: integer (int64)
デフォルト値:
0
担当者レコードの競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
ContactPointId: integer (int64)
読取り専用:
true
担当者の一意の識別子。 -
ContactPointType: string
タイトル:
Type
最大長:30
担当者レコードのタイプ。 受け入れられる値は、参照タイプCOMMUNICATION_TYPEで定義されます。 値はPHONE、EMAIL、WEBなどです。 -
CreatedBy: string
読取り専用:
true
最大長:64
担当者レコードを作成したユーザー。 -
CreatedByModule: string
タイトル:
Created by Application
デフォルト値:HZ_WS
この担当者レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日付。 -
DoContactPreferenceFlag: boolean
タイトル:
OK to Contact
特定の連絡メソッドを使用するかどうかを示します。 デフォルトはfalseです。 -
DoNotContactPreferenceFlag: boolean
レコードを連絡できるかどうかを示します。
-
DoNotContactReason: string
担当者プリファレンスの事由コード。
-
EmailAddress: string
最大長:
255
Eメール・タイプの担当者レコードのEメール・アドレス。 -
EmailPurpose: string
タイトル:
Email Purpose
最大長:30
EMAIL担当者を使用する目的。 受け入れられる値は、参照タイプCONTACT_POINT_PURPOSEで定義されます。 値は、ASSISTANT、PERSONAL、HOME_BUSINESS、BUSINESSなどになります。 -
FormattedPhoneNumber: string
読取り専用:
true
最大長:255
担当者のフォーマット済電話番号。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
担当者レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
担当者レコードに対するオプティミスティック・ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
-
PartyId: integer (int64)
担当者の関連パーティ・レコードの一意の識別子。
-
PartyNumber: string
関連パーティ・レコードの公開一意識別子。
-
PartySourceSystem: string
担当者が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。 PartyourceSystemReferenceValueとともに、取引先、担当者または世帯レコードの代替キーの一部。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。
-
PartySourceSystemReferenceValue: string
住所が関連付けられているアカウント、担当者または世帯の外部ソース・システムの一意の識別子。 代替キーの一部とPartySourceSystem。 住所が関連付けられているアカウント、担当者または世帯レコードを識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
-
PhoneAreaCode: string
最大長:
255
電話番号の市外局番。 -
PhoneCountryCode: string
最大長:
255
電話番号の国コード。 -
PhoneExtension: string
最大長:
255
オフィス・デスク内線番号などの電話回線番号の内線番号。 -
PhoneNumber: string
最大長:
255
担当者の電話番号。 -
PhonePurpose: string
タイトル:
Phone Purpose
最大長:30
PHONE担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
電話担当者のタイプ。 受け入れられる値は、参照タイプORA_HZ_PHONE_TYPEで定義されます。 値は、WORK、HOME、FAXなどになります。
-
PreferenceRequestedBy: string
タイトル:
Preference Requested By
権限または制限が内部で作成されたか、パーティによってリクエストされたかを示します。 受け入れられる値のリストは、REQUESTED_BY参照で定義されます。 -
PrimaryFlag: boolean
タイトル:
Primary
最大長:1
デフォルト値:false
これが関連オブジェクトのプライマリ担当者かどうかを示します。 値がTrueの場合、これがプライマリ担当者です。 デフォルト値は「False」です。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。 -
RawPhoneNumber: string
最大長:
255
電話タイプの担当者レコードの未処理電話番号。 -
SocialNetworkId: string
ソーシャル・ネットワークの一意の識別子。
-
SocialNetworkName: string
ソーシャル・ネットワークの名前。
-
SocialNetworkPurpose: string
タイトル:
Social Network Purpose
最大長:30
IM担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE.Sample値で定義されます: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
システム設定の一部として管理者が定義する外部ソース・システムの名前。 これは、SourceSystemReferenceとともに代替キーの一部であり、PKまたはpartyNumberBusinessKeyが更新で渡されない場合は必須です。
-
SourceSystemReferenceValue: string
属性SourceSystemで指定された外部ソース・システムからの担当者パーティの一意の識別子。 これは、SourceSystemReferenceとともに代替キーの一部であり、PKまたはpartyNumberBusinessKeyが更新で渡されない場合は必須です。
-
Status: string
最大長:
30
デフォルト値:A
担当者のステータスを示します。 ステータス・コードは、参照HZ_STATUSで定義されます。 デフォルト値はAです。 -
URL: string
担当者のURL。
-
VerificationDate: 文字列(日付)
タイトル:
Verification Date
電話またはEメールの担当者の検証日。 -
VerificationStatus: string
タイトル:
Verification Status
最大長:30
電話またはEメールの担当者の検証のステータス。 受け入れられる値は、標準参照タイプORA_HZ_VALIDATION_STATUSでORA_VALID、ORA_INVALIDおよびORA_PARTIALLY_VALIDとして定義されます。 値ORA_PARTIALLY_VALIDは、電子メールにのみ適用できます。 デフォルト値は空白で、値が検証されないことを示します。 -
WebPurpose: string
タイトル:
Web Purpose
最大長:30
WEB担当者を使用する目的を定義します。 使用可能な値は、参照タイプのCONTACT_POINT_PURPOSE_WEB.Sample値で定義されます: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
object
-
ClassCategory: string
タイトル:
Classification Category
最大長:30
分類カテゴリの名前。 -
ClassCode: string
タイトル:
Classification Code
最大長:30
分類カテゴリを示すコード。 たとえば、High Technology、Customer、Telecomなどです。 -
CodeAssignmentId: integer (int64)
タイトル:
Code Assignment ID
読取り専用:true
顧客分類割当の一意の識別子。 -
ConflictId: integer (int64)
読取り専用:
true
デフォルト値:0
分類レコードに対する競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreatedByModule: string
タイトル:
Created by Module
最大長:30
顧客分類レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
EndDateActive: 文字列(日付)
タイトル:
End Date
分類コードが無効になった日付。 -
IsAuxClassificationFlag: boolean
タイトル:
Auxiliary Classification Status
読取り専用:true
分類カテゴリがユーザー定義グループ分類カテゴリかどうかを示します。 デフォルト値はfalseです。 -
IsIndustryFlag: boolean
タイトル:
Industry Type Status
読取り専用:true
分類カテゴリが産業グループ分類カテゴリであるかどうかを示します。 デフォルト値はfalseです。 -
IsOrgTypeFlag: boolean
タイトル:
Organization Type Status
読取り専用:true
分類カテゴリが組織タイプ分類カテゴリかどうかを示します。 デフォルト値はfalseです。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PartyId: integer (int64)
タイトル:
Party ID
分類が関連付けられているアカウント、担当者または世帯の一意の識別子。 -
PartyNumber: string
タイトル:
Party Number
最大長:30
分類が関連付けられているアカウント、担当者または世帯の一意の代替識別子。 非アクティブなレコードは更新できません。 -
PartySourceSystem: string
タイトル:
Party Source System
分類が関連付けられているアカウント、担当者または世帯の外部ソース・システムの名前。 -
PartySourceSystemReferenceValue: string
タイトル:
Party Source System Reference Value
分類が関連付けられているアカウント、担当者または世帯の外部ソース・システムからの識別子です。 -
PartyType: string
タイトル:
Party Type
読取り専用:true
最大長:30
アカウント、担当者または世帯など、パーティのタイプを示します。 -
PrimaryFlag: boolean
タイトル:
Primary
最大長:1
デフォルト値:false
顧客分類がプライマリ分類かどうかを示します。 デフォルト値はfalseです。 -
SourceSystem: string
タイトル:
Source System
顧客分類のインポート元となる外部ソース・システムの名前。 値は、「設定およびメンテナンス」作業領域の取引先コミュニティ・ソース・システムの管理タスクで構成されます。 -
SourceSystemReferenceValue: string
タイトル:
Source System Reference Value
外部ソースの顧客分類の一意の識別子。 -
StartDateActive: 文字列(日付)
タイトル:
Start Date
顧客分類が作成された日付。 -
Status: string
タイトル:
Status
最大長:1
デフォルト値:A
コード割当がアクティブか非アクティブかを示します。 コード割当は、値がAの場合はアクティブで、値がIの場合は非アクティブです。
object
-
ContactRelationshipId: integer (int64)
タイトル:
Contact Relationship ID
ノートが担当者に関連付けられている場合に移入される関係の一意の識別子。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
ノートに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CreatorPartyId: integer (int64)
タイトル:
Creator Party ID
ノートを作成したユーザーの一意の識別子。 -
CurcyConvRateType: string
タイトル:
Currency Conversion Rate Type
最大長:30
ノートに関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
ノートに関連付けられた通貨コード属性。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DeleteFlag: boolean
タイトル:
Delete Indicator
読取り専用:true
ノートを削除するかどうかを示します。 値がYの場合、ノートを削除する必要があります。 デフォルト値はNです。 -
EmailAddress: string
タイトル:
Primary Email
読取り専用:true
最大長:320
ノートを作成したユーザーの電子メール・アドレス。 -
FormattedAddress: string
タイトル:
Primary Address
読取り専用:true
ノートを作成したユーザーの住所。 -
FormattedPhoneNumber: string
タイトル:
Primary Phone
読取り専用:true
ノートを作成したユーザーの電話番号。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NoteId: integer (int64)
タイトル:
Note ID
読取り専用:true
ノートの一意の識別子。 これはノート表の主キーです。 -
NoteNumber: string
最大長:
30
ノートの代替一意識別子。 システム生成または外部システムからのユーザー・キー。 -
NoteTitle: string
タイトル:
Title
最大長:500
ユーザーが入力したノートのタイトル。 -
NoteTxt: 文字列(バイト)
タイトル:
Note
実際のノート・テキストを保存する列。 -
NoteTypeCode: string
タイトル:
Type
最大長:30
ノートをアセットまたは修正として分類するために使用するコード。 -
ParentNoteId: integer (int64)
タイトル:
Parent Note ID
親ノートの一意の識別子。 -
PartyId: integer (int64)
タイトル:
Party ID
読取り専用:true
パーティの一意の識別子。 -
PartyName: string
タイトル:
Author
読取り専用:true
最大長:360
ノートの作成者の名前。 -
SourceObjectCode: string
タイトル:
Related Object Type
最大長:30
OBJECTS Metadataで定義されたソース・オブジェクトのタイプ(アクティビティ、商談など)を示すコード。 -
SourceObjectId: string
タイトル:
Related Object
最大長:64
OBJECTS Metadataで定義された、アクティビティ、商談など、ソース・オブジェクトの一意の識別子。 -
UpdateFlag: boolean
タイトル:
Update Indicator
読取り専用:true
ノートを更新できるかどうかを示します。 値がYの場合は、ノートを更新できます。 デフォルト値はNです。 -
VisibilityCode: string
タイトル:
Private
最大長:30
デフォルト値:INTERNAL
ノートの表示レベルを指定します。
object
-
Addressee: string
タイトル:
Addressee
最大長:360
世帯の受取人。 -
AddressElementAttribute1: string
タイトル:
Additional Address Element 1
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddressElementAttribute2: string
タイトル:
Additional Address Element 2
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddressElementAttribute3: string
タイトル:
Additional Address Element 3
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddressElementAttribute4: string
タイトル:
Additional Address Element 4
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddressElementAttribute5: string
タイトル:
Additional Address Element 5
最大長:150
柔軟な住所書式をサポートするための追加住所要素。 -
AddressId: integer (int64)
読取り専用:
true
作成中に内部で生成された住所の一意の識別子。 addressId、addressnumberまたはSourceSystemおよびsourceystemreferencevalueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 -
AddressLine1: string
タイトル:
Address Line 1
最大長:240
住所の最初の行。 -
AddressLine2: string
タイトル:
Address Line 2
最大長:240
住所の2行目。 -
AddressLine3: string
タイトル:
Address Line 3
最大長:240
住所の3行目。 -
AddressLine4: string
タイトル:
Address Line 4
最大長:240
住所の4行目。 -
AddressLinesPhonetic: string
タイトル:
Address Lines Phonetic
最大長:560
漢字住所行の表記(日本で使用)。 -
AddressNumber: string
タイトル:
Site Number
最大長:30
住所の代替キー識別子。 AddressId、AddressNumberまたはSourceSystemおよびSourceSystemReferenceValueキーのいずれかを使用して、更新時にアドレス・レコードを識別します。 指定しない場合、自動的に生成されます。 プレフィクスは、プロファイル・オプションZCA_PUID_PREFIXで定義され、内部で生成された一意の順序番号と連結されます。 -
Building: string
タイトル:
Building
最大長:240
特定の住所の特定の建物名または番号。 -
City: string
タイトル:
City
最大長:60
プライマリ住所の市区町村要素。 -
Comments: string
タイトル:
Comments
最大長:2000
プライマリ住所のユーザー指定コメント。 -
ConflictId: integer (int64)
デフォルト値:
0
プライマリ住所レコードに対する競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
CorpCurrencyCode: string
最大長:
15
企業通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
Country: string
タイトル:
Country
最大長:2
プライマリ住所の国コード。 地理の管理タスクを使用して、国コードのリストをレビューします。 -
County: string
タイトル:
County
最大長:60
プライマリ住所の郡要素。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
CurcyConvRateType: string
最大長:
30
住所に関連付けられた通貨換算レート・タイプ。 有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
プライマリ住所に関連付けられた通貨コード。 デフォルト値は、プロファイル・オプションZCA_COMMON_CORPORATE_CURRENCYで指定された値です。 -
DateValidated: 文字列(日付)
タイトル:
Validated Date
住所が最後に検証された日付。 -
DeleteFlag: boolean
タイトル:
Delete Primary Address
プライマリ住所を削除するかどうかを示します。 値がTrueの場合、プライマリ住所は削除されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はnullに設定されます。 -
Description: string
タイトル:
Description
最大長:2000
事業所の詳細な摘要。 -
DoNotValidateFlag: boolean
タイトル:
Don't Validate
最大長:1
現在の検証に関係なく、特定の事業所が住所検証に適格でないことを指定するインジケータです。 -
EndDateActive: 文字列(日付)
タイトル:
To Date
アクティブ・ステータスのプライマリ住所レコードの最終日。 -
FloorNumber: string
タイトル:
Floor
最大長:40
建物番号が指定されている場合、指定された住所または特定の建物の特定の階数。 -
FormattedAddress: string
タイトル:
Address
読取り専用:true
書式設定された住所情報。 -
FormattedMultiLineAddress: 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
リソース・インスタンスに関連付けられたリンク関係。 -
LocationComments: string
タイトル:
Comments
最大長:2000
自由テキスト形式のレコードの追加情報。 -
LocationDirections: string
タイトル:
Location Directions
最大長:640
ロケーションへの道順。 -
LocationId: integer (int64)
この住所の事業所レコードの一意の識別子。
-
LocationIntegrationKey: string
事業所レコードの統合キー。
-
LocationLocationId: integer (int64)
タイトル:
Location ID
プライマリ住所の事業所レコードのシステム識別子。 -
LocationSourceSystem: string
事業所レコードのソース・システムの名前。
-
LocationSourceSystemReferenceValue: string
外部ソース・システムからの関係の一意の識別子。
-
LocationStatusFlag: boolean
最大長:
1
デフォルト値:true
プライマリ住所の所在地レコード。 -
経度: number
タイトル:
Longitude
住所の経度情報。 これは、空間近接性および包含目的で使用されます。 -
Mailstop: string
タイトル:
Mail Stop
最大長:60
組織内のメール・ドロップ・ポイントを示すユーザー定義コード。 -
ObjectVersionNumberLocation: 整数(int32)
プライマリ住所の事業所の内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
ObjectVersionNumberPartySite: 整数(int32)
プライマリ住所のパーティ・サイトの内部バージョン番号。 この番号は、ロックの実装に使用されます。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
OverallPrimaryFlag: boolean
タイトル:
Primary
最大長:1
デフォルト値:false
これが関連オブジェクトのプライマリ住所かどうかを示します。 値がYの場合、住所はプライマリ住所です。 -
PartyId: integer (int64)
住所が関連付けられている取引先、担当者または世帯の一意の識別子。 住所が関連付けられているアカウント、担当者または世帯レコードを一意に識別するには、PartyId、PartyNumberまたはPartySourceSystemおよびPartySourceSystemReferenceValueキーのいずれかが必要です。
-
PartySiteName: string
タイトル:
Site Name
最大長:240
プライマリ住所のパーティ・サイトの名前。 -
PartySiteType: string
タイトル:
One-Time Address
最大長:30
パーティ・サイトのタイプ。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。 -
PostalCode: string
タイトル:
Postal Code
最大長:60
住所の郵便番号エレメントです。 -
PostalPlus4Code: string
タイトル:
Postal Code Extension
最大長:20
米国の郵便番号への4桁の拡張。 -
Province: string
タイトル:
Province
最大長:60
住所の州要素。 -
ShortDescription: string
タイトル:
Short Description
最大長:240
プライマリ住所の短い説明。 -
SourceSystem: string
システム設定の一部として管理者が定義する、コードで示される住所の外部ソース・システムの名前。 設定タスク取引先コミュニティ・ソース・システムの管理を使用して、この属性の値を参照タイプHZ_ORIG_SYSTEMS_VLに事前定義する必要があります。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
SourceSystemReferenceValue: string
外部ソースからの住所の一意の識別子。 SourceSystemとSourceSystemReferenceの組合せは一意であり、住所を識別するための外部キーとして使用されます。
-
StartDateActive: 文字列(日付)
タイトル:
From Date
リソースが販売アカウントに関連付けられている日付。 -
State: string
タイトル:
State
最大長:60
住所の都道府県要素。 -
Status: string
最大長:
1
デフォルト値:A
プライマリ住所のステータスを示します。 ステータス・コードは、参照HZ_STATUSによって定義されます。 -
TimezoneCode: string
タイトル:
Time Zone
最大長:64
プライマリ住所に関連付けられたタイムゾーンのコード。 -
ValidatedFlag: boolean
タイトル:
Validated
最大長:1
デフォルト値:false
事業所が検証されたかどうかを示します。 Y(検証済)、N(無効)。 この値は、住所クレンジング中にシステムによって内部的に設定されます。 デフォルト値はNULLです。 この属性がペイロードで明示的に指定されていない場合、この属性の値はNULLに設定されます。 -
ValidationStatusCode: string
タイトル:
Validation Status
最大長:30
検証のステータスを示すコード。 内部的には、住所クレンジング中にシステムによって設定されます。
object
-
BackwardRole: string
タイトル:
Backward Role
読取り専用:true
関係の記述に使用されるバック・ワード関係コード。 たとえば、SUPPLIER_OFです。 -
Comments: string
タイトル:
Comments
最大長:2000
ユーザーによって提供されたコメント。 -
ConflictId: integer (int64)
デフォルト値:
0
関係レコードの競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
CreatedByModule: string
タイトル:
Created by Application
最大長:30
デフォルト値:HZ_WS
関係レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日時。 -
DependentFlag: string
タイトル:
Dependent Indicator
最大長:1
デフォルト値:N
1つのパーティが別のパーティに依存しているかどうかを示します。 デフォルト値はNです。 -
DirectionCode: string
読取り専用:
true
最大長:30
関係方向のコード。 受け入れられる値のリストは、参照DIRECTION_CODEで定義されます。 有効な値は、P-Parent、C-Child、N-Not Directionalです。 -
EndDate: 文字列(日付)
タイトル:
To Date
関係が終了する日付。 -
HeadOfHouseholdFlag: string
タイトル:
Head of Household Indicator
最大長:1
デフォルト値:N
個人が所属する世帯主であるかどうかを示します。 これはMEMBERSHIP関係にのみ適用され、どのメンバーが世帯主であるかを示すために使用されます。 当該会社の実装によっては、複数の世帯主が存在する場合があります。 -
InfluenceLevel: string
タイトル:
Influence Level
販売担当者が購買関係に与える影響。 サンプル値は、内部円、政治構造、なしです。 -
JobDefinitionName: string
最大長:
100
ジョブ名の定義。 -
JobDefinitionPackage: string
最大長:
900
ジョブ・パッケージの定義。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectPartyId: integer (int64)
この関係にあるオブジェクトの一意の識別子。
-
ObjectPartyName: string
タイトル:
Object Party Name
読取り専用:true
最大長:360
オブジェクト・パーティの名前。 -
ObjectPartyNumber: string
タイトル:
Object Registry ID
最大長:30
関係のオブジェクト・パーティの代替キー識別子。 -
ObjectSourceSystem: string
タイトル:
Object Source System
関係のオブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。 -
ObjectSourceSystemReferenceValue: string
タイトル:
Object Source System Reference
外部ソース・システムからの関係におけるオブジェクト・パーティの一意の識別子。 -
ObjectTableName: string
最大長:
30
この関係のオブジェクト・パーティのソース表名。 -
ObjectType: string
最大長:
30
ORGANIZATION、PERSONなどの関係のオブジェクト・タイプ。 -
ObjectUsageCode: string
最大長:
30
関係におけるオブジェクト・パーティの使用コード。 -
ObjectVersionNumber: 整数(int32)
関係レコードのオプティミスティック・ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
-
ObjectVersionNumber1: 整数(int32)
読取り専用:
true
関係レコードのオプティミスティック・ロックの実装に使用される代替番号。 -
ObjectVersionNumber2: 整数(int32)
読取り専用:
true
関係レコードのオプティミスティック・ロックを実装する代替番号。 -
PartyId: integer (int64)
読取り専用:
true
関連パーティ・レコードの代替一意識別子。 -
PartyId1: integer (int64)
読取り専用:
true
関連パーティ・レコードの代替識別子。 -
PercentageOwnership: number
タイトル:
Ownership Percentage
親エンティティが所有する子エンティティのパーセンテージ。 -
PreferredContactFlag: boolean
最大長:
10
デフォルト値:false
この担当者個人が顧客のプライマリ担当者であるかどうかを示します。 受け入れられる値はYおよびNです。 デフォルト値はNです。 -
PrimaryCustomerFlag: boolean
最大長:
10
デフォルト値:false
この顧客が担当者のプライマリ顧客かどうかを示します。 受け入れられる値はYおよびNです。 デフォルト値はNです。 -
RelationshipCode: string
タイトル:
Relationship Code
最大長:30
これがフォワード関係コードかバック・ワード関係コードかを示すコード。 -
RelationshipId: integer (int64)
読取り専用:
true
関係の一意の識別子。 -
RelationshipRecId: integer (int64)
関係レコードの一意の識別子。
-
RelationshipSourceSystem: string
システム設定の一部として管理者が定義する、関係の外部ソース・システムの名前。
-
RelationshipSourceSystemReferenceValue: string
外部ソース・システムからの関係の一意の識別子。
-
RelationshipType: string
タイトル:
Relationship Type
最大長:30
関係のタイプの名前。 たとえば、CUSTOMER_SUPPLIERです。 -
RequestId: integer (int64)
関係レコードのリクエストの一意の識別子。
-
Role: string
タイトル:
Role
サブジェクト・パーティとオブジェクト・パーティ間のロール。 -
SSROwnerTableName: string
読取り専用:
true
最大長:255
デフォルト値:HZ_PARTIES
レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。 -
StartDate: 文字列(日付)
タイトル:
From Date
関係が開始する日付。 -
Status: string
読取り専用:
true
最大長:1
デフォルト値:A
関係のステータス、Aはアクティブ、Iは非アクティブ。 -
SubjectPartyId: integer (int64)
この関係のサブジェクトの一意の識別子。
-
SubjectPartyName: string
タイトル:
Subject Party Name
読取り専用:true
最大長:360
件名パーティの名前。 -
SubjectPartyNumber: string
タイトル:
Subject Registry ID
最大長:30
関係のサブジェクト・パーティの代替キー識別子。 -
SubjectSourceSystem: string
タイトル:
Subject Source System
関係のサブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。 -
SubjectSourceSystemReferenceValue: string
タイトル:
Subject Source System Reference
外部ソース・システムからの関係におけるサブジェクト・パーティの一意の識別子。 -
SubjectTableName: string
最大長:
30
この関係のサブジェクト・パーティのソース表名。 -
SubjectType: string
最大長:
30
ORGANIZATION、PERSONなどの関係のサブジェクト・タイプ。 -
SubjectUsageCode: string
最大長:
30
関係のサブジェクト・パーティの使用コード。
object
-
AccessLevelCode: string
タイトル:
Access
最大長:30
リソースに付与されたアクセス・レベルと組織のマネージャを示すコード。 指定可能な値は、ZCA_ACCESS_LEVEL参照で定義されます。 「設定およびメンテナンス」作業領域の標準参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
AssignmentTypeCode: string
タイトル:
Assignment Type
最大長:30
デフォルト値:MANUAL
リソースが販売アカウント・チームにどのように割り当てられるかを示すコード。 指定可能な値は、ZCA_ASSIGNMENT_TYPE参照に含まれています。 -
CorpCurrencyCode: string
タイトル:
Corporate Currency Code
最大長:15
営業チーム・メンバーに関連付けられた企業通貨コード。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
レコードを作成したユーザー。 -
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で定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
EndDateActive: 文字列(日付)
タイトル:
Archived Date
リソースが販売アカウントから分離された日付。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
レコードを最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LockAssignmentFlag: boolean
タイトル:
Locked
最大長:1
デフォルト値:false
自動テリトリ割当を設定できるかどうかを示します。 値がTrueの場合、自動テリトリ割当では販売アカウント・チーム・リソースを削除できません。 販売アカウント・チーム・メンバーを手動で追加すると、このフラグはYにデフォルト設定されます。 -
MemberFunctionCode: string
タイトル:
Function
最大長:30
インテグレータ、エグゼクティブ・スポンサ、技術アカウント・マネージャなど、リソース・チームの営業チーム・メンバーのロールを示すコード。 受け入れられる値のリストは、参照FND_LOOKUPSで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
ObjectVersionNumber: 整数(int32)
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
-
OwnerFlag: boolean
タイトル:
Owner
デフォルト値:false
リソースが所有者かどうかを示します。 -
PartyId: integer
営業チーム・メンバー・レコードの関連パーティ・レコードの一意の識別子。
-
PartyNumber: string
関連パーティ・レコードの公開識別子。
-
PartySourceSystem: string
関連パーティ・レコードの外部ソース・システムの名前。
-
PartySourceSystemReferenceValue: string
関連パーティ・レコードの外部ソース・システムからの一意の識別子。
-
ResourceEmailAddress: string
タイトル:
Resource Email
リソースの電子メール・アドレス。 -
ResourceId: integer (int64)
タイトル:
Resource ID
世帯リソースの一意の識別子。 -
ResourceName: string
タイトル:
Resource Name
読取り専用:true
営業チーム・メンバーの名前。 -
ResourceOrgName: string
読取り専用:
true
営業チーム・メンバーが属する組織の名前。 -
ResourcePartyNumber: string
タイトル:
Resource Party Number
このチーム・メンバーが属するリソースの代替キー識別子。 -
ResourcePhoneNumber: string
タイトル:
Phone
読取り専用:true
営業チーム・メンバーのプライマリ電話番号。 -
ResourceRoleName: string
タイトル:
Role
読取り専用:true
営業チーム・メンバーに割り当てられたロールの名前。 -
SalesProfileId: integer (int64)
タイトル:
Sales Account ID
販売アカウントの一意の識別子。 -
StartDateActive: 文字列(日付)
タイトル:
Start Date
リソースが販売アカウントに関連付けられている日付。 -
TeamMemberId: integer (int64)
タイトル:
Sales Account Resource ID
販売アカウント・リソース・チームのメンバーの一意の識別子。 -
UserLastUpdateDate: string (date-time)
タイトル:
User Last Update Date
レコードが最後に更新された日時。 更新が最初に別のデータベースで発生した場合、この値はLAST_UPDATE_DATEとは異なります。
object
-
ConflictId: integer (int64)
デフォルト値:
0
競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。 -
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreatedByModule: string
デフォルト値:
HZ_WS
レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
レコードが作成された日付。 -
EndDate: 文字列(日付)
レコードが無効になる日付。
-
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectVersionNumber: 整数(int32)
ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始日と終了日に比較され、別のセッションがその行を更新したかどうかが判断されます。
-
PartyId: integer (int64)
関連付けられたアカウントの一意の識別子。
-
PartyNumber: string
タイトル:
Party Number
関連付けられたアカウントの代替一意識別子。 非アクティブなレコードは更新できません。 -
PartySourceSystem: string
タイトル:
Party Source System
アカウントのソース・システム名。 -
PartySourceSystemReferenceValue: string
タイトル:
Party Source System Reference Value
外部ソース・システムからのレコードの識別子。 -
SourceSystem: string
タイトル:
Source System
最大長:30
ソース・システムの名前。 -
SourceSystemReferenceId: integer (int64)
読取り専用:
true
ソース・システム参照の一意の識別子。 -
SourceSystemReferenceValue: string
最大長:
255
関連アカウントの識別に必要なソース・システム参照値。 -
StartDate: 文字列(日付)
レコードが作成された日付。
-
Status: string
最大長:
1
デフォルト値:A
ソース・システムへのマッピングがアクティブであることを示します。 値がAの場合、マッピングはアクティブです。 値がIの場合、マッピングは非アクティブです。
例:
cURLコマンド
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての世帯を取得する方法を示しています。
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households
サポートされているレコード・セット
世帯リソースは次のレコード・セットをサポートします。
レコード・セット | 摘要 | cURLコマンド |
---|---|---|
ALLACCTS |
現在のユーザーに表示されるすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='ALLACCTS' |
MYACCTS |
現在のユーザーが所有する販売アカウントに関連付けられているすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYACCTS' |
MYASSGDESCTERRACCTS |
現在のユーザーの販売アカウントのテリトリおよび子テリトリ内のすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYASSGDESCTERRACCTS' |
MYASSGTERRACCTS |
現在のユーザーの販売アカウントに割り当てられているテリトリ内のすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYASSGTERRACCTS' |
MYSALESTEAMACCTS |
現在のユーザーのセールス取引先チームのすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYSALESTEAMACCTS' |
MYSUBORDINATESACCTS |
現在のユーザーおよび現在のユーザーの部下が所有している世帯をすべてリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYSUBORDINATESACCTS' |
MYSUBORDSSALESTEAMACCTS |
現在のユーザーと部下の販売アカウント・チームのすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYSUBORDSSALESTEAMACCTS' |
MYSALESTEAMTERRACCTS |
現在のユーザーの販売アカウント・チームのすべての世帯と、現在のユーザーの販売アカウントに割り当てられたテリトリ内のすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYSALESTEAMTERRACCTS' |
MYSUBORDTEAMTERRACCTS |
現在のユーザーと部下の販売アカウント・チームのすべての世帯、および現在のユーザーおよび部下の販売アカウントに割り当てられたテリトリのすべての世帯をリストします。 |
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households?q=RecordSet='MYSUBORDTEAMTERRACCTS' |
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{ "PartyId" : 300100017936180, "PartyStatus" : "A", "PartyUniqueName" : "Baker Household (Redwood City, US)", "CreatedBy" : "DATA_STEWARD_MGR", "CreationDate" : "2013-01-07 00:37:14.001", "LastUpdateDate" : "2014-10-20 07:57:36.229", "LastUpdateLogin" : "05DCCBB13AA8189BE05395D0F00A0334", "LastUpdatedBy" : "SALES_ADMIN", "PartyNumber" : "CDRM_9049", "HouseholdName" : "Pinnacle Inc", "HouseholdSize" : 0, "UniqueNameSuffix" : "(Redwood City, US)", "PreferredFunctionalCurrency" : null, "Comments" : null, ... }