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

機械翻訳について

プライマリ住所の更新

patch

/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

リクエスト

パス・パラメータ

AddressNumber(required): string

このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。例: products?q=InventoryItemId=
PartyNumber(required): string

アカウント・パーティの一意の代替識別子。プロファイル・オプションHZ_GENERATE_PARTY_NUMBERがTrueに設定されている場合、値を更新できます。デフォルト値は、プロファイル・オプションZCA_PUID_PREFIXで指定された値と一意のシステム生成順序番号を連結した値です。非アクティブなレコードは更新できません。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

Addressee: string

タイトル: Addressee

最大長: 360

競合の一意の識別子。この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
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

プライマリ住所の1行目。
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キーのいずれかを使用して、更新時にアドレス・レコードを識別します。
Building: string

タイトル: Building

最大長: 240

プライマリ住所の建物名または番号。
City: string

タイトル: City

最大長: 60

プライマリ住所の市区町村要素。
Comments: string

タイトル: Comments

最大長: 2000

プライマリ住所のユーザー指定コメント。
ConflictId: integer (int64)

デフォルト値: 0

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

最大長: 15

アカウントに関連付けられた企業通貨コード。受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
Country: string

タイトル: Country

最大長: 2

プライマリ住所の国コード。地理の管理タスクを使用して、国コードのリストをレビューします。
County: string

タイトル: County

最大長: 60

プライマリ住所の郡。
CurcyConvRateType: string

最大長: 30

通貨換算レート・タイプ。有効な値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
CurrencyCode: string

タイトル: Currency

最大長: 15

通貨コード。有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
DateValidated: 文字列(日付)

タイトル: Validated Date

プライマリ住所が最後に検証された日付。
DeleteFlag: boolean

タイトル: Delete Primary Address

プライマリ住所を削除するかどうかを示します。値がYの場合、プライマリ住所を削除する必要があります。デフォルト値はNです。
Description: string

タイトル: Description

最大長: 2000

事業所の摘要。
DoNotValidateFlag: boolean

タイトル: Don't Validate

最大長: 1

DNCオプションを示す担当者プリファレンスを示します。
EndDateActive: 文字列(日付)

タイトル: To Date

アクティブ・ステータスのレコードの最終日。
FloorNumber: string

タイトル: Floor

最大長: 40

プライマリ住所の階数。
HouseType: string

タイトル: House Type

最大長: 30

住所の建物の建物タイプを示します。有効な値のリストは、参照HZ_HOUSE_TYPEで定義されます。「設定および保守」作業領域の「標準参照の管理」タスクを使用して、コードを確認、更新します。
緯度: number

タイトル: Latitude

住所の緯度情報。ロケーションの緯度情報は、空間近接および包含目的で使用されます。
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の場合、住所はプライマリ住所です。
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

住所のインポート元の外部ソース・システムの名前。設定タスク取引先コミュニティ・ソース・システムで構成された値。
SourceSystemReferenceValue: string

属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
State: string

タイトル: State

最大長: 60

住所の状態。
Status: string

最大長: 1

デフォルト値: A

レコードのステータス。
TimezoneCode: string

タイトル: Time Zone

最大長: 64

事業所のタイム・ゾーン。
ValidatedFlag: boolean

タイトル: Validated

最大長: 1

デフォルト値: false

事業所が検証済かどうかを示します。この値は、住所クレンジング中にシステムによって内部的に設定されます。値がYの場合、住所が検証されます。デフォルト値はNです。
ValidationStatusCode: string

タイトル: Validation Status

最大長: 30

検証のステータスを示すコード。内部的には、住所クレンジング中にシステムによって設定されます。

{
    "type":"object",
    "properties":{
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are 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
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":240,
            "type":"string",
            "description":"The brief free text that describes the site record.",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. A list of valid values are 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
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":60,
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the contact preference to indicate DNC option.",
            "nullable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "default":"A"
        },
        "OverallPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.",
            "nullable":false,
            "default":false
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true
        },
        "LocationLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The system identifier for the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city element of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true
        },
        "LocationStatusFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The status flag for location record.",
            "nullable":false,
            "default":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "DeleteFlag":{
            "title":"Delete Primary Address",
            "type":"boolean",
            "description":"Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.",
            "nullable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "LocationComments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The additional information for the record in free text format.",
            "nullable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            }
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a record in active status.",
            "format":"date",
            "nullable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the primary address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number in the primary address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the primary address.",
            "nullable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":64,
            "type":"string",
            "description":"The time zone for the location.",
            "nullable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the location.",
            "nullable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location object. The number used to implement 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 determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":30,
            "type":"string",
            "description":"The type information of the party site.",
            "nullable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the building type for the building in the address. A list of valid values are 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"
            }
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the primary address was last validated.",
            "format":"date",
            "nullable":true
        },
        "LocationSourceSystem":{
            "type":"string",
            "description":"The name of source system for the location record.",
            "nullable":true
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":360,
            "type":"string",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the primary address.",
            "nullable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LocationSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true
        },
        "ObjectVersionNumberPartySite":{
            "type":"integer",
            "description":"The internal version number for the party site object. The number used to implement 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 determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : accounts-PrimaryAddress-item-response

タイプ: object

ソースを表示

Addressee: string

タイトル: Addressee

最大長: 360

競合の一意の識別子。この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
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

プライマリ住所の一意の識別子。
AddressLine1: string

タイトル: Address Line 1

最大長: 240

プライマリ住所の1行目。
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キーのいずれかを使用して、更新時にアドレス・レコードを識別します。
Building: string

タイトル: Building

最大長: 240

プライマリ住所の建物名または番号。
City: string

タイトル: City

最大長: 60

プライマリ住所の市区町村要素。
Comments: string

タイトル: Comments

最大長: 2000

プライマリ住所のユーザー指定コメント。
ConflictId: integer (int64)

デフォルト値: 0

競合の一意の識別子。
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

プライマリ住所を削除するかどうかを示します。値がYの場合、プライマリ住所を削除する必要があります。デフォルト値はNです。
Description: string

タイトル: Description

最大長: 2000

事業所の摘要。
DoNotValidateFlag: boolean

タイトル: Don't Validate

最大長: 1

DNCオプションを示す担当者プリファレンスを示します。
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)

住所に関連付けられたアカウントの一意の識別子。
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

住所のインポート元の外部ソース・システムの名前。設定タスク取引先コミュニティ・ソース・システムで構成された値。
SourceSystemReferenceValue: string

属性PartySourceSystemで指定された外部ソース・システムからのアドレスの一意の識別子。
StartDateActive: 文字列(日付)

タイトル: From Date

レコードが有効になる日付。
State: string

タイトル: State

最大長: 60

住所の状態。
Status: string

最大長: 1

デフォルト値: A

レコードのステータス。
TimezoneCode: string

タイトル: Time Zone

最大長: 64

事業所のタイム・ゾーン。
ValidatedFlag: boolean

タイトル: Validated

最大長: 1

デフォルト値: false

事業所が検証済かどうかを示します。この値は、住所クレンジング中にシステムによって内部的に設定されます。値がYの場合、住所が検証されます。デフォルト値はNです。
ValidationStatusCode: string

タイトル: Validation Status

最大長: 30

検証のステータスを示すコード。内部的には、住所クレンジング中にシステムによって設定されます。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type. A list of valid values are 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
        },
        "ShortDescription":{
            "title":"Short Description",
            "maxLength":240,
            "type":"string",
            "description":"The brief free text that describes the site record.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. A list of valid values are 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
        },
        "Mailstop":{
            "title":"Mail Stop",
            "maxLength":60,
            "type":"string",
            "description":"The user-defined code that indicates a mail drop point within the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "DoNotValidateFlag":{
            "title":"Don't Validate",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the contact preference to indicate DNC option.",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the primary address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the account. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "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":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the primary address record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverallPrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the validation. Internally set by system during address cleansing.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The system identifier for the location record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city element of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationStatusFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The status flag for location record.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Primary Address",
            "type":"boolean",
            "description":"Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "LocationComments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The additional information for the record in free text format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four-digit extension to the United States Postal ZIP code for the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The last date for a record in active status.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationDirections":{
            "title":"Location Directions",
            "maxLength":640,
            "type":"string",
            "description":"The directions to the address location.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The primary address's internal unique identifier that is internally generated during creation. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country code of the primary address. Review the list of country codes using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number in the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":64,
            "type":"string",
            "description":"The time zone for the location.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationIntegrationKey":{
            "type":"string",
            "description":"The integration key for the location record.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"The internal version number for the location object. The number used to implement 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 determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AddressElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the address.",
            "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 of the primary address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date on which the record becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartySiteType":{
            "title":"One-Time Address",
            "maxLength":30,
            "type":"string",
            "description":"The type information of the party site.",
            "nullable":true,
            "x-queryable":true
        },
        "HouseType":{
            "title":"House Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the building type for the building in the address. A list of valid values are 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
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.",
            "nullable":true,
            "x-queryable":true
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the primary address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LocationSourceSystem":{
            "type":"string",
            "description":"The name of source system for the location record.",
            "nullable":true,
            "x-queryable":true
        },
        "Addressee":{
            "title":"Addressee",
            "maxLength":360,
            "type":"string",
            "description":"The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Addressee",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Addressee"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the primary address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationSourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier of the relationship from external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberPartySite":{
            "type":"integer",
            "description":"The internal version number for the party site object. The number used to implement 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 determine whether another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultiLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystem":{
            "type":"string",
            "description":"The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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."
        }
    }
}

リンク

CountriesLOV

操作: /crmRestApi/resources/11.13.18.05/fndTerritories

パラメータ:

ファインダ: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN

USまたはUKなど、住所の国コードを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: 国、ターゲット属性: TerritoryCode
表示属性: TerritoryShortName

HouseTypeLookupLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DHZ_HOUSE_TYPE

ハウス・ボートやトレーラなど、プライマリ住所の家屋タイプを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: HouseType;ターゲット属性: LookupCode
表示属性: 意味

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するパッチ・リクエストを発行することによってプライマリ・アドレスを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/CDRM_336942/child/PrimaryAddress/CDRM_100949

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
    "AddressLine1": "600 Oracle Parkway",
    "City": "Redwood Shores",
    "State": "CA",
    "Country": "US"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "AddressId": 300100046397212,
    "AddressNumber": "CDRM_100949",
    "AddressLine1": "600 Oracle Parkway",
    "City": "Redwood Shores ",
    "Country": "US",
    "State": "CA",
    "FormattedMultiLineAddress": "600 Oracle Parkway Redwood Shores, CA",
    ...
}

「トップに戻る」