すべての購買依頼処理リクエスト・ヘッダーの取得
get
/fscmRestApi/resources/11.13.18.05/requisitionProcessingRequests
リクエスト
問合せパラメータ
- 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 : インタフェース・ヘッダー識別子に従ってインタフェース・ヘッダーを主キーとして検索します。
ファインダ変数:- RequestHeaderId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- Buyer; string; 調達文書の管理を担当する個人。
- BuyerId; integer; バイヤーを一意に識別する値。
- OrderNumber; string; 購買オーダーを一意に識別する数値。
- POHeaderId; integer; 購買オーダー・ヘッダーを一意に識別する値。
- ProcurementBU; string; 購買依頼と対応する購買オーダーまたはネゴシエーションを管理および所有するビジネス・ユニット。
- ProcurementBUId; integer; 購買依頼および対応する購買オーダーまたはネゴシエーションを管理および所有するビジネス・ユニットを一意に識別する値。
- RequestHeaderId; integer; リクエスト・ヘッダーを一意に識別する値。
- RequisitioningBU; string; 商品およびサービスの購買依頼を生成したビジネス・ユニットの名前。
- RequisitioningBUId; integer; 商品およびサービスの購買依頼を発行したビジネス・ユニットを一意に識別する値。
- SoldToLegalEntity; string; 購買オーダーで購買を財務的に担当する法的エンティティ。
- SoldToLegalEntityId; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : requisitionProcessingRequests
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : requisitionProcessingRequests-item-response
タイプ:
ソースを表示
object
-
Buyer: string
タイトル:
Buyer
最大長:240
調達文書の管理を担当する個人。 -
BuyerId: integer (int64)
バイヤーを一意に識別する値。
-
ConversionRate: number
通貨の換算時に使用するレートです。
-
ConversionRateDate: string (date)
オーダー金額を別の通貨に換算する際の換算レートに使用する日付です。 換算レートは日付によって異なります。
-
ConversionRateType: string
タイトル:
Conversion Rate Type
最大長:30
購買オーダーの通貨換算レートを決定するためにアプリケーションで使用されるレートのタイプです。 -
ConversionRateTypeCode: string
最大長:
30
購買オーダーの通貨換算レートを決定するためにアプリケーションで使用されるレートのタイプを識別する略称です。 -
Currency: string
タイトル:
Currency
最大長:80
購買オーダーの通貨を識別する略称です。 -
CurrencyCode: string
最大長:
15
購買オーダーの通貨コードを識別する略称です。 -
DocumentStyle: string
タイトル:
Document Style
最大長:240
購買文書形式の名前。 この属性を使用すると、組織は、購買文書の使用と一致するように、アプリケーションに表示されるパラメータおよび値を制御できます。 -
DocumentStyleId: integer (int64)
文書の購買形式を一意に識別する値。
-
GroupRequisitionLines: string
次のいずれかの値が含まれます: YまたはN。 Yの場合、購買依頼明細は購買オーダーのオーダー明細で結合されます。 Nの場合は、購買依頼明細をグループ化できません。
-
lines: array Lines
タイトル:
Lines
明細リソースは、調達文書に処理する必要がある購買依頼明細を管理します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrderNumber: string
最大長:
30
購買オーダーを一意に識別する番号。 -
POHeaderId: integer (int64)
購買オーダー・ヘッダーを一意に識別する値。
-
ProcurementBU: string
タイトル:
Procurement BU
最大長:240
購買依頼および対応する購買オーダーまたはネゴシエーションを管理および所有するビジネス・ユニットです。 -
ProcurementBUId: integer (int64)
購買依頼および対応する購買オーダーまたはネゴシエーションを管理および所有するビジネス・ユニットを一意に識別する値です。
-
RequestHeaderId: integer (int64)
読取り専用:
true
リクエスト・ヘッダーを一意に識別する値。 -
RequisitioningBU: string
タイトル:
Requisitioning BU
最大長:240
商品およびサービスの購買依頼を提起したビジネス・ユニットの名前。 -
RequisitioningBUId: integer (int64)
商品およびサービスの購買依頼を提起したビジネス・ユニットを一意に識別する値です。
-
SoldToLegalEntity: string
タイトル:
Sold-to Legal Entity
購買オーダーの購買を財務的に担当する法的エンティティです。 -
SoldToLegalEntityId: integer (int64)
購買オーダーの購買を財務的に担当する法的エンティティを一意に識別する値。
-
SourceAgreement: string
タイトル:
Source Agreement
最大長:30
ソース契約を一意に識別する番号。 -
SourceAgreementId: integer (int64)
ソース契約を一意に識別する値。
-
Supplier: string
タイトル:
Supplier
最大長:360
サプライヤの名前。 -
SupplierId: integer (int64)
サプライヤを一意に識別する値。
-
SupplierSite: string
タイトル:
Supplier Site
最大長:240
サプライヤが品目の購入に使用する事業所。 -
SupplierSiteId: integer (int64)
サプライヤ・サイトを一意に識別する値。
-
Type: string
タイトル:
Type
文書タイプを一意に識別する値。 タイプには、新規オーダー、既存のオーダーまたはネゴシエーションがあります。
ネストされたスキーマ : requisitionProcessingRequests-lines-item-response
タイプ:
ソースを表示
object
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
RequestHeaderId: integer (int64)
読取り専用:
true
リクエスト・ヘッダーを一意に識別する値。 -
RequestLineId: integer (int64)
読取り専用:
true
リクエスト明細を一意に識別する値。 -
RequisitionLineId: 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/requisitionProcessingRequests/requestheaderid/child/lines