すべての代替品目の取得
get
/fscmRestApi/resources/11.13.18.05/massReplacementSubstituteItemsLOV
リクエスト
問合せパラメータ
- 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主キーに従って代替品目を検索します。
ファインダ変数- ItemId; string; 置換が定義されているプライマリ内部項目を一意に識別する値。
- OrganizationId; string; 置換在庫組織エンティティを一意に識別する値。
- SubstituteItemId; integer; プライマリ内部品目との代替関係を持つ内部品目を一意に識別する値。
- findBySubstituteItemプライマリ内部品目の代替品目を検索します。
ファインダ変数- bindFromItemId; integer;
- bindGlobal; string;
- bindOrganizationId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ItemDescription; string; プライマリ内部品目の説明。
- ItemId; string; プライマリ内部項目を一意に識別する値。
- ItemNumber; string; プライマリ内部項目を識別する数値。
- OrganizationCode; string; 置換在庫組織を識別する略称。
- OrganizationId; string; 置換在庫組織を一意に識別する値。
- SubstituteItemDescription; string; 代替内部品目の説明。
- SubstituteItemId; integer; 代替内部品目を一意に識別する値。
- SubstituteItemNumber; string; 代替内部品目を識別する数値。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : massReplacementSubstituteItemsLOV
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : massReplacementSubstituteItemsLOV-item-response
タイプ:
ソースを表示
object
-
ItemDescription: string
読取り専用:
true
最大長:240
プライマリ内部品目の摘要。 -
ItemId: string
読取り専用:
true
最大長:255
プライマリ内部品目を一意に識別する値。 -
ItemNumber: string
読取り専用:
true
最大長:300
プライマリ内部品目を識別する番号。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrganizationCode: string
読取り専用:
true
最大長:18
置換在庫組織を識別する略称です。 -
OrganizationId: string
読取り専用:
true
最大長:32
置換在庫組織を一意に識別する値。 -
SubstituteItemDescription: string
読取り専用:
true
最大長:240
代替内部品目の摘要。 -
SubstituteItemId: integer (int64)
読取り専用:
true
代替内部品目を一意に識別する値。 -
SubstituteItemNumber: string
読取り専用:
true
最大長: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 "https://servername/fscmRestApi/resources/version/massReplacementSubstituteItemsLOV"
たとえば:
curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementSubstituteItemsLOV?finder=findBySubstituteItem;bindFromItemId=300100545228703,bindOrganizationId=204,bindGlobal=Y"
レスポンス本文の例
次の例には、レスポンス本文の内容がJSON形式で含まれます:
"{ "items": [ { "ItemId": "300100545228703", "ItemNumber": "SCH1060", "ItemDescription": "Scorpio NRG Knee System Tibial Insert", "OrganizationId": "204", "OrganizationCode": "V1", "SubstituteItemId": 300100545228719, "SubstituteItemNumber": "SCH1061", "SubstituteItemDescription": "NXT Knee System Tibial Insert", "@context": { "key": "300100545228703,204,300100545228719", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementSubstituteItemsLOV/300100545228703%2C204%2C300100545228719", "name": "massReplacementSubstituteItemsLOV", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/massReplacementSubstituteItemsLOV/300100545228703%2C204%2C300100545228719", "name": "massReplacementSubstituteItemsLOV", "kind": "item" } ] } } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/massReplacementSubstituteItemsLOV", "name": "massReplacementSubstituteItemsLOV", "kind": "collection" } ] }"