1つの承認済サプライヤ・リスト・ソース文書の取得
get
/fscmRestApi/resources/11.13.18.05/approvedSupplierListSourceDocuments/{approvedSupplierListSourceDocumentsUniqID}
リクエスト
パス・パラメータ
- approvedSupplierListSourceDocumentsUniqID(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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- 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-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.
リンク
- DFF
-
パラメータ:
- approvedSupplierListSourceDocumentsUniqID:
$request.path.approvedSupplierListSourceDocumentsUniqID
- approvedSupplierListSourceDocumentsUniqID:
例
この例では、1つの承認済サプライヤ・リスト・ソース文書を取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/approvedSupplierListSourceDocumentsUniqID"たとえば:
curl -u username:password "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100564454164"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
{ "items": [ { "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, "@context": { "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100564454164", "name": "approvedSupplierListSourceDocuments", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100564454164", "name": "approvedSupplierListSourceDocuments", "kind": "item" } ] } } ], "count": 1, "hasMore": false, "limit": 499, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments", "name": "approvedSupplierListSourceDocuments", "kind": "collection" } ] }