サプライヤ登録リクエストの住所を1つ取得
get
/fscmRestApi/resources/11.13.18.05/supplierRegistrationRequests/{SupplierRegistrationKey}/child/addresses
リクエスト
パス・パラメータ
- SupplierRegistrationKey(required): string
このパラメータの値は、リソース品目を一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース品目にナビゲートする必要があります。 たとえば: products?q=InventoryItemId=
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey主キーに従ってサプライヤ登録リクエストの住所を検索します。
ファインダ変数- SupplierRegistrationAddressId; integer; サプライヤ登録リクエスト住所を一意に識別する値。
- PrimaryKey主キーに従ってサプライヤ登録リクエストの住所を検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
- q: string
この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- SupplierRegistrationAddressId; integer; サプライヤ登録リクエスト住所を一意に識別する値。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻るレスポンス
サポートされているメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : supplierRegistrationRequests-addresses
タイプ:
ソースを表示
object
-
count(required): integer
現在の範囲内で返されるリソース・インスタンス数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Items
コレクション内の品目。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合、推定行数は含まれません。
ネストされたスキーマ : supplierRegistrationRequests-addresses-item-response
タイプ:
ソースを表示
object
-
AdditionalAddressAttribute1: string
最大長:
150
フレキシブル・サプライヤ住所書式の最初の追加住所属性。 -
AdditionalAddressAttribute2: string
最大長:
150
フレキシブル・サプライヤ住所書式の2番目の追加住所属性。 -
AdditionalAddressAttribute3: string
最大長:
150
フレキシブル・サプライヤ住所書式の3番目の追加住所属性。 -
AdditionalAddressAttribute4: string
最大長:
150
フレキシブル・サプライヤ住所書式の4番目の追加住所属性です。 -
AdditionalAddressAttribute5: string
最大長:
150
フレキシブル・サプライヤ住所書式の5番目の追加住所属性。 -
addressContacts: array Address Contacts
タイトル:
Address Contacts
住所担当リソースは、サプライヤ登録リクエスト・リソースの住所に追加された担当を管理します。 -
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
サプライヤ住所の端数行です。 -
AddressName: string
タイトル:
Address Name
最大長:240
サプライヤ住所の名前。 -
AddressPurposeOrderingFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、オーダーにサプライヤ住所を使用できます。 falseの場合、このアドレスは使用できません。 デフォルト値はfalseです。
-
AddressPurposeRemitToFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ住所を使用して提案または入札をリクエストできます。 falseの場合、このアドレスは使用できません。 デフォルト値はfalseです。
-
AddressPurposeRFQOrBiddingFlag: boolean
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ住所を使用して支払を送信できます。 falseの場合、このアドレスは使用できません。 デフォルト値はfalseです。
-
Building: string
タイトル:
Building
最大長:240
サプライヤ住所の建物です。 -
City: string
タイトル:
City or Locality
最大長:60
サプライヤ住所の市区町村です。 -
CountryCode: string
タイトル:
Country
最大長:60
サプライヤ住所がある国を識別する略称です。 -
County: string
タイトル:
County
最大長:60
サプライヤ住所の国。 -
DFF: array DFF
-
Email: string
タイトル:
Email
最大長:320
サプライヤ住所のEメール。 -
FaxAreaCode: string
タイトル:
Fax Area Code
最大長:10
サプライヤ住所のFAXのエリアを識別する略称です。 -
FaxCountryCode: string
タイトル:
Fax Country Code
最大長:10
サプライヤ住所のFAXの国を識別する略称です。 -
FaxNumber: string
タイトル:
Fax
最大長:40
サプライヤ住所のFAX番号です。 -
FloorNumber: string
タイトル:
Floor
最大長:40
サプライヤ住所の階数です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
PhoneAreaCode: string
タイトル:
Phone Area Code
最大長:10
サプライヤ住所の電話番号のエリアを識別する略称です。 -
PhoneCountryCode: string
タイトル:
Phone Country Code
最大長:10
サプライヤ住所の電話の国を識別する略称です。 -
PhoneExtension: string
タイトル:
Phone Extension
最大長:20
サプライヤ住所の電話内線番号。 -
PhoneNumber: string
タイトル:
Phone
最大長:40
サプライヤ住所の電話番号です。 -
PhoneticAddress: string
タイトル:
Address Lines Phonetic
最大長:560
住所行の日本語カナまたは漢字表記。 -
PostalCode: string
タイトル:
Postal Code
最大長:60
サプライヤ住所の郵便番号です。 -
PostalCodeExtension: string
タイトル:
Postal Code Extension
最大長:10
サプライヤ住所の郵便番号に対する4桁の拡張です。 -
Province: string
タイトル:
Province
最大長:60
サプライヤ住所の州です。 -
State: string
タイトル:
State or Region
最大長:60
サプライヤ住所の都道府県。 -
SupplierRegistrationAddressId: integer
サプライヤ登録リクエスト住所を一意に識別する値。
ネストされたスキーマ : 住所担当
タイプ:
array
タイトル:
Address Contacts
住所担当リソースは、サプライヤ登録リクエスト・リソースの住所に追加された担当を管理します。
ソースを表示
ネストされたスキーマ : supplierRegistrationRequests-addresses-addressContacts-item-response
タイプ:
ソースを表示
object
-
Email: string
登録内のサプライヤ担当者のEメール。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SupplierRegAddressContactsId: integer
サプライヤ登録リクエスト住所担当を一意に識別する値。
-
SupplierRegistrationContactId: integer
サプライヤ登録リクエスト担当を一意に識別する値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : supplierRegistrationRequests-addresses-DFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Enter Party Site Information
最大長:30
-
__FLEX_Context_DisplayValue: string
タイトル:
Enter Party Site Information
-
AddressRequestId: integer
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。