機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 製品構成

すべての製品構成の取得

get

/crmRestApi/resources/11.13.18.05/productStructures

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • AltKey : 指定した値を持つ製品構造を検索します。
      ファインダ変数:
      • ItemId; string.
      • OrganizationId; string.
    • PrimaryKey : 指定した主キーを持つ製品構造を検索します。
      ファインダ変数:
      • BillSequenceId; integer; 製品構造の一意の識別子。
    • getStructureByItemNumber : 指定した品目番号を持つ製品構成を検索します。
      ファインダ変数:
      • ItemNumber; string;パーツ、マテリアル、製品、またはサービスを識別する番号。 この属性は読取り専用であり、作成操作で変更できます。
      • OrganizationCode; string;企業の内部組織構造または外部組織構造内の組織単位の名前を識別する略称。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BillSequenceId; integer; 請求シーケンスの一意の識別子。 体系を一意に識別する値。 この属性は読取り専用で、リソースがすでに変更されている場合にのみ変更できます。
    • CommonItemNumber; string;共通構成のアイテムを識別する番号。 この属性は読取り専用です。
    • CommonOrganizationCode; string;共通構造の組織の名前。 この属性は読取り専用です。
    • CreatedBy; string; 構造を作成したユーザー。
    • CreationDateTime; string;構造が作成された日時。
    • 説明;文字列;構造の説明。
    • ItemId; string;部品、品目、製品またはサービスの一意の識別子。
    • ItemNumber; string;パーツ、マテリアル、製品、またはサービスを識別する番号。 この属性は読取り専用であり、作成操作で変更できます。
    • LastUpdateDateTime; string; 構造が最後に更新された日時。
    • LastUpdateLogin; string; 構造を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 構造を最後に更新したユーザー。
    • OrganizationCode; string;企業の内部組織構造または外部組織構造内の組織単位の名前を識別する略称。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。
    • OrganizationId; string;組織の一意の識別子。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : productStructures
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : productStructures-item-response
タイプ: object
ソースを表示
  • タイトル: Bill Sequence Id
    読取り専用: true
    請求連番の一意の識別子。 体系を一意に識別する値。 この属性は読取り専用で、リソースがすでに変更されている場合にのみ変更できます。
  • タイトル: Common Item Number
    読取り専用: true
    最大長: 255
    共通構成の品目を識別する番号。 この属性は読取り専用です。
  • タイトル: Common Organization Code
    読取り専用: true
    最大長: 255
    共通構成の組織の名前。 この属性は読取り専用です。
  • Components
    タイトル: Components
    コンポーネント・リソースは、構成内のコンポーネントの詳細を表示、作成および更新するために使用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    構造を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    体系が作成された日時。
  • タイトル: Description
    最大長: 240
    構造の説明。
  • タイトル: Inventory Item ID
    最大長: 240
    部品、品目、製品またはサービスの一意の識別子。
  • タイトル: Product Number
    部品、資材、製品またはサービスを識別する番号。 この属性は読取り専用であり、作成操作で変更できます。
  • タイトル: Last Updated Date
    読取り専用: true
    構造が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    構造を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    構造を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Organization Code
    企業の内部または外部の組織構造における組織単位の名前を識別する略称です。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。
  • タイトル: Organization ID
    最大長: 240
    組織の一意の識別子。
ネストされたスキーマ : コンポーネント
タイプ: array
タイトル: Components
コンポーネント・リソースは、構成内のコンポーネントの詳細を表示、作成および更新するために使用されます。
ソースを表示
ネストされたスキーマ : productStructures-Component-item-response
タイプ: object
ソースを表示
  • タイトル: Bill Sequence Id
    部品構成表を一意に識別する値。 これは構造ビュー・オブジェクトへの外部キーです。 この属性は読取り専用であり、リソースがすでに変更されている場合にのみ変更できます。
  • タイトル: Structure Item Type
    標準、モデル、プランニングなどのコンポーネントに関連付けられた部品構成表のタイプ。
  • タイトル: Comments
    最大長: 240
    コンポーネントに関するコメントを表す属性値。
  • タイトル: Description
    読取り専用: true
    最大長: 255
    コンポーネントに関連付けられたアイテムの説明。
  • タイトル: Inventory Item ID
    最大長: 240
    コンポーネントに関連付けられた品目を一意に識別する値。
  • タイトル: Product
    読取り専用: true
    最大長: 255
    コンポーネントに関連付けられたアイテムの名前。
  • タイトル: Component Product Number
    コンポーネントの品目番号を表す属性。 この属性は作成操作に対してのみ更新可能で、それ以外の場合は読取り専用です。
  • タイトル: Component Organization Code
    最大長: 255
    企業の内部または外部の組織構造における組織単位の名前を識別する略称です。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。
  • タイトル: Component Sequence Id
    構成内のコンポーネントを一意に識別する値。 この属性は読取り専用であり、更新操作に必須ではありません。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    コンポーネントを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    体系が作成された日時。
  • タイトル: End Date Time
    構成内のコンポーネントが終了する日時。
  • タイトル: Implementation Date Time
    読取り専用: true
    この属性は、コンポーネントが本番行として実装されたときのタイムスタンプを提供します。 この属性は、保留中コンポーネントと生産コンポーネントを区別するために使用できます。 保留中のコンポーネントの場合、これはNULLになります。 これは読取り専用属性です。
  • タイトル: Item Sequence
    構成内のコンポーネントの順序を定義する一意の番号。
  • タイトル: Last Updated Date
    読取り専用: true
    構造が最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    コンポーネントを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    コンポーネントを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Maximum Quantity
    値を示す属性は、オーダーで許可される最大数量を示します。
  • タイトル: Minimum Quantity
    値がオーダーで許可される最小数量を示す属性。
  • タイトル: Mutually Exclusive
    デフォルト値: false
    このオプション区分の1つ以上のオプションを選択できるかどうかを示します。
  • タイトル: Required
    デフォルト値: false
    構成のコンポーネントがオプションかどうかを示します。
  • タイトル: Component Organization ID
    最大長: 240
    組織を一意に識別する値です。
  • タイトル: Primary Unit of Measure
    最大長: 30
    品目数量のプライマリ単位。
  • タイトル: Quantity
    デフォルト値: 1
    使用されるコンポーネント品目の数量を表す属性値。
  • タイトル: Quantity Editable
    デフォルト値: 2
    「BOM品目タイプ」オプション区分のコンポーネントについて、販売オーダーが入力されたときにオプション区分のデフォルト数量を上書きする基準を示す値(デフォルト)。 オプション区分の数量は、オプション区分に割り当てられた必須の標準コンポーネントに影響します。
  • タイトル: Start Date Time
    構成内のコンポーネントが始まる日時。
  • タイトル: Structure Product Number
    最大長: 255
    部品、資材、製品またはサービスを識別する番号。 この属性は読取り専用であり、作成操作で変更できます。
  • タイトル: Structure Organization Code
    最大長: 255
    企業の内部または外部の組織構造における組織単位の名前を識別する略称です。 組織体系は、法的レポートと財務管理、管理レポートを実行するためのフレームワークを提供します。 この属性は読取り専用であり、作成操作で変更できます。
  • タイトル: Supply Type
    コンポーネントの供給のタイプ。
「トップに戻る」