1つのプライマリ品目の取得
get
/fscmRestApi/resources/11.13.18.05/massReplacementPrimaryItemsLOV/{massReplacementPrimaryItemsLOVUniqID}
リクエスト
パス・パラメータ
- massReplacementPrimaryItemsLOVUniqID(required): string
これは、一括置換プライマリ品目リソースに対する複合キー(ItemIdおよびOrganizationId)を構成する属性のハッシュ・キーで、一括置換プライマリ品目のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、一括置換プライマリ品目の特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用して一括置換プライマリ品目コレクション・リソースを問い合せる必要があります。
次に例を示します: massReplacementPrimaryItemsLOV?q=ItemId=<value1>;OrganizationId=<value2>
問合せパラメータ
- 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
データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : massReplacementPrimaryItemsLOV-item-response
タイプ:
ソースを表示
object
-
ItemDescription: string
タイトル:
Item Description
読取り専用:true
最大長:240
プライマリ品目の摘要。 -
ItemId: integer (int64)
タイトル:
Item Number
読取り専用:true
プライマリ品目を一意に識別する値。 -
ItemNumber: string
読取り専用:
true
最大長:300
プライマリ品目に関連付けられた番号です。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrganizationCode: string
タイトル:
Organization
読取り専用:true
最大長:18
プライマリ品目が関連付けられている品目マスター組織を識別する略称です。 -
OrganizationId: integer (int64)
タイトル:
Organization
読取り専用:true
マスター組織を一意に識別する値。 -
ProcurementBusinessUnitId: integer (int64)
読取り専用:
true
調達ビジネス・ユニットを一意に識別する値。 -
ProcurementBusinessUnitName: string
タイトル:
Business Unit
読取り専用:true
最大長:240
調達ビジネス・ユニットの名前。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
例
この例では、1つのプライマリ品目を取得する方法について説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementPrimaryItemsLOV/massReplacementPrimaryItemsLOVUniqID"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{ "items" : [ { "ItemDescription" : "Z-Med 12 Pacemaker", "ItemId" : 300100545228228, "ItemNumber" : "SCH1020", "@context" : { "key" : "300100545228228,204", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/massReplacementPrimaryItemsLOV/300100545228228%2C204", "name" : "massReplacementPrimaryItemsLOV", "kind" : "item" }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/massReplacementPrimaryItemsLOV/300100545228228%2C204", "name" : "massReplacementPrimaryItemsLOV", "kind" : "item" } ] } } } ], "count" : 1, "hasMore" : false, "limit" : 25, "offset" : 0, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/massReplacementPrimaryItemsLOV", "name" : "massReplacementPrimaryItemsLOV", "kind" : "collection" } ] }"