すべての部品品目の取得
get
/fscmRestApi/resources/11.13.18.05/partItemsLOV
リクエスト
問合せパラメータ
- 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 : 指定した主キー基準に従って部品品目を検索します。
ファインダ変数:- ItemId; integer; 在庫品目を一意に識別する値。
- findByItemsBOMForServiceRequest : サービス・リクエスト製品のサービス部品構成表に従って、サービス・リクエスト部品要件を作成する部品品目を検索します。
ファインダ変数:- ItemId; string; 在庫品目を一意に識別する値。
- ItemNumber; string;項目を識別する数値。
- OrganizationId; string; 在庫組織を一意に識別する値。
- ServiceActivityId; string; サービス・アクティビティを一意に識別する値。
- findByItemsBOMForWorkOrder : 作業オーダー・アセット品目のサービス部品構成表に従って、作業オーダー部品要件を作成するための部品品目を検索します。
ファインダ変数:- ItemId; string; 在庫品目を一意に識別する値。
- ItemNumber; string;項目を識別する数値。
- OrganizationId; string; 在庫組織を一意に識別する値。
- findByItemsNonBOMForServiceRequest : サービス・リクエスト部品要件を作成するための部品品目を検索します。
ファインダ変数:- ItemId; string; 在庫品目を一意に識別する値。
- ItemNumber; string;項目を識別する数値。
- OrganizationId; string; 在庫組織を一意に識別する値。
- ServiceActivityId; string; サービス・アクティビティを一意に識別する値。
- findByItemsNonBOMForWorkOrder : 作業オーダー部品要件を作成するための部品品目を検索します。
ファインダ変数:- ItemId; string; 在庫品目を一意に識別する値。
- ItemNumber; string;項目を識別する数値。
- OrganizationId; string; 在庫組織を一意に識別する値。
- 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;Loc!=NY
フォーマット : ?q=expression1;expression2
次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CustomerOrderFlag; boolean;次の値のいずれかを含みます: true、falseまたはnull。 trueの場合、在庫アイテムを使用して販売オーダーを作成できます。 falseまたはnullの場合、在庫品目は販売転送オーダーの作成に使用できません。 この属性にはデフォルト値がありません。
- InternalOrderFlag; boolean;次の値のいずれかを含みます: true、falseまたはnull。 trueの場合、在庫アイテムを使用して在庫転送オーダーを作成できます。 falseまたはnullの場合、在庫品目は在庫転送オーダーの作成に使用できません。 この属性にはデフォルト値がありません。
- ItemDescription; string;アイテムの説明。
- ItemId; integer; 在庫品目を一意に識別する値。
- ItemNumber; string;項目を識別する数値。
- OrganizationCode; string;組織を識別する略称。
- OrganizationId; integer; 組織IDを一意に識別する値。
- ReturnableFlag; boolean;次の値のいずれかを含みます: true、falseまたはnull。 trueの場合、在庫品目は返品可能です。 falseまたはnullの場合、在庫品目は返品できません。 この属性にはデフォルト値がありません。
- リビジョン、文字列、アイテムの最新リビジョンを説明する値。
- RevisionControlCode; number;在庫品目が改訂管理されているかどうかを示す略称。
- UOMClass; string;単位クラスを記述する値。
- UOMCode; string;アイテムの単位を識別する略称。
- UnitOfMeasure; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : partItemsLOV
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : partItemsLOV-item-response
タイプ:
ソースを表示
object
-
CustomerOrderFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: true、falseまたはnull。 trueの場合、在庫アイテムを使用して販売オーダーを作成できます。 falseまたはnullの場合、在庫品目は販売転送オーダーの作成に使用できません。 この属性にはデフォルト値がありません。 -
InternalOrderFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: true、falseまたはnull。 trueの場合、在庫アイテムを使用して在庫転送オーダーを作成できます。 falseまたはnullの場合、在庫品目は在庫転送オーダーの作成に使用できません。 この属性にはデフォルト値がありません。 -
ItemDescription: string
読取り専用:
true
最大長:240
品目の摘要。 -
ItemId: integer (int64)
読取り専用:
true
在庫品目を一意に識別する値です。 -
ItemNumber: string
読取り専用:
true
最大長:300
品目を識別する番号。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
OrganizationCode: string
読取り専用:
true
最大長:18
組織を識別する略称です。 -
OrganizationId: integer (int64)
読取り専用:
true
組織IDを一意に識別する値です。 -
ReturnableFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: true、falseまたはnull。 trueの場合、在庫品目は返品可能です。 falseまたはnullの場合、在庫品目は返品できません。 この属性にはデフォルト値がありません。 -
Revision: string
読取り専用:
true
最大長:72
品目の最新改訂を説明する値です。 -
RevisionControlCode: number
読取り専用:
true
在庫品目が改訂管理かどうかを識別する略称です。 -
UnitOfMeasure: string
読取り専用:
true
最大長:25
単位の意味。 -
UOMClass: string
読取り専用:
true
最大長:10
単位区分を説明する値です。 -
UOMCode: string
読取り専用:
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。