すべての承認済サプライヤ・リスト・ソース文書の取得
get
/fscmRestApi/resources/11.13.18.05/approvedSupplierListSourceDocuments
リクエスト
問合せパラメータ
- 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
コレクションを検索するための事前定義済ファインダとして使用されます。
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します- PrimaryKey承認済サプライヤ・リストのソース文書を主キーに従って検索します。
ファインダ変数- AslSourceDocumentsId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- Agreement; string; 購買条件を示す契約。
- AgreementId; integer; 購買文書のヘッダーの識別子。
- AgreementLine; number; 承認済サプライヤ・リスト・エントリが関連付けられている契約明細番号。
- AgreementLineId; integer; 購買文書の明細の識別子。
- AgreementType; string; リクエストされた品目に関連付けられた契約のタイプ。 適用可能なタイプは、包括購買契約および購買契約です。
- AgreementTypeCode; string; 文書のタイプを示すコード。
- AslId; integer; 承認済サプライヤ・リスト・エントリの一意の識別子。
- AslSourceDocumentsId; integer; 承認済サプライヤ・リストの識別子??????sソース文書。
- Item; string; コンポーネント、サブアセンブリ、完成品、供給など、ビジネスの製造、購入、販売の対象となるもの。
- ItemId; integer; 承認済サプライヤ・リスト・エントリの品目を一意に識別する値。
- ProcurementBU; string; 購買文書を管理および所有するビジネス・ユニット。
- ProcurementBUId; integer; 承認済サプライヤ・リスト・エントリを管理および所有するビジネス・ユニットを一意に識別する値。
- Scope; string; 承認済サプライヤ・リスト・エントリが出荷先組織で使用されているか、調達ビジネス・ユニットによってサービスされるすべての出荷先組織で使用されているかを識別します。
- ScopeCode; string; 承認済サプライヤ・リスト・エントリが出荷先組織で使用されているか、調達ビジネス・ユニットがサービスするすべての出荷先組織で使用されているかを識別するコード。
- ShipToOrganization; string; サプライヤが商品を出荷する在庫組織の名前。
- ShipToOrganizationId; integer; 品目を受け取る在庫組織を一意に識別する値。
- Supplier; string; 商品またはサービスを購買組織に提供して支払を受ける組織または個人であり、契約上の義務に縛られます。
- SupplierId; integer; オーダーを履行するサプライヤを一意に識別する値。
- SupplierSite; string; 購買組織がサプライヤとビジネスを行う方法を示すエンティティ。
- SupplierSiteId; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : approvedSupplierListSourceDocuments
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : approvedSupplierListSourceDocuments-item-response
タイプ:
ソースを表示
object
-
Agreement: string
タイトル:
Agreement
最大長:30
購買の条件を満たす契約です。 -
AgreementEndDate: string (date)
タイトル:
Agreement End Date
読取り専用:true
契約が使用できない日付。 -
AgreementId: integer (int64)
購買文書のヘッダーの識別子です。
-
AgreementLine: number
タイトル:
Agreement Line
承認済サプライヤ・リスト・エントリが関連付けられている契約明細番号。 -
AgreementLineId: integer (int64)
購買文書の明細の識別子です。
-
AgreementStartDate: string (date)
タイトル:
Agreement Start Date
読取り専用:true
承認済サプライヤ・リスト・エントリに関連付けられた契約が有効になる日付。 -
AgreementStatus: string
タイトル:
Agreement Status
読取り専用:true
最大長:25
文書ライフサイクル全体を参照する文書の状態を示します。 たとえば、未完了やオープンです。 -
AgreementType: string
タイトル:
Type
最大長:80
リクエスト品目に関連付けられた契約のタイプです。 適用可能なタイプは、包括購買契約および購買契約です。 -
AgreementTypeCode: string
最大長:
25
文書のタイプを示すコード。 -
AslAttributesId: integer
承認済サプライヤ・リストの識別子??????sサプライヤ品目属性。
-
AslId: integer (int64)
承認済サプライヤ・リスト・エントリの一意識別子です。
-
AslSourceDocumentsId: integer
承認済サプライヤ・リストの識別子??????sソース文書。
-
DFF: array DFF
-
Item: string
タイトル:
Item
最大長:300
コンポーネント、サブアセンブリ、完成品、供給など、ビジネスの製造、購入または販売を行うもの。 -
ItemId: integer (int64)
承認済サプライヤ・リスト・エントリの品目を一意に識別する値。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ProcurementBU: string
タイトル:
Procurement BU
最大長:240
購買文書を管理および所有するビジネス・ユニット。 -
ProcurementBUId: integer (int64)
承認済サプライヤ・リスト・エントリを管理および所有するビジネス・ユニットを一意に識別する値。
-
Scope: string
タイトル:
Scope
読取り専用:true
最大長:80
承認済サプライヤ・リスト・エントリが出荷先組織で使用されているか、調達ビジネス・ユニットが提供するすべての出荷先組織で使用されているかを識別します。 -
ScopeCode: string
読取り専用:
true
最大長:80
承認済サプライヤ・リスト・エントリが出荷先組織で使用されているか、調達ビジネス・ユニットが提供するすべての出荷先組織で使用されているかを識別するコード。 -
ShipToOrganization: string
タイトル:
Ship-to Organization
最大長:240
サプライヤが商品の出荷先となる在庫組織の名前です。 -
ShipToOrganizationId: integer (int64)
品目を受け入れる在庫組織を一意に識別する値です。
-
Supplier: string
タイトル:
Supplier
最大長:360
商品またはサービスを購買組織に提供して支払を受ける組織または個人であり、契約上の義務に縛られます。 -
SupplierId: integer (int64)
オーダーを履行するサプライヤを一意に識別する値。
-
SupplierSite: string
タイトル:
Supplier Site
最大長:240
購買組織がサプライヤとどのようにビジネスを行うのかを示すエンティティです。 -
SupplierSiteId: integer (int64)
サプライヤがオーダーの履行に使用する事業所を一意に識別する値。
ネストされたスキーマ : approvedSupplierListSourceDocuments-DFF-item-response
タイプ:
ソースを表示
object
-
__FLEX_Context: string
タイトル:
Context Prompt
最大長:30
-
__FLEX_Context_DisplayValue: string
タイトル:
Context Prompt
-
AslSourceDocumentsId: integer
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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/approvedSupplierListSourceDocuments/approvedSupplierListSourceDocumentsUniqID"
例1: すべてのソース・ドキュメントの取得
次の例では、すべてのソース・ドキュメントを取得する方法を説明します。
例1 cURLコマンド
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments?offset=0&limit=499&fields=ProcurementBU,ShipToOrganization,Supplier,SupplierSite,Item,AgreementType,Agreement,AgreementLine,AgreementStatus,AgreementStartDate,AgreementEndDate"
例1 レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "items": [ { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "Big Computers", "SupplierSite": "AND-BREDA_HQ", "Item": "CM15140", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "Seven Corporation", "SupplierSite": "VLISSINGEN_HQ", "Item": "CM18759", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "Vision Corporation", "SupplierSite": "VLISSINGEN_HQ", "Item": "CM18761", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": null, "Supplier": "First Software", "SupplierSite": "AMSTERDAM_HQ", "Item": "CM31558", "AgreementType": "Blanket Purchase Agreement", "Agreement": null, "AgreementLine": null, "AgreementStatus": null, "AgreementStartDate": null, "AgreementEndDate": null }, "count": 499, "hasMore": true, "limit": 499, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/approvedSupplierListSourceDocuments", "name": "approvedSupplierListSourceDocuments", "kind": "collection" } ] }
例2: サプライヤのすべてのソース文書の取得
次の例では、サプライヤのすべてのソース文書を取得する方法を説明します。
例2 cURLコマンド
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments?offset=0&limit=499&q=Supplier+LIKE+'Big+Computers*'&fields=ProcurementBU,ShipToOrganization,Supplier,SupplierSite,Item,AgreementType,Agreement,AgreementLine,AgreementStatus,AgreementStartDate,AgreementEndDate"
例2 レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "items": [ { "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "97", "Item": "CM13139", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1002839", "AgreementLine": 1, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "97", "Item": "RCV-100", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1002839", "AgreementLine": 2, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null }, { "ProcurementBU": "Vision Operations", "ShipToOrganization": "Vision Operations", "Supplier": "Big Computers", "SupplierSite": "97", "Item": "CM13139", "AgreementType": "Blanket Purchase Agreement", "Agreement": "1002840", "AgreementLine": 1, "AgreementStatus": "OPEN", "AgreementStartDate": null, "AgreementEndDate": null } ], "count": 3, "hasMore": false, "limit": 499, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/approvedSupplierListSourceDocuments", "name": "approvedSupplierListSourceDocuments", "kind": "collection" } ] }