すべてのサプライヤの取得
get
/fscmRestApi/resources/11.13.18.05/supplierInitiatives/{InitiativeId}/child/suppliers
リクエスト
パス・パラメータ
- InitiativeId(required): integer(int64)
イニシアチブを一意に識別する値です。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - effectiveDate: string
この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
- 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 : サプライヤ識別子に従ってサプライヤを検索します。
ファインダ変数:- InitiativeSupplierId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- InitiativeSupplierId; integer; サプライヤを一意に識別する値。
- totalResults: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Effective-Of:
このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた
= 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。のリストです。 - 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のデフォルト・バージョンを選択します。
ルート・スキーマ : supplierInitiatives-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"の場合、推定行数は含まれません。
ネストされたスキーマ : supplierInitiatives-suppliers-item-response
タイプ:
ソースを表示
object
-
InitiativeSupplierId: integer (int64)
サプライヤを一意に識別する値。
-
InternalResponder: string
タイトル:
Internal Responder
最大長:240
内部レスポンダの名前。 -
InternalResponderId: integer (int64)
内部応答者を一意に識別する値。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ResponsePulledFlag: boolean
タイトル:
Response Pulled
最大長:1
このサプライヤのレスポンスがイニシアチブの一部としてプルされたかどうかを示す値です。 次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、データはプロファイルからリポジトリにプルされます。 falseの場合、データはプロファイルからリポジトリにプルされません。 この属性にはデフォルト値がありません。 -
SendInternalQuestionnaireFlag: boolean
タイトル:
Send Internal Questionnaire
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、質問リストは内部応答者に送信されます。 falseの場合、質問リストは内部応答者に送信されません。 内部質問リストの必須質問に対するレスポンスがレスポンス・リポジトリにない場合、デフォルト値はtrueです。 それ以外の場合、デフォルト値はfalseです。 この属性は、イニシアチブの資格および査定タイプの両方に使用されます。 -
SendSupplierQuestionnaireFlag: boolean
タイトル:
Send Supplier Questionnaire
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、質問リストはサプライヤ担当に送信されます。 falseの場合、質問リストはサプライヤ担当に送信されません。 サプライヤ質問リストの必須質問に対するレスポンスがレスポンス・リポジトリにない場合、デフォルト値はtrueです。 それ以外の場合、デフォルト値はfalseです。 この属性は、イニシアチブの資格および査定タイプの両方に使用されます。 -
Supplier: string
タイトル:
Supplier
最大長:360
サプライヤの名前。 -
SupplierContact: string
タイトル:
Supplier Contact
最大長:255
サプライヤ担当の名前。 -
SupplierContactId: integer (int64)
サプライヤ担当を一意に識別する値。
-
SupplierId: integer (int64)
サプライヤを一意に識別する値。
-
SupplierNumber: string
タイトル:
Supplier Number
最大長:30
サプライヤを識別する番号。 -
SupplierSite: string
タイトル:
Supplier Site
最大長:240
サプライヤ・サイトの名前。 -
SupplierSiteId: integer (int64)
サプライヤ・サイトを一意に識別する値。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
例
この例では、すべてのサプライヤを取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierInitiatives/InitiativeId/child/suppliers"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "items": [ { "InitiativeSupplierId": 300100194001374, "SupplierId": 999992000322041, "Supplier": "Small, Inc.", "SupplierSiteId": null, "SupplierSite": null, "SupplierContactId": null, "SupplierContact": null, "SupplierNumber": "37941", "InternalResponderId": null, "InternalResponder": null, "SendSupplierQuestionnaireFlag": true, "SendInternalQuestionnaireFlag": false, "ResponsePulledFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/suppliers/300100194001374", "name": "suppliers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000978" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/suppliers/300100194001374", "name": "suppliers", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373", "name": "supplierInitiatives", "kind": "item" } ] }, { "InitiativeSupplierId": 300100194001375, "SupplierId": 999992000338210, "Supplier": "Tall, INC", "SupplierSiteId": null, "SupplierSite": null, "SupplierContactId": null, "SupplierContact": null, "SupplierNumber": "52932", "InternalResponderId": null, "InternalResponder": null, "SendSupplierQuestionnaireFlag": true, "SendInternalQuestionnaireFlag": false, "ResponsePulledFlag": true, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/suppliers/300100194001375", "name": "suppliers", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000978" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/suppliers/300100194001375", "name": "suppliers", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373", "name": "supplierInitiatives", "kind": "item" } ] } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierInitiatives/300100194001373/child/suppliers", "name": "suppliers", "kind": "collection" } ] }