1つの住所の取得
get
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/addresses/{SupplierAddressId}
リクエスト
パス・パラメータ
- SupplierAddressId(required): integer(int64)
サプライヤ住所を一意に識別する値。
- SupplierId(required): integer(int64)
サプライヤを一意に識別する値。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : suppliers-addresses-item-response
タイプ:
ソースを表示
object
-
AdditionalAddressAttribute1: string
タイトル:
Additional Address Element 1
最大長:150
フレキシブル・サプライヤ住所書式の最初の追加住所属性。 -
AdditionalAddressAttribute2: string
タイトル:
Additional Address Element 2
最大長:150
フレキシブル・サプライヤ住所書式の2番目の追加住所属性。 -
AdditionalAddressAttribute3: string
タイトル:
Additional Address Element 3
最大長:150
フレキシブル・サプライヤ住所書式の3番目の追加住所属性。 -
AdditionalAddressAttribute4: string
タイトル:
Additional Address Element 4
最大長:150
フレキシブル・サプライヤ住所書式の4番目の追加住所属性です。 -
AdditionalAddressAttribute5: string
タイトル:
Additional Address Element 5
最大長:150
フレキシブル・サプライヤ住所書式の5番目の追加住所属性。 -
Addressee: string
タイトル:
Addressee
最大長:360
サプライヤ住所の受取人。 -
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行目。 -
AddressName: string
タイトル:
Address Name
最大長:240
サプライヤ担当者に関連付けられたサプライヤ住所の名前。 -
AddressPurposeOrderingFlag: boolean
タイトル:
Ordering
最大長:255
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、オーダーにサプライヤ住所を使用できます。 falseの場合、このアドレスは使用できません。 デフォルト値はfalseです。 -
AddressPurposeRemitToFlag: boolean
タイトル:
Remit to
最大長:255
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ住所を使用して支払を送信できます。 falseの場合、このアドレスは使用できません。 デフォルト値はfalseです。 -
AddressPurposeRFQOrBiddingFlag: boolean
タイトル:
RFQ or Bidding
最大長:255
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、提案または入札のリクエストにサプライヤ住所を使用できます。 falseの場合、このアドレスは使用できません。 デフォルト値はfalseです。 -
Building: string
タイトル:
Building
最大長:240
サプライヤ住所の建物です。 -
City: string
タイトル:
City or Locality
最大長:60
サプライヤ住所の市区町村です。 -
Country: string
タイトル:
Country
最大長:80
サプライヤ住所の国。 -
CountryCode: string
タイトル:
Country Code
最大長:2
サプライヤ住所がある国を識別する略称です。 -
County: string
タイトル:
County
最大長:60
サプライヤ住所の郡。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
サプライヤ・レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ユーザーがサプライヤ・レコードを作成した日付。 -
DFF: array Flexfields for Supplier Address
タイトル:
Flexfields for Supplier Address
サプライヤ住所リソースのフレックスフィールドは、サプライヤ住所付加フレックスフィールドを管理します。 -
Email: string
タイトル:
Email
最大長:320
サプライヤ住所のEメール。 -
FaxAreaCode: string
タイトル:
Fax Area Code
最大長:20
サプライヤ住所のFAXのエリアを識別する略称です。 -
FaxCountryCode: string
タイトル:
Fax Country Code
最大長:10
サプライヤ住所のFAXの国を識別する略称です。 -
FaxNumber: string
タイトル:
Fax
最大長:40
サプライヤ住所のFAXです。 -
FloorNumber: string
タイトル:
Floor
最大長:40
サプライヤ住所の階数です。 -
GlobalLocationNumber: string
タイトル:
Global Location Number
最大長:40
サプライヤ住所のグローバル事業所番号です。 -
InactiveDate: string (date)
タイトル:
Inactive Date
サプライヤ住所がアクティブでなくなる日付です。 -
Language: string
タイトル:
Language
最大長:255
サプライヤ住所の言語です。 -
LanguageCode: string
タイトル:
Language
最大長:4
サプライヤ住所の言語を識別する略称です。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
ユーザーが最後にサプライヤ・レコードを更新した日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
最後にサプライヤ・レコードを更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PhoneAreaCode: string
タイトル:
Phone Area Code
最大長:20
サプライヤ住所の電話のエリアを識別する略称です。 -
PhoneCountryCode: string
タイトル:
Phone Country Code
最大長:10
サプライヤ住所の電話の国を識別する略称です。 -
PhoneExtension: string
タイトル:
Phone Extension
最大長:20
サプライヤ住所の電話内線番号。 -
PhoneNumber: string
タイトル:
Phone
最大長:40
サプライヤ住所の電話番号です。 -
PhoneticAddress: string
タイトル:
Phonetic Address Line
最大長:560
住所明細のカナまたは漢字表現。 -
PostalCode: string
タイトル:
Postal Code
最大長:60
サプライヤ住所の郵便番号です。 -
PostalCodeExtension: string
タイトル:
Postal Plus 4 Code
最大長:20
サプライヤ住所の郵便番号に対する4桁の拡張子です。 -
Province: string
タイトル:
Province
最大長:60
サプライヤ住所の州です。 -
State: string
タイトル:
State or Region
最大長:60
サプライヤ住所の都道府県。 -
Status: string
タイトル:
Status
読取り専用:true
最大長:255
サプライヤ住所のステータスです。 -
SupplierAddressId: integer (int64)
読取り専用:
true
サプライヤ担当に関連付けられたサプライヤ住所を一意に識別する値です。
ネストされたスキーマ : サプライヤ住所のフレックスフィールド
タイプ:
array
タイトル:
Flexfields for Supplier Address
サプライヤ住所リソースのフレックスフィールドは、サプライヤ住所付加フレックスフィールドを管理します。
ソースを表示
ネストされたスキーマ : suppliers-addresses-DFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Enter Party Site Information
最大長:30
サプライヤ・サイトの付加フレックスフィールド・コンテキスト名です。 -
__FLEX_Context_DisplayValue: string
タイトル:
Enter Party Site Information
サプライヤ・サイトの付加フレックスフィールド・コンテキスト表示値。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PartySiteId: integer (int64)
読取り専用:
true
サプライヤ住所を一意に識別する値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
リンク
- DFF
-
パラメータ:
- SupplierAddressId:
$request.path.SupplierAddressId
- SupplierId:
$request.path.SupplierId
サプライヤ住所リソースのフレックスフィールドは、サプライヤ住所付加フレックスフィールドを管理します。 - SupplierAddressId:
例
この例では、1つのアドレスを取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/addresses/SupplierAddressId"
たとえば、次のコマンドは、サプライヤ住所識別子が300100153044503の原価調整を取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/addresses/300100153044503"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "SupplierAddressId" : 300100153044503, "AddressName" : "HQ", "CountryCode" : "US", "Country" : "United States", "AddressLine1" : "22093 Market Street", "AddressLine2" : null, "AddressLine3" : null, "AddressLine4" : null, "City" : "SAN FRANCISCO", "State" : "CA", "PostalCode" : "94102", "PostalCodeExtension" : null, "Province" : null, "County" : null, "Building" : null, "FloorNumber" : null, "PhoneticAddress" : null, "LanguageCode" : "US", "Language" : "American English", "Addressee" : null, "GlobalLocationNumber" : null, "AdditionalAddressAttribute1" : null, "AdditionalAddressAttribute2" : null, "AdditionalAddressAttribute3" : null, "AdditionalAddressAttribute4" : null, "AdditionalAddressAttribute5" : null, "AddressPurposeOrderingFlag" : true, "AddressPurposeRemitToFlag" : true, "AddressPurposeRFQOrBiddingFlag" : false, "PhoneCountryCode" : "1", "PhoneAreaCode" : "415", "PhoneNumber" : "5559908", "PhoneExtension" : null, "FaxCountryCode" : "1", "FaxAreaCode" : "415", "FaxNumber" : "5559907", "Email" : "eric.smith@example.com", "InactiveDate" : "4712-12-31", "Status" : "ACTIVE", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/addresses/300100153044503", "name" : "addresses", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/addresses/300100153044503", "name" : "addresses", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388", "name" : "suppliers", "kind" : "item" } ] }