すべてのコンポーネントの取得
get
/crmRestApi/resources/11.13.18.05/productStructures/{BillSequenceId}/child/Component
リクエスト
パス・パラメータ
- BillSequenceId(required): integer
請求連番の一意の識別子。 体系を一意に識別する値。 この属性は読取り専用で、リソースがすでに変更されている場合にのみ変更できます。
問合せパラメータ
- 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 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- PrimaryKey : 指定された主キーを持つコンポーネントを検索します。
ファインダ変数:- ComponentSequenceId; integer;コンポーネントの一意の識別子。
- getComponentByItemNumber : 指定した構成品目番号およびコンポーネント品目番号を持つコンポーネントを検索します。
ファインダ変数:- ComponentItemNumber; string;部品、材料、製品またはサービスを識別するコンポーネント・アイテム番号。
- ComponentOrganizationCode; string; 企業の内部または外部の組織構造内の組織単位の名前を識別するコンポーネント組織コード。
- StructureItemNumber; string;パーツ、マテリアル、製品、またはサービスを識別する構造アイテム番号。
- StructureOrganizationCode; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- BOMItemType; number; cpomponentに関連付けられた部品構成表のタイプ(標準、モデル、計画など)。
- BillSequenceId; integer; 部品構成表を一意に識別する値。 これは構造ビュー・オブジェクトへの外部キーです。 この属性は読取り専用であり、リソースがすでに変更されている場合にのみ変更できます。
- コメント、文字列。コンポーネントに関するコメントを表す属性値。
- ComponentItemDescription; string;コンポーネントに関連付けられたアイテムの説明。
- ComponentItemId; string; コンポーネントに関連付けられたアイテムを一意に識別する値。
- ComponentItemName; string;コンポーネントに関連付けられたアイテムの名前。
- ComponentItemNumber; string;コンポーネントのアイテム番号を表す属性。 この属性は作成操作に対してのみ更新可能で、それ以外の場合は読取り専用です。
- ComponentOrganizationCode; string;企業の内部組織構造または外部組織構造内の組織単位の名前を識別する略称。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。
- ComponentSequenceId; integer; 構造内のコンポーネントを一意に識別する値。 この属性は読取り専用であり、更新操作に必須ではありません。
- CreatedBy; string; コンポーネントを作成したユーザー。
- CreationDateTime; string;構造が作成された日時。
- EndDateTime; string; 構造内のコンポーネントが終了する日時。
- ImplementationDateTime; string;この属性は、コンポーネントが本番行として実装されたときのタイムスタンプを提供します。 この属性は、保留中コンポーネントと生産コンポーネントを区別するために使用できます。 保留中のコンポーネントの場合、これはNULLになります。 これは読取り専用属性です。
- ItemSequenceNumber; number。構造内のコンポーネントの順序を定義する一意の番号。
- LastUpdateDateTime; string; 構造が最後に更新された日時。
- LastUpdateLogin; string;コンポーネントを最後に更新したユーザーのログイン。
- LastUpdatedBy; string;コンポーネントを最後に更新したユーザー。
- MaximumQuantity; number。この値がオーダーで許可される最大数量を示す属性。
- MinimumQuantity; number。この値がオーダーで許可される最小数量を示す属性。
- MutuallyExclusiveFlag; boolean。このオプション区分の下にある1つ以上のオプションを選択できるかどうかを示します。
- OptionalFlag; boolean;コンポーネントが構造に対してオプションかどうかを示します。
- OrganizationId; string; 組織を一意に識別する値。
- PrimaryUOMCode;文字列;アイテム数量の基準単位。
- 数量;数値;使用されるコンポーネント・アイテムの数量を表す属性値。
- SoBasis; number; 「BOM品目タイプ」オプション区分のコンポーネントについて、販売オーダーが入力されたときにオプション区分のデフォルト数量を上書きする基準を示す値(デフォルト)。 オプション区分の数量は、オプション区分に割り当てられた必須の標準コンポーネントに影響します。
- StartDateTime; string; 構造内のコンポーネントが始まる日時。
- StructureItemNumber; string;パーツ、マテリアル、製品、またはサービスを識別する番号。 この属性は読取り専用であり、作成操作で変更できます。
- StructureOrganizationCode; string;企業の内部組織構造または外部組織構造内の組織単位の名前を識別する略称。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。
- WIPSupplyType; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : productStructures-Component
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : productStructures-Component-item-response
タイプ:
ソースを表示
object
-
BillSequenceId: integer
タイトル:
Bill Sequence Id
部品構成表を一意に識別する値。 これは構造ビュー・オブジェクトへの外部キーです。 この属性は読取り専用であり、リソースがすでに変更されている場合にのみ変更できます。 -
BOMItemType: number
タイトル:
Structure Item Type
標準、モデル、プランニングなどのコンポーネントに関連付けられた部品構成表のタイプ。 -
Comments: string
タイトル:
Comments
最大長:240
コンポーネントに関するコメントを表す属性値。 -
ComponentItemDescription: string
タイトル:
Description
読取り専用:true
最大長:255
コンポーネントに関連付けられたアイテムの説明。 -
ComponentItemId: string
タイトル:
Inventory Item ID
最大長:240
コンポーネントに関連付けられた品目を一意に識別する値。 -
ComponentItemName: string
タイトル:
Product
読取り専用:true
最大長:255
コンポーネントに関連付けられたアイテムの名前。 -
ComponentItemNumber: string
タイトル:
Component Product Number
コンポーネントの品目番号を表す属性。 この属性は作成操作に対してのみ更新可能で、それ以外の場合は読取り専用です。 -
ComponentOrganizationCode: string
タイトル:
Component Organization Code
最大長:255
企業の内部または外部の組織構造における組織単位の名前を識別する略称です。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。 -
ComponentSequenceId: integer
タイトル:
Component Sequence Id
構成内のコンポーネントを一意に識別する値。 この属性は読取り専用であり、更新操作に必須ではありません。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
コンポーネントを作成したユーザー。 -
CreationDateTime: string (date-time)
タイトル:
Creation Date
読取り専用:true
体系が作成された日時。 -
EndDateTime: string (date-time)
タイトル:
End Date Time
構成内のコンポーネントが終了する日時。 -
ImplementationDateTime: string (date-time)
タイトル:
Implementation Date Time
読取り専用:true
この属性は、コンポーネントが本番行として実装されたときのタイムスタンプを提供します。 この属性は、保留中コンポーネントと生産コンポーネントを区別するために使用できます。 保留中のコンポーネントの場合、これはNULLになります。 これは読取り専用属性です。 -
ItemSequenceNumber: number
タイトル:
Item Sequence
構成内のコンポーネントの順序を定義する一意の番号。 -
LastUpdateDateTime: string (date-time)
タイトル:
Last Updated Date
読取り専用:true
構造が最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:64
コンポーネントを最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login
読取り専用:true
最大長:32
コンポーネントを最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumQuantity: number
タイトル:
Maximum Quantity
値を示す属性は、オーダーで許可される最大数量を示します。 -
MinimumQuantity: number
タイトル:
Minimum Quantity
値がオーダーで許可される最小数量を示す属性。 -
MutuallyExclusiveFlag: boolean
タイトル:
Mutually Exclusive
デフォルト値:false
このオプション区分の1つ以上のオプションを選択できるかどうかを示します。 -
OptionalFlag: boolean
タイトル:
Required
デフォルト値:false
構成のコンポーネントがオプションかどうかを示します。 -
OrganizationId: string
タイトル:
Component Organization ID
最大長:240
組織を一意に識別する値です。 -
PrimaryUOMCode: string
タイトル:
Primary Unit of Measure
最大長:30
品目数量のプライマリ単位。 -
数量: number
タイトル:
Quantity
デフォルト値:1
使用されるコンポーネント品目の数量を表す属性値。 -
SoBasis: number
タイトル:
Quantity Editable
デフォルト値:2
「BOM品目タイプ」オプション区分のコンポーネントについて、販売オーダーが入力されたときにオプション区分のデフォルト数量を上書きする基準を示す値(デフォルト)。 オプション区分の数量は、オプション区分に割り当てられた必須の標準コンポーネントに影響します。 -
StartDateTime: string (date-time)
タイトル:
Start Date Time
構成内のコンポーネントが始まる日時。 -
StructureItemNumber: string
タイトル:
Structure Product Number
最大長:255
部品、資材、製品またはサービスを識別する番号。 この属性は読取り専用であり、作成操作で変更できます。 -
StructureOrganizationCode: string
タイトル:
Structure Organization Code
最大長:255
企業の内部または外部の組織構造における組織単位の名前を識別する略称です。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。 -
WIPSupplyType: integer
タイトル:
Supply Type
コンポーネントの供給のタイプ。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。