すべてのソース・ドキュメントの取得
get
/fscmRestApi/resources/11.13.18.05/massReplacementSourceDocumentsLOV
リクエスト
問合せパラメータ
- 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主キーに従ってソース・ドキュメントを検索します。
ファインダ変数- SupplierId; integer; ソース文書が存在するサプライヤを一意に識別する値。
- SupplierSiteId; integer; サプライヤ・サイトを一意に識別する値。
- UOMCode; string; ソース文書の単位を識別する略称。
- findByAlternateSupplier代替サプライヤに従ってソース文書を検索します。
ファインダ変数- bindGlobal; string;
- bindItemId; integer; プライマリ内部品目を一意に識別する値。
- bindMpn; string; 代替サプライヤをソースとする代替製造業者部品番号を一意に識別する値です。
- bindPrcBuId; integer; 調達ビジネス・ユニット・エンティティを一意に識別する値。
- bindReplacementId; integer;
- bindReqBuId; integer; 購買依頼発行ビジネス・ユニット・エンティティを一意に識別する値。
- bindVendorId; integer; 代替サプライヤを一意に識別する値。
- bindVendorSiteId; integer; 代替サプライヤに対応するサプライヤ・サイトを一意に識別する値。
- findByItemMpn代替の製造元部品番号に従ってソース文書を検索します。
ファインダ変数- bindGlobal; string;
- bindItemId; integer; 代替内部品目を一意に識別する値。
- bindMpn; string; 代替の製造元部品番号を一意に識別する値。
- bindPrcBuId; integer; 調達ビジネス・ユニットを一意に識別する値。
- bindReplacementId; integer;
- bindReqBuId; integer;
- bindVendorId; integer; サプライヤを一意に識別する値。
- bindVendorSiteId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- CurrencyCode; string; ソース文書の通貨を識別する略称。
- ManufacturerPartNumber; string; 製造元部品を識別する数値。
- Precision; integer; 購買オーダー明細の単価属性を端数処理する必要がある桁数を示す値です。
- ProcurementBUId; integer; 調達ビジネス・ユニットを一意に識別する値。
- ProcurementBUName; string; 調達ビジネス・ユニットの名前。
- SourceDocument; string; 代替ソース・ドキュメント・ヘッダーを識別する番号。
- SourceDocumentLine; number; 代替ソース文書行を識別する番号。
- SupplierId; integer; サプライヤを一意に識別する値。
- SupplierName; string; サプライヤの名前。
- SupplierPartNumber; string; サプライヤ部品を識別する番号。
- SupplierSite; string; サプライヤ・サイトの名前。
- SupplierSiteId; integer; サプライヤ・サイトを一意に識別する値。
- UOMCode; string; ソース文書の単位を識別する略称。
- UnitOfMeasure; string; 代替ソース文書内の品目の単位の値。
- UnitPrice; number; 代替ソース文書内の品目の単価の値。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : massReplacementSourceDocumentsLOV
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : massReplacementSourceDocumentsLOV-item-response
タイプ:
ソースを表示
object
-
CurrencyCode: string
読取り専用:
true
最大長:15
ソース文書の通貨を識別する略称です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManufacturerPartNumber: string
タイトル:
Manufacturer Part Number
読取り専用:true
最大長:700
製造業者部品を識別する番号。 -
Precision: integer (int32)
タイトル:
Precision
読取り専用:true
購買オーダー明細の単価属性を端数処理する必要がある桁数を示す値です。 -
ProcurementBUId: integer (int64)
読取り専用:
true
調達ビジネス・ユニットを一意に識別する値。 -
ProcurementBUName: string
タイトル:
Business Unit
読取り専用:true
最大長:240
調達ビジネス・ユニットの名前。 -
SourceDocument: string
タイトル:
Order
読取り専用:true
最大長:30
代替ソース文書ヘッダーを識別する番号です。 -
SourceDocumentLine: number
タイトル:
Line
読取り専用:true
代替ソース文書明細を識別する番号です。 -
SupplierId: integer (int64)
読取り専用:
true
サプライヤを一意に識別する値。 -
SupplierName: string
読取り専用:
true
最大長:360
サプライヤの名前。 -
SupplierPartNumber: string
タイトル:
Supplier Item
読取り専用:true
最大長:300
サプライヤ部品を識別する番号。 -
SupplierSite: string
タイトル:
Site
読取り専用:true
最大長:240
サプライヤ・サイトの名前。 -
SupplierSiteId: integer (int64)
読取り専用:
true
サプライヤ・サイトを一意に識別する値。 -
UnitOfMeasure: string
タイトル:
UOM Name
読取り専用:true
最大長:25
代替ソース文書の品目の単位の値。 -
UnitPrice: number
タイトル:
Price
読取り専用:true
代替ソース文書の品目の単価の値。 -
UOMCode: string
タイトル:
UOM Code
読取り専用:true
最大長:3
ソース文書の単位を識別する略称です。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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/massReplacementSourceDocumentsLOV"
例1
この例では、findByAlternateSupplierファインダを使用して、品目置換用の1つ以上のソース・ドキュメントを取得する方法を示します。
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementSourceDocumentsLOV?finder=findByAlternateSupplier;bindPrcBuId=300100200125593,bindItemId=300100545303414,bindMpn=null,bindGlobal=N,bindVendorId=6134,bindVendorSiteId=300100203539381,bindReqBuId=300100200125593"
例1 レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{ "items" : [ { "SupplierName" : "Supplier 1001, Inc", "SupplierId" : 6133, "SupplierSite" : "NEW YORK", "SupplierSiteId" : 300100203539397, "SourceDocument" : "5", "SourceDocumentLine" : 1, "UnitOfMeasure" : "Each", "UOMCode" : "Ea", "UnitPrice" : 50, "CurrencyCode" : "USD", "ProcurementBUId" : 300100200125593, "ProcurementBUName" : "Vision Healthcare USA", "ManufacturerPartNumber" : "MFG2020" }]}"
例2
この例では、findByItemMPNファインダを使用して、品目置換用の1つ以上のソース・ドキュメントを取得する方法を示します。
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementSourceDocumentsLOV?finder=findByItemMpn;bindPrcBuId=300100200125593,bindItemId=300100545303444,bindGlobal=Y,bindReplacementId=300100553817622"
例2 レスポンス本文
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{ "items": [ { "SupplierName": "Supplier 1002", "SupplierId": 1, "SupplierSite": "Chicago", "SupplierSiteId": 985, "SourceDocument": "1000322", "SourceDocumentLine": 1, "UnitOfMeasure": "Each", "UOMCode": "Ea", "UnitPrice": 10, "CurrencyCode": "USD", "ProcurementBUId": 300100200125593, "ProcurementBUName": "Vision Healthcare USA", "ManufacturerPartNumber": null }] }"