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

住所の取得

get

/crmRestApi/resources/11.13.18.05/subscriptionAccounts/{SubscrAccountNumber}/child/subscriptionAccountAddress/{AddressNumber}

リクエスト

パス・パラメータ

AddressNumber(required): string

サブスクリプション・アカウントの住所を一意に識別する英数字。
SubscrAccountNumber(required): string

サブスクリプション・アカウントの代替一意識別子。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : subscriptionAccounts-subscriptionAccountAddress-item-response

タイプ: object

ソースを表示

AddrElementAttribute1: string

タイトル: Additional Address Element 1

最大長: 150

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

タイトル: Additional Address Element 2

最大長: 150

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

タイトル: Additional Address Element 3

最大長: 150

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

タイトル: Additional Address Element 4

最大長: 150

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

タイトル: Additional Address Element 5

最大長: 150

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

タイトル: Address Line 1

最大長: 240

住所の1行目。
Address2: string

タイトル: Address Line 2

最大長: 240

住所の2行目。
Address3: string

タイトル: Address Line 3

最大長: 240

住所の3行目。
Address4: string

タイトル: Address Line 4

最大長: 240

住所の4行目。
AddressId: integer (int64)

タイトル: Address Identifier

読取り専用: true

サブスクリプション・アカウント住所レコードの一意の識別子。
AddressLinesPhonetic: string

タイトル: Address Lines Phonetic

最大長: 560

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

タイトル: Address Number

最大長: 30

サブスクリプション・アカウントの住所を一意に識別する英数字。
AddressType: string

タイトル: Address Type

最大長: 100

住所タイプは、住所のタイプを示す値を含む静的選択リストです
Building: string

タイトル: Building

最大長: 240

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

タイトル: City

最大長: 60

郵便番号の市区町村コンポーネント。
Country: string

タイトル: Country

最大長: 2

郵便番号の国コンポーネント。
County: string

タイトル: County

最大長: 60

郵便番号の国コンポーネント。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

サブスクリプション・アカウント住所を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

サブスクリプション・アカウント住所が作成された日時。
CustomerAccountId: string

読取り専用: true

顧客アカウントの一意の識別子。
CustomerAccountSiteId: string

読取り専用: true

顧客アカウント側の一意の識別子。
DeleteFlag: boolean

読取り専用: true

サブスクリプション・アカウント住所を削除できるかどうかを示します。
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

サブスクリプション・アカウント住所を最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

読取り専用: true

サブスクリプション・アカウント住所のロケーション。
PartySiteId: string

読取り専用: true

パーティ住所の一意の識別子。
PostalCode: string

タイトル: Postal Code

最大長: 60

サブスクリプション・アカウント住所の郵便番号。
PostalPlus4Code: string

タイトル: Postal Code Extension

最大長: 20

アメリカ合衆国の郵便番号の4桁の拡張子。
PrimaryFlag: boolean

タイトル: Primary Address

最大長: 1

デフォルト値: false

サブスクリプション・アカウントのプライマリ住所を示します。
Province: string

タイトル: Province

最大長: 60

リソースの住所の州の名前。
SetCode: string

読取り専用: true

レコードの参照セット。
SetId: string

読取り専用: true

セットの一意の識別子。
SiteUseId: string

読取り専用: true

パーティ・サイト使用目的の一意の識別子。
State: string

タイトル: State

最大長: 60

郵送先住所の都道府県コンポーネント。
SubscrAccountNumber: string

タイトル: Subscription Account Number

読取り専用: true

最大長: 30

サブスクリプション・アカウントの代替一意識別子。
UpdateFlag: boolean

読取り専用: true

サブスクリプション・アカウント住所を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "SiteUseId":{
            "type":"string",
            "description":"The unique identifier of the party site usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Building":{
            "title":"Building",
            "maxLength":240,
            "type":"string",
            "description":"The specific building name or number of a given address.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the subscription account address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FloorNumber":{
            "title":"Floor",
            "maxLength":40,
            "type":"string",
            "description":"The specific floor number at a given address or in a particular building when the building number is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary Address",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the primary address of a subscription account.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CustomerAccountSiteId":{
            "type":"string",
            "description":"The unique identifier of the customer account side.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the subscription account 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 country component of a postal address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            },
            "x-queryable":true
        },
        "SetCode":{
            "type":"string",
            "description":"The reference set of the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account address can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address4",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 4",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"string",
            "description":"The unique identifier of the customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"string",
            "description":"The unique identifier of the party address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressLinesPhonetic":{
            "title":"Address Lines Phonetic",
            "maxLength":560,
            "type":"string",
            "description":"The phonetic or Kana representation of the Kanji address lines (used in Japan).",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SubscrAccountNumber":{
            "title":"Subscription Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the subscription account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address Identifier",
            "type":"integer",
            "description":"The unique identifier of the subscription account address record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the subscription account address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the subscription account address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "type":"string",
            "description":"The complete street address of a location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "AddrElementAttribute5":{
            "title":"Additional Address Element 5",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address3",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 3",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city component of a postal address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "AddrElementAttribute1":{
            "title":"Additional Address Element 1",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute2":{
            "title":"Additional Address Element 2",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedMultilineAddress":{
            "title":"Address",
            "type":"string",
            "description":"The complete street address of a location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the subscription account address can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The name of the province for address of resource.",
            "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":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "AddrElementAttribute4":{
            "title":"Additional Address Element 4",
            "maxLength":150,
            "type":"string",
            "description":"The additional address element to support flexible address format.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Code Extension",
            "maxLength":20,
            "type":"string",
            "description":"The four digit extension to the United States Postal ZIP code.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalPlus4Code",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code Extension"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state component of a postal address.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "AddressNumber":{
            "title":"Address Number",
            "maxLength":30,
            "type":"string",
            "description":"An alphanumeric number that uniquely identifies the address for a subscription account.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The country component of a postal address.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SetId":{
            "type":"string",
            "description":"The unique identifier of the set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":100,
            "type":"string",
            "description":"The address type is the static choice list with values indicating the type of address",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the subscription account address was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the subscription account address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Location":{
            "type":"string",
            "description":"The location of the subscription account address.",
            "nullable":true,
            "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."
        }
    }
}

リンク

AddressTypeListVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_ATC_SUBSC_ACC_ADDRESS_TYPE

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

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

CountryVA

操作: /crmRestApi/resources/11.13.18.05/fndTerritories

パラメータ:

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

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

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

YesNoPrimaryVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

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

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

「トップに戻る」