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

機械翻訳について

住所の更新

patch

/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}

リクエスト

パス・パラメータ

AddressNumber(required): string

作成中に内部的に生成された住所の代替キー識別子。 AddressIdキーまたはAddressNumberキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
CompanyNumber(required): string

パートナの会社の代替キー識別子。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

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

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

柔軟な住所書式をサポートするための追加の住所要素。
AddressLineFour: string

タイトル: Address Line 4

最大長: 240

住所の4行目。
AddressLineOne: string

タイトル: Address Line 1

最大長: 240

住所の最初の行。
AddressLinesPhonetic: string

タイトル: Address Lines Phonetic

最大長: 560

漢字の住所行の表記またはカナ。これは日本の住所に使用されます。
AddressLineThree: string

タイトル: Address Line 3

最大長: 240

住所の3行目。
AddressLineTwo: string

タイトル: Address Line 2

最大長: 240

住所の2行目。
AddressType: string

タイトル: Type

請求先住所、出荷先住所など、住所タイプの参照コード。
Building: string

タイトル: Building

最大長: 240

住所の建物名または番号。
City: string

タイトル: City

最大長: 60

住所の市区町村。
ClliCode: string

タイトル: CLLI Code

最大長: 60

住所の共通言語のロケーション識別子(CLLI)コード。このコードは、住所の所在地を指定するために北米で使用されます。
Comments: string

タイトル: Comments

最大長: 2000

住所に対するユーザー指定のコメント。
CorpCurrencyCode: string

最大長: 15

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

タイトル: Country

最大長: 2

住所の国。地理の管理タスクを使用して国のリストをレビューします。
County: string

タイトル: County

最大長: 60

住所の郡。
CreatedByModule: string

タイトル: Created by Application

最大長: 30

住所レコードを作成したモジュール。
CurcyConvRateType: string

最大長: 30

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

タイトル: Currency

最大長: 15

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

タイトル: Validated Date

住所が最後に検証された日付。
Description: string

タイトル: Description

最大長: 2000

事業所の摘要。
DoNotMailFlag: boolean

タイトル: Contact Preferences

デフォルト値: false

住所を郵送に使用しないかどうかを示します。
FloorNumber: string

タイトル: Floor

最大長: 40

住所の階数。
緯度: number

タイトル: Latitude

住所の緯度情報。ロケーションの緯度情報は、空間近接および包含目的で使用されます。
LocationDirections: string

タイトル: Location Directions

最大長: 640

住所のロケーションへの道順。
LocationId: integer (int64)

タイトル: Location ID

事業所の一意の識別子。
経度: number

タイトル: Longitude

住所の経度情報。ロケーションの経度情報は、空間的近接性および包含目的で使用されます。
Mailstop: string

タイトル: Mail Stop

最大長: 60

組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
PartyId: integer (int64)

タイトル: Party ID

住所に関連付けられたパートナの一意の識別子。
PostalCode: string

タイトル: Postal Code

最大長: 60

住所の郵便番号。
PostalPlus4Code: string

タイトル: Postal Code Extension

最大長: 20

住所の米国郵便番号への4桁の内線番号。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

これがパートナのプライマリ住所かどうかを示します。値がYの場合、この住所はパートナのプライマリ住所です。デフォルト値はNです。
Province: string

タイトル: Province

最大長: 60

住所の州。
SourceSystem: string

外部ソース・システムからのレコードの識別子。
SourceSystemReferenceValue: string

外部ソース・システムの名前。
State: string

タイトル: State

最大長: 60

住所の状態。
ValidatedFlag: boolean

タイトル: Validated

最大長: 1

デフォルト値: false

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

{
    "type":"object",
    "properties":{
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The building name or number in the address.",
            "nullable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the address.",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N.",
            "nullable":false,
            "default":false
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the location.",
            "nullable":true
        },
        "AddressLineOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "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"
            }
        },
        "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
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the address. 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
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":60,
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address.",
            "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
        },
        "AddressLineThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "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
        },
        "AddressLineTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"The module that created the address record.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the address associated with the contact. A list of accepted values is defined in the lookup\nZCA_COMMON_CORPORATE_CURRENCY.Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates whether the address should not be used for mailing.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "DateValidated":{
            "title":"Validated Date",
            "type":"string",
            "description":"The date when the address was last validated.",
            "format":"date",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the address.",
            "nullable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AddressLineFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":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
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":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"
            }
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address 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
        },
        "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"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the partner associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the address. Review the list of countries using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The lookup code for the type of address, such as billing address, shipping address etc.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : partners-addresses-item-response

タイプ: object

ソースを表示

AddrElementAttribute1: string

タイトル: Additional Address Element 1

最大長: 150

柔軟な住所書式をサポートするための追加の住所要素。
AddrElementAttribute2: string

タイトル: Additional Address Element 2

最大長: 150

柔軟な住所書式をサポートするための追加の住所要素。
AddrElementAttribute3: string

タイトル: Additional Address Element 3

最大長: 150

柔軟な住所書式をサポートするための追加の住所要素。
AddrElementAttribute4: string

タイトル: Additional Address Element 4

最大長: 150

柔軟な住所書式をサポートするための追加の住所要素。
AddrElementAttribute5: string

タイトル: Additional Address Element 5

最大長: 150

柔軟な住所書式をサポートするための追加の住所要素。
AddressId: integer (int64)

読取り専用: true

住所の一意の識別子。
AddressLineFour: string

タイトル: Address Line 4

最大長: 240

住所の4行目。
AddressLineOne: string

タイトル: Address Line 1

最大長: 240

住所の最初の行。
AddressLinesPhonetic: string

タイトル: Address Lines Phonetic

最大長: 560

漢字の住所行の表記またはカナ。これは日本の住所に使用されます。
AddressLineThree: string

タイトル: Address Line 3

最大長: 240

住所の3行目。
AddressLineTwo: string

タイトル: Address Line 2

最大長: 240

住所の2行目。
AddressNumber: string

タイトル: Site Number

最大長: 30

作成中に内部的に生成された住所の代替キー識別子。 AddressIdキーまたはAddressNumberキーのいずれかを使用して、更新時にアドレス・レコードを識別します。
AddressType: string

タイトル: Type

請求先住所、出荷先住所など、住所タイプの参照コード。
Building: string

タイトル: Building

最大長: 240

住所の建物名または番号。
City: string

タイトル: City

最大長: 60

住所の市区町村。
ClliCode: string

タイトル: CLLI Code

最大長: 60

住所の共通言語のロケーション識別子(CLLI)コード。このコードは、住所の所在地を指定するために北米で使用されます。
Comments: string

タイトル: Comments

最大長: 2000

住所に対するユーザー指定のコメント。
CorpCurrencyCode: string

最大長: 15

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

タイトル: Country

最大長: 2

住所の国。地理の管理タスクを使用して国のリストをレビューします。
CountryName: string

読取り専用: true

パートナ企業の国名。
County: string

タイトル: County

最大長: 60

住所の郡。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

住所レコードを作成したユーザー。
CreatedByModule: string

タイトル: Created by Application

最大長: 30

住所レコードを作成したモジュール。
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

住所が最後に検証された日付。
Description: string

タイトル: Description

最大長: 2000

事業所の摘要。
DoNotMailFlag: boolean

タイトル: Contact Preferences

デフォルト値: false

住所を郵送に使用しないかどうかを示します。
FloorNumber: string

タイトル: Floor

最大長: 40

住所の階数。
FormattedAddress: string

タイトル: Address

読取り専用: true

住所の書式付きバージョン。
FormattedMultilineAddress: string

タイトル: Address

読取り専用: true

住所の書式付き複数行バージョン。
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

組織内のメール・ドロップ・ポイントを示すユーザー定義コード。
PartyId: integer (int64)

タイトル: Party ID

住所に関連付けられたパートナの一意の識別子。
PostalCode: string

タイトル: Postal Code

最大長: 60

住所の郵便番号。
PostalPlus4Code: string

タイトル: Postal Code Extension

最大長: 20

住所の米国郵便番号への4桁の内線番号。
PrimaryFlag: boolean

タイトル: Primary

最大長: 1

デフォルト値: false

これがパートナのプライマリ住所かどうかを示します。値がYの場合、この住所はパートナのプライマリ住所です。デフォルト値はNです。
Province: string

タイトル: Province

最大長: 60

住所の州。
SourceSystem: string

外部ソース・システムからのレコードの識別子。
SourceSystemReferenceValue: string

外部ソース・システムの名前。
State: string

タイトル: State

最大長: 60

住所の状態。
ValidatedFlag: boolean

タイトル: Validated

最大長: 1

デフォルト値: false

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

{
    "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
        },
        "AddressLineOne":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "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
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the address. 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
        },
        "ClliCode":{
            "title":"CLLI Code",
            "maxLength":60,
            "type":"string",
            "description":"The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address.",
            "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
        },
        "AddressLineTwo":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreatedByModule":{
            "title":"Created by Application",
            "maxLength":30,
            "type":"string",
            "description":"The module that created the address record.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The unique identifier of the address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the address associated with the contact. A list of accepted values is defined in the lookup\nZCA_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
        },
        "DoNotMailFlag":{
            "title":"Contact Preferences",
            "type":"boolean",
            "description":"Indicates whether the address should not be used for mailing.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the address record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "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
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The formatted multiline version of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "AddrElementAttribute3":{
            "title":"Additional Address Element 3",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"An additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "title":"Validated",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the location 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
        },
        "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
        },
        "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
        },
        "AddressNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the address. Review the list of countries using the Manage Geographies task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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 address.",
            "nullable":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The floor number of the address.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the location.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryName":{
            "type":"string",
            "description":"The name of the country of the partner company.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Country"
                ]
            },
            "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 address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "AddressLineThree":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "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 address was last validated.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressLineFour":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line for address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "SourceSystemReferenceValue":{
            "type":"string",
            "description":"The name of the external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the partner associated with the address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressType":{
            "title":"Type",
            "type":"string",
            "description":"The lookup code for the type of address, such as billing address, shipping address etc.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"The identifier of the record from external source system.",
            "nullable":true,
            "x-queryable":false
        },
        "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

テリトリ・リソースは、ISO標準テリトリのリストを取得するために使用されます。

「トップに戻る」