すべてのリクエストの取得
get
/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests
リクエスト
問合せパラメータ
- 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主キーに従って外部購買価格リクエストを検索します。
ファインダ変数- InterfaceHeaderId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- Action; string; 外部購買価格に対して実行する処理。 有効な値は、CREATE、UPDATEまたはCANCELです。 これは必須属性です。
- ApprovalRequiredFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、外部購買価格は承認待ちステータスで作成されます。 falseの場合、外部購買価格は承認済として作成されます。 デフォルト値はtrueです。
- BatchId; number; 外部購買価格リクエスト・バッチを一意に識別する値。
- CurrencyCode; string; 外部購買価格の通貨を識別する略称。
- ErrorFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、外部購買価格リクエストにエラーが存在します。 falseの場合、エラーは存在せず、外部購買価格は正常にインポートされます。 この属性にはデフォルト値がありません。
- InterfaceHeaderId; integer; 外部購買価格リクエストを一意に識別する値。
- InterfaceHeaderKey; string; 外部購買価格リクエストを一意に識別する数値。
- LoadRequestId; number; 外部購買価格リクエスト・データをインタフェース表にロードしたプロセスを一意に識別する値。
- ManufacturerName; string; 製造元の名前。
- ManufacturerPartyId; integer; 製造業者を一意に識別する値。
- RequisitioningBUId; integer; 購買依頼発行ビジネス・ユニットを一意に識別する値。
- RequisitioningBUName; string; 購買依頼発行ビジネス・ユニットの名前です。
- Source; string; ソース契約の個人または組織の名前。
- SourceContractDescription; string; ソース契約の説明。
- SourceContractEndDate; string; ソース契約が無効になる日付。
- SourceContractNumber; string; ソース契約を一意に識別する番号。
- SourceContractStartDate; string; ソース契約が有効になる日付。
- SourceContractType; string; ソース契約のタイプ。
- SourceContractTypeCode; string; ソース契約のタイプを識別する略称。
- SourceOrganization; string; ソース組織を一意に識別する値。
- SourceReferenceId; string; ソース・アプリケーションの外部購入価格を一意に識別する値です。
- SourceType; string; 契約のソース・タイプ。
- SourceVendor; string; ソース・サプライヤを一意に識別する値。
- SupplierId; integer; サプライヤを一意に識別する値。
- SupplierNumber; string; サプライヤを一意に識別する数値。
- SupplierSite; string; サプライヤ・サイトの名前。
- SupplierSiteId; integer; サプライヤ・サイトを一意に識別する値。
- TierDescription; string; ソース組織が属する層の説明。
- TierLevel; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : externalPurchasePricesRequests
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : externalPurchasePricesRequests-item-response
タイプ:
ソースを表示
object
-
Action: string
最大長:
25
外部購買価格に対して実行する処理です。 有効な値は、CREATE、UPDATEまたはCANCELです。 これは必須属性です。 -
ApprovalRequiredFlag: boolean
最大長:
25
デフォルト値:false
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、外部購買価格は承認待ちステータスで作成されます。 falseの場合、外部購買価格は承認済として作成されます。 デフォルト値はtrueです。 -
BatchId: number
外部購買価格リクエスト・バッチを一意に識別する値。
-
CurrencyCode: string
最大長:
15
外部購買価格の通貨を識別する略称です。 -
ErrorFlag: boolean
最大長:
1
デフォルト値:false
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、外部購買価格リクエストにエラーが存在します。 falseの場合、エラーは存在せず、外部購買価格は正常にインポートされます。 この属性にはデフォルト値がありません。 -
InterfaceHeaderId: integer (int64)
外部購買価格リクエストを一意に識別する値。
-
InterfaceHeaderKey: string
最大長:
30
外部購買価格リクエストを一意に識別する番号です。 -
lines: array Lines
タイトル:
Lines
明細リソースは、外部購買価格リクエスト明細を管理します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LoadRequestId: number
外部購買価格リクエスト・データをインタフェース表にロードしたプロセスを一意に識別する値。
-
ManufacturerName: string
最大長:
700
製造業者の名前です。 -
ManufacturerPartyId: integer (int64)
製造業者を一意に識別する値。
-
RequisitioningBUId: integer (int64)
購買依頼発行ビジネス・ユニットを一意に識別する値。
-
RequisitioningBUName: string
最大長:
240
購買依頼発行ビジネス・ユニットの名前です。 -
Source: string
最大長:
60
ソース契約の個人または組織の名前。 -
SourceContractDescription: string
最大長:
2000
ソース契約の摘要。 -
SourceContractEndDate: string (date)
ソース契約が無効になる日付。
-
SourceContractNumber: string
最大長:
120
ソース契約を一意に識別する番号。 -
SourceContractStartDate: string (date)
ソース契約が有効になる日付。
-
SourceContractType: string
最大長:
80
ソース契約のタイプ。 -
SourceContractTypeCode: string
最大長:
30
ソース契約のタイプを識別する略称です。 -
SourceOrganization: string
最大長:
240
ソース組織を一意に識別する値。 -
SourceReferenceId: string
最大長:
30
ソース・アプリケーションの外部購買価格を一意に識別する値です。 -
SourceType: string
最大長:
60
契約のソース・タイプです。 -
SourceVendor: string
最大長:
360
ソース・サプライヤを一意に識別する値。 -
SupplierId: integer (int64)
サプライヤを一意に識別する値。
-
SupplierNumber: string
最大長:
30
サプライヤを一意に識別する番号です。 -
SupplierSite: string
最大長:
240
サプライヤ・サイトの名前。 -
SupplierSiteId: integer (int64)
サプライヤ・サイトを一意に識別する値。
-
TierDescription: string
最大長:
2000
ソース組織が属する階層の摘要。 -
TierLevel: integer (int64)
ソース組織が属する階層を示す番号。
ネストされたスキーマ : externalPurchasePricesRequests-lines-item-response
タイプ:
ソースを表示
object
-
Action: string
最大長:
25
明細に対して実行する処理。 有効な値は、CREATE、UPDATEまたはCANCELです。 これは必須属性です。 -
AdjustedPrice: number
修正後の単価の値です。
-
AdjustmentPercentage: number
基準価格が調整される値。
-
BatchId: number
外部購買価格リクエスト・バッチを一意に識別する値。
-
ErrorFlag: boolean
最大長:
1
デフォルト値:false
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、外部購買価格リクエストにエラーが存在します。 falseの場合、エラーは存在せず、外部購買価格は正常にインポートされます。 この属性にはデフォルト値がありません。 -
InterfaceHeaderKey: string
最大長:
30
外部購買価格リクエストを一意に識別する番号です。 -
InterfaceLineId: integer (int64)
リクエスト明細を一意に識別する値。
-
InterfaceLineKey: string
最大長:
30
リクエスト明細を一意に識別する番号。 -
InventoryItemId: integer (int64)
品目を一意に識別する値。
-
ItemDescription: string
最大長:
240
品目の摘要。 -
ItemNumber: string
最大長:
300
品目を一意に識別する番号です。 -
LineNumber: integer (int64)
外部購買価格明細を一意に識別する番号です。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
LoadRequestId: number
外部購買価格リクエスト・データをインタフェース表にロードしたプロセスを一意に識別する値。
-
ManufacturerPartNumber: string
最大長:
700
製造業者部品を一意に識別する番号。 -
ManufacturerTradingPartnerItemId: integer (int64)
製造業者部品を一意に識別する値。
-
Price: number
修正前の単価の値です。
-
PriceEndDate: string (date)
価格が有効になる日付。
-
PriceStartDate: string (date)
価格が無効になる日付。
-
PurchasingCategoryCode: string
最大長:
820
製造業者部品の購買カテゴリを識別する略称です。 -
PurchasingCategoryId: integer (int64)
購買カテゴリを一意に識別する値。
-
SourcePurchasingCategory: string
最大長:
700
製造業者の購買カテゴリの名前。 -
SourceReferenceId: string
最大長:
30
ソース・システムの外部購買価格を一意に識別する値。 -
SourceUnitOfMeasure: string
最大長:
25
ソース単位の名前。 -
SourceUOMQuantity: number
ソース単位の数量です。
-
UnitOfMeasure: string
タイトル:
UOM Name
最大長:25
単位の名前。 -
UnitOfMeasureCode: string
最大長:
3
単位を識別する略語。 -
VendorItemId: integer (int64)
サプライヤ部品を一意に識別する値です。
-
VendorPartNumber: string
最大長:
300
サプライヤ部品を一意に識別する番号。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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 server:port/fscmRestApi/resources/version/externalPurchasePricesRequests
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{ ""items"": [ { ""InterfaceHeaderId"": 300100554847375, ""InterfaceHeaderKey"": ""300100554847375"", ""SourceReferenceId"": ""AutoREF_29255016"", ""Action"": ""CREATE"", ""ApprovalRequiredFlag"": true, ""SourceOrganization"": null, ""RequisitioningBUId"": null, ""RequisitioningBUName"": ""Vision Healthcare USA"", ""SourceContractNumber"": ""Contract1"", ""SourceContractDescription"": null, ""SourceContractType"": ""Local"", ""SourceContractTypeCode"": ""ORA_SCH_EPP_LOCAL"", ""SourceType"": ""GHX"", ""Source"": null, ""ManufacturerName"": ""GE Medical Systems"", ""ManufacturerPartyId"": null, ""SourceVendor"": ""User1"", ""SupplierId"": null, ""SupplierNumber"": null, ""SupplierSiteId"": null, ""SupplierSite"": null, ""CurrencyCode"": ""USD"", ""SourceContractStartDate"": ""2019-10-08"", ""SourceContractEndDate"": ""2034-10-08"", ""TierLevel"": null, ""TierDescription"": null, ""ErrorFlag"": false, ""BatchId"": 11225522, ""LoadRequestId"": null, ""links"": [ { ""rel"": ""self"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100554847375"", ""name"": ""externalPurchasePricesRequests"", ""kind"": ""item"", ""properties"": { ""changeIndicator"": ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"" } }, { ""rel"": ""canonical"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100554847375"", ""name"": ""externalPurchasePricesRequests"", ""kind"": ""item"" }, { ""rel"": ""child"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100554847375/child/lines"", ""name"": ""lines"", ""kind"": ""collection"" } ] }, { ""InterfaceHeaderId"": 300100554847379, ""InterfaceHeaderKey"": ""300100554847379"", ""SourceReferenceId"": ""AutoREF_58394224"", ""Action"": ""CREATE"", ""ApprovalRequiredFlag"": true, ""SourceOrganization"": null, ""RequisitioningBUId"": null, ""RequisitioningBUName"": ""Vision Healthcare USA"", ""SourceContractNumber"": ""Contract2"", ""SourceContractDescription"": null, ""SourceContractType"": ""Local"", ""SourceContractTypeCode"": ""ORA_SCH_EPP_LOCAL"", ""SourceType"": ""Local"", ""Source"": null, ""ManufacturerName"": ""Stryker Inc."", ""ManufacturerPartyId"": null, ""SourceVendor"": ""User2"", ""SupplierId"": null, ""SupplierNumber"": null, ""SupplierSiteId"": null, ""SupplierSite"": null, ""CurrencyCode"": ""USD"", ""SourceContractStartDate"": ""2019-10-08"", ""SourceContractEndDate"": ""2034-10-08"", ""TierLevel"": null, ""TierDescription"": null, ""ErrorFlag"": false, ""BatchId"": 11225522, ""LoadRequestId"": null, ""links"": [ { ""rel"": ""self"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100554847379"", ""name"": ""externalPurchasePricesRequests"", ""kind"": ""item"", ""properties"": { ""changeIndicator"": ""ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"" } }, { ""rel"": ""canonical"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100554847379"", ""name"": ""externalPurchasePricesRequests"", ""kind"": ""item"" }, { ""rel"": ""child"", ""href"": ""server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100554847379/child/lines"", ""name"": ""lines"", ""kind"": ""collection"" } ] } ] } "