すべてのサプライヤの取得
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/suppliers
リクエスト
パス・パラメータ
- supplierNegotiationsUniqID(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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : AuctionHeaderIdおよびSupplierInvitationIdに従って、サプライヤへの招待を検索します。
ファインダ変数:- AuctionHeaderId; integer; オークション・ヘッダーを一意に識別する値。
- SupplierInvitationId; integer; サプライヤへの招待を一意に識別する値。
- PrimaryKeyFinder : SupplierInvitationIdに従って、サプライヤへの招待を検索します。
ファインダ変数:- SupplierInvitationId; integer; サプライヤへの招待を一意に識別する値。
- PrimaryKey : AuctionHeaderIdおよびSupplierInvitationIdに従って、サプライヤへの招待を検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AdditionalContactEmail; string; 各参加依頼サプライヤの追加担当者のEメール・アドレス。
- AuctionHeaderId; integer; ネゴシエーションを一意に識別する値。
- ConversionRate; number; ネゴシエーション通貨が1つのレスポンス通貨と等しいレート。
- PricePrecision; number; レスポンスの価格属性に対してアプリケーションで表示される小数点以下の桁数。
- RequestedSupplier; string; アプリケーションがネゴシエーションへの応答を依頼するサプライヤの名前。 承認保留中に適用されます。
- RequestedSupplierContact; string; アプリケーションがネゴシエーションへの応答を依頼する、サプライヤの担当者の名前。 承認保留中に適用されます。
- RequestedSupplierContactId; integer; アプリケーションがネゴシエーションへの応答を依頼するサプライヤの担当を識別する値。 承認保留中に適用されます。
- RequestedSupplierId; integer; アプリケーションがネゴシエーションへの応答を依頼するサプライヤを識別する値。 承認保留中に適用されます。
- ResponseCurrency; string; サプライヤがネゴシエーション応答で使用する通貨の名前。
- ResponseCurrencyCode; string; サプライヤがネゴシエーション応答で使用する通貨を識別する略称。
- Supplier; string; アプリケーションがネゴシエーションへのレスポンスを依頼したサプライヤ会社の名前。
- SupplierContact; string; 購買組織との通信中にサプライヤを表すサプライヤ従業員の名前。
- SupplierContactId; integer; 購買組織との通信中にサプライヤを表すサプライヤ従業員を識別する値。
- SupplierId; integer; アプリケーションがネゴシエーションに応答するよう招待したサプライヤ会社を識別する値。
- SupplierInvitationId; integer; ネゴシエーションに招待されたサプライヤを一意に識別する値。
- SupplierSite; string; サプライヤ・サイトの名前。
- SupplierSiteId; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : supplierNegotiations-suppliers
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : supplierNegotiations-suppliers-item-response
タイプ:
ソースを表示
object
-
AdditionalContactEmail: string
タイトル:
Additional Email
最大長:240
各参加依頼サプライヤの追加担当者のEメール・アドレス。 -
AuctionHeaderId: integer (int64)
読取り専用:
true
ネゴシエーションを一意に識別する値です。 -
ConversionRate: number
タイトル:
Conversion Rate
読取り専用:true
ネゴシエーション通貨が1つのレスポンス通貨と等しいレートです。 -
CreatedBy: string
読取り専用:
true
最大長:64
サプライヤを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーがサプライヤを作成した日時。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが最後にサプライヤを更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
最後にサプライヤを更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NotifyAllSupplierContactsFlag: boolean
タイトル:
Notify All Contacts
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤのすべての担当に通知が送信されます。 falseの場合、招待された担当者またはサプライヤの追加Eメールにのみ通知が送信されます。 デフォルト値はfalseです。 -
PricePrecision: number
タイトル:
Price Precision
読取り専用:true
レスポンスの価格属性に対してアプリケーションで表示される小数点以下の桁数。 -
RequestedSupplier: string
最大長:
240
ネゴシエーションに応答するためにアプリケーションが参加を依頼するサプライヤの名前。 承認保留中に適用されます。 -
RequestedSupplierContact: string
ネゴシエーションへの応答をアプリケーションが依頼するサプライヤの担当者の名前。 承認保留中に適用されます。
-
RequestedSupplierContactId: integer (int64)
アプリケーションがネゴシエーションへの応答を依頼するサプライヤの担当を識別する値です。 承認保留中に適用されます。
-
RequestedSupplierId: integer (int64)
アプリケーションがネゴシエーションへの応答を依頼するサプライヤを識別する値です。 承認保留中に適用されます。
-
ResponseCurrency: string
タイトル:
Response Currency
読取り専用:true
最大長:80
サプライヤがネゴシエーション・レスポンスで使用する通貨の名前。 -
ResponseCurrencyCode: string
タイトル:
Response Currency Code
読取り専用:true
最大長:15
サプライヤがネゴシエーション・レスポンスで使用する通貨を識別する略称です。 -
Supplier: string
タイトル:
Supplier
最大長:360
アプリケーションがネゴシエーションへのレスポンスを依頼したサプライヤ会社の名前。 -
SupplierContact: string
購買組織との通信中にサプライヤを表すサプライヤ従業員の名前。
-
SupplierContactId: integer (int64)
購買組織との通信中にサプライヤを表すサプライヤ従業員を識別する値です。
-
SupplierId: integer (int64)
アプリケーションがネゴシエーションへの応答を依頼したサプライヤ会社を識別する値です。
-
SupplierInvitationId: integer (int64)
読取り専用:
true
ネゴシエーションに招待されたサプライヤを一意に識別する値です。 -
supplierLineAccessRestrictions: array Access Restrictions
タイトル:
Access Restrictions
アクセス制限リソースは、サプライヤ・アクセスが制限されているネゴシエーション明細に関する詳細を管理します。 -
SupplierNumber: integer (int64)
読取り専用:
true
アプリケーションがネゴシエーションに応答するよう招待したサプライヤを識別する番号。 -
SupplierSite: string
タイトル:
Supplier Site
最大長:240
サプライヤ・サイトの名前。 -
SupplierSiteId: integer (int64)
サプライヤ・サイトを識別する値です。
ネストされたスキーマ : アクセス制限
タイプ:
array
タイトル:
Access Restrictions
アクセス制限リソースは、サプライヤ・アクセスが制限されているネゴシエーション明細に関する詳細を管理します。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : supplierNegotiations-suppliers-supplierLineAccessRestrictions-item-response
タイプ:
ソースを表示
object
-
AuctionHeaderId: integer (int64)
読取り専用:
true
ネゴシエーションを一意に識別する値です。 -
CreatedBy: string
読取り専用:
true
最大長:64
制限を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが制限を作成した日時。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが最近制限を更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
制限を最後に更新したユーザー。 -
Line: string
タイトル:
Line
最大長:25
ネゴシエーション明細を識別する番号。 -
LineDescription: string
タイトル:
Line Description
読取り専用:true
最大長:2500
ネゴシエーション明細の摘要。 -
LineId: number
ネゴシエーション明細を一意に識別する値です。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SupplierInvitationId: integer (int64)
読取り専用:
true
ネゴシエーションに招待されたサプライヤを一意に識別する値です。
例
この例では、すべてのサプライヤを取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/suppliers"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "items": [ { "AuctionHeaderId": 300100152357495, "SupplierInvitationId": 30, "SupplierNumber": 12, "Supplier": "CV_SuppA01", "SupplierId": 12496, "SupplierSite": "CVSuppA01Site01", "SupplierSiteId": 2444, "SupplierContact": "Brown, Rob", "SupplierContactId": 299647, "AdditionalContactEmail": null, "NotifyAllSupplierContactsFlag": true, "RequestedSupplier": null, "RequestedSupplierId": null, "RequestedSupplierContact": null, "RequestedSupplierContactId": null, "ResponseCurrency": "US Dollar", "ResponseCurrencyCode": "USD", "ConversionRate": 1, "PricePrecision": 2, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T11:33:14.566+00:00", "LastUpdateDate": "2018-06-28T11:34:48.919+00:00", "LastUpdatedBy": "CVBUYER01", "links": [<Do not change anything here>] }, { "AuctionHeaderId": 300100152357495, "SupplierInvitationId": 20, "SupplierNumber": 300100036698018, "Supplier": "PONSupplier29", "SupplierId": 300100036698016, "SupplierSite": "PONSupp29Site01", "SupplierSiteId": 300100039079784, "SupplierContact": null, "SupplierContactId": null, "AdditionalContactEmail": "PONSupplier29@example.com", "NotifyAllSupplierContactsFlag": true, "RequestedSupplier": null, "RequestedSupplierId": null, "RequestedSupplierContact": null, "RequestedSupplierContactId": null, "ResponseCurrency": null, "ResponseCurrencyCode": null, "ConversionRate": null, "PricePrecision": null, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T10:46:24+00:00", "LastUpdateDate": "2018-06-28T10:46:24+00:00", "LastUpdatedBy": "CVBUYER01", "links": [<Do not change anything here>] }