すべての製品の取得
get
/crmRestApi/resources/11.13.18.05/products
リクエスト
問合せパラメータ
- 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 : 指定した主キーで製品を検索します。
ファインダ変数:- InventoryItemId; integer; 製品の作成時に生成された在庫品目の一意の識別子。
- ProductList : 製品リストを含む製品を検索します。
ファインダ変数:- Bind_CountryCode; string; 製品適格が定義されている国コード。
- Bind_FilterByTerritory; string;フィルタ・テリトリを持つ製品を検索します。
- Bind_GeographyId; integer;地理の一意の識別子。
- Bind_OverrideEligibility; string;製品の上書き適用。
- Bind_UsageCode; string;製品の使用法コード。
- Bind_UsageModeCode; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- ATPCode; string;需要発生時に有効在庫数量または有効在庫数量(あるいはその両方)の情報をチェックします。
- ATPComponentsCode; string; ATO品目およびPTO品目の部品構成表に追加の構成部品を含めるかどうかを示します。
- AllowSuspendFlag; boolean;サービスを一時停止できるかどうかを示します。
- AllowTerminateFlag; boolean;サービスを終了できるかどうかを示します。
- ApprovalStatus; string;アイテムの承認ステータス。
- AssetTrackedFlag; boolean;アイテムが資産として導入ベースで追跡されるかどうかを示します。
- AttachmentEntityName; string;添付エンティティの名前。
- AutoSerialAlphaPrefix; string;アイテムに定義されているすべてのシリアル番号の開始アルファベット・プレフィクス。
- BOMItemType;文字列;標準、モデル、計画など、アイテムが所有できる部品構成表のタイプ。
- CSSEnabled; string; 製品が顧客セルフサービスに対して使用可能かどうかを示します。 デフォルト値は、Noです。
- CollateralFlag; boolean;アイテムが販促資料かどうかを示します。
- ConfigurableFlag; boolean;見積時に製品を構成できるかどうかを示します。
- ContainerItemFlag; boolean;品目の出荷にコンテナが使用されるかどうかを示します。
- ContainerTypeCode; string;コンテナのタイプを示す属性。
- CoverageName; string;契約アイテム・タイプに関連付けられたテンプレートの名前。
- CoverageScheduleId; integer; 契約アイテム・タイプに関連付けられたテンプレート。
- CreatedBy; string; 製品レコードを作成したユーザー。
- CreationDate; string;製品レコードが作成された日時。
- CustomerOrderFlag; boolean;外部顧客による品目のオーダーを許可するかどうかを示します。
- CxAssetTrackedFlag; boolean;「Y」に設定された製品が顧客所有アセットとして表示されるかどうかを示します。
- DefaultPeriodicity; string; 製品のデフォルトの価格周期(月次など)。
- DefaultPeriodicityCode; string; 製品のデフォルトの価格周期コード(月次など)。
- DefaultPeriods; integer; 製品の価格期間のデフォルト数。
- DefaultPriceType; string;単発や固定処理など、製品のデフォルトの価格タイプを識別します。
- DefaultPriceTypeCode; string;単発や固定処理など、製品のデフォルトの価格タイプ・コードを識別します。
- DefaultUOM; string; 製品のデフォルトの単位(UOM)。
- DefaultUOMCode; string; 製品のデフォルトの単位(UOM)コード。
- DeleteFlag; boolean;製品を削除できるかどうかを示します。 デフォルト値はfalseです。
- 説明;文字列;製品の説明。
- DimensionUOMCode; string;アイテムのディメンションの単位。
- EligibilityCompatibilityRuleFlag;ブール。オファーを顧客が使用できるようにするために満たす必要がある特定の制約または要件のセット。 たとえば、顧客はロイヤルティ・プログラムのメンバーになることや、特定の州に住むこと、会社で高給を得ること、オファーに適格になるために既存の契約に縛られないことを望みます。
- EligibleToSell; string; 製品が販売に適格かどうかを示します。
- EligibleToSellFlag; boolean;アイテムを販売できるかどうかを示します。
- EquipmentTypeFlag; boolean;アイテムが機器かどうかを示します。
- EventFlag; boolean;アイテムがイベントかどうかを示します。
- FinancingAllowedFlag; boolean;顧客がこのアイテムの資金調達が可能かどうかを示します。
- InternalVolume; number;コンテナまたは車両の内部ボリューム。
- InvOrgId; integer;在庫組織の一意の識別子。
- InventoryItemId; integer; 在庫アイテムの一意の識別子。 この値は、製品の作成時に生成されます。
- InventoryItemStatusCode; string; 製品のステータスを示す事前定義済コード。 デフォルト値はアクティブです。
- InvoiceEnabledFlag; boolean; Oracle Receivablesで請求する品目をアクティブ化するかどうかを示します。
- InvoiceableItemFlag; boolean; Oracle Receivablesの請求書に品目を含めるかどうかを示します。
- ItemCatalogGroupId; integer; 製品が属するカタログ・グループの一意の識別子。
- ItemNumber; string;製品の一意の代替識別子。
- ItemType; string;完了や購入など、アイテムのインジケータまたは分類。
- LastUpdateDate; string; 製品レコードが最後に更新された日時。
- LastUpdateLogin; string; 製品レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; 製品レコードを最後に更新したユーザー。
- MaximumLoadWeight; number;コンテナまたは車両の最大積載重量。
- MinimumFillPercent; number;使用するコンテナまたは車両の最小充填。
- ModelConfigAttributes; string;製品のモデル構成。
- ModelFamily; string;製品グループに関連付けられたモデル・ファミリの名前。
- ModelLine; string;製品グループに関連付けられたモデル行の名前。
- ModelName; string;モデルの名前。
- 名前;文字列;製品の作成時に生成された在庫品目の名前。
- OrganizationId; integer; 製品に関連付けられた在庫組織の一意の識別子。
- PickComponentsFlag;ブール。品目にオプション、区分、完成品在庫からピックされた展開品目を含む部品構成表があるかどうかを示します。
- ProcessingDays; number;オーダーのリード・タイム。
- ProductLaunchFlag; boolean;製品を販売する準備ができているかどうかを示します。
- ProductStatusCode; string;製品ローンチを追跡するステータス。
- ProductType; string; sales製品のタイプを示すコード。 たとえば、商品、含まれる保証、延長保証、サービス・レベル契約、トレーニング、サブスクリプションなどです。
- ProductTypeCode; string;プロダクトのタイプを示すコード。 受け入れられる値は、COVERAGE、GOODS、INCLUDED_WARRANTY、INSTALLATION、ONE_TIME_SERVICE、PREVENTIVE_MAINTENANCE、SERVICE_LEVEL_AGREEMENT、SOFTWARE_MAINTENANCE、SUBSCRIPTIONおよびTRAININGです。
- ReplenishToOrderFlag; boolean;販売オーダー詳細に基づいて作成される最終組立作業指示。
- ReturnableFlag; boolean;顧客が品目を返品できるようにするかどうかを示します。
- SerialNumberControlCode; string;アイテムの各単位に割り当てられ、アイテムの追跡に使用される番号。
- ServiceDuration; number;サービス期間を示す数値。
- ServiceDurationPeriodCode; string; サービス期間を示す数値。
- ServiceDurationTypeCode; string;サービス・アイテムに適用可能な期間のタイプ。
- ServiceStartDelay; number;マイルストーンの後にサービスを開始する際の遅延を指定する属性。
- ServiceStartTypeCode; string;サービス・アイテムに使用するサービス開始ルールのタイプ。
- ShippableItemFlag; boolean;アイテムを顧客に出荷するかどうかを示します。
- StartAutoSerialNumber; string; このアイテムのすべてのシリアル番号の開始番号。
- UnitHeight; number;アイテムの高さ。
- UnitLength; number;アイテムの長さ。
- UnitVolume; number; 1単位のアイテムのボリューム。
- UnitWeight; number;アイテムの1単位の重み。
- UnitWidth; number;アイテムの幅。
- UpdateFlag; boolean;製品を更新できるかどうかを示します。 デフォルト値はtrueです。
- VehicleItemFlag; boolean;車両が品目の出荷に使用されるかどうかを示します。
- VolumeUOMCode; string;体積単位。
- WIPSupplyType; integer;コンポーネントの供給タイプ。
- WeightUOMCode; 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のデフォルト・バージョンを選択します。
ルート・スキーマ : 製品
タイプ:
ソースを表示
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"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : products-item-response
タイプ:
ソースを表示
object
-
AllowSuspendFlag: boolean
タイトル:
Allow Suspend
最大長:1
サービスを一時停止できるかどうかを示します。 -
AllowTerminateFlag: boolean
タイトル:
Allow Terminate
最大長:1
サービスを終了できるかどうかを示します。 -
ApprovalStatus: string
タイトル:
Approval Status
読取り専用:true
最大長:30
品目の承認ステータス。 -
AssetTrackedFlag: boolean
タイトル:
Enable Asset Tracking
最大長:1
導入ベースで品目がアセットとして追跡されるかどうかを示します。 -
ATPCode: string
タイトル:
Check ATP
最大長:1
需要を配置するときに、納期回答または納期回答(あるいはその両方)の情報をチェックします。 -
ATPComponentsCode: string
タイトル:
ATP Components
最大長:1
ATOおよびPTO品目の部品構成表に追加の構成部品を含めるかどうかを示します。 -
AttachmentEntityName: string
デフォルト値:
ITEM_ENTITY
添付エンティティの名前。 -
AutoSerialAlphaPrefix: string
タイトル:
Starting Serial Prefix
最大長:80
品目に対して定義されているすべてのシリアル番号の開始アルファベット・プリフィクス。 -
BOMItemType: string
タイトル:
Structure Item Type
最大長:30
標準、モデル、計画など、品目に含めることができる部品構成表のタイプ。 -
CollateralFlag: boolean
タイトル:
Collateral
最大長:1
品目が販促資料かどうかを示します。 -
ConfigurableFlag: boolean
タイトル:
Configurable
最大長:1
見積時に製品を構成可能かどうかを識別します。 -
ContainerItemFlag: boolean
タイトル:
Container
最大長:1
品目の出荷にコンテナが使用されるかどうかを示します。 -
ContainerTypeCode: string
タイトル:
Container Type
最大長:30
コンテナのタイプを示す属性。 -
CoverageName: string
タイトル:
Standard Coverage
最大長:150
契約アイテム・タイプに関連付けられたテンプレートの名前。 -
CoverageScheduleId: integer (int64)
タイトル:
Coverage Schedule ID
契約アイテム・タイプに関連付けられたテンプレート。 -
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
製品レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
製品レコードが作成された日時。 -
CSSEnabled: string
タイトル:
Enable Customer Self-Service
最大長:1
デフォルト値:N
製品が顧客セルフサービスに対して使用可能かどうかを示します。 デフォルト値は、Noです。 -
CustomerOrderFlag: boolean
タイトル:
Customer Ordered
最大長:1
外部顧客による品目のオーダーを許可するかどうかを示します。 -
CxAssetTrackedFlag: boolean
タイトル:
Enable Customer Asset Tracking
最大長:1
デフォルト値:false
「Y」に設定された製品を顧客所有アセットとして表示するかどうかを示します。 -
DefaultPeriodicity: string
タイトル:
Default Periodicity
最大長:80
製品のデフォルト価格周期(月次など)。 -
DefaultPeriodicityCode: string
タイトル:
Default Periodicity Code
最大長:30
製品のデフォルト価格周期コード(月次など)。 -
DefaultPeriods: 整数(int32)
タイトル:
Default Periods
製品の価格期間のデフォルト数。 -
DefaultPrices: array Default Prices
タイトル:
Default Prices
デフォルトの価格リソースは、製品のデフォルト価格を表示、作成、更新および削除するために使用されます。 -
DefaultPriceType: string
タイトル:
Default Price Type
最大長:80
単発や定型など、製品のデフォルトの価格タイプを識別します。 -
DefaultPriceTypeCode: string
タイトル:
Default Price Type Code
最大長:30
単発や定型など、製品のデフォルトの価格タイプ・コードを識別します。 -
DefaultUOM: string
タイトル:
Default UOM
最大長:25
製品のデフォルト単位(UOM)。 -
DefaultUOMCode: string
タイトル:
Default UOM Code
最大長:3
製品のデフォルトの単位(UOM)コード。 -
DeleteFlag: boolean
読取り専用:
true
製品を削除できるかどうかを示します。 デフォルト値はfalseです。 -
Description: string
タイトル:
Description
最大長:4000
製品の摘要。 -
DimensionUOMCode: string
タイトル:
Dimension Unit of Measure
最大長:3
品目のディメンションの単位。 -
EligibilityCompatibilityRuleFlag: boolean
タイトル:
Eligibility Rule
最大長:1
オファーを顧客が利用できるようにするために満たす必要がある制約または要件のセットを指定します。 たとえば、顧客はロイヤルティ・プログラムのメンバーになることや、特定の州に住むこと、会社で高給を得ること、オファーに適格になるために既存の契約に縛られないことを望みます。 -
EligibleForService: string
タイトル:
Eligible for Service
デフォルト値:Y
製品がサービスに適格かどうかを示します。 -
EligibleToSell: string
タイトル:
Meaning
最大長:80
製品が販売に適格かどうかを示します。 -
EligibleToSellFlag: boolean
タイトル:
Eligible to Sell
最大長:1
デフォルト値:true
品目を販売できるかどうかを示します。 -
EquipmentTypeFlag: boolean
タイトル:
Warehouse Equipment
最大長:30
品目が機材かどうかを示します。 -
EventFlag: boolean
タイトル:
Event
最大長:1
品目がイベントかどうかを示します。 -
ExtendedDescriptionOne: 文字列(バイト)
タイトル:
Extended Description 1
製品の最初の追加説明。 -
ExtendedDescriptionTwo: 文字列(バイト)
タイトル:
Extended Description 2
製品の2番目の追加摘要。 -
FinancingAllowedFlag: boolean
タイトル:
Financing Allowed
最大長:1
顧客がこのアイテムの資金調達が可能かどうかを示します。 -
InternalVolume: number
タイトル:
Internal Volume
コンテナまたは車両の内部容積。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Item ID
在庫品目の一意の識別子。 この値は、製品の作成時に生成されます。 -
InventoryItemStatusCode: string
タイトル:
Product Status Code
最大長:10
デフォルト値:Active
製品のステータスを示す事前定義コード。 デフォルト値はアクティブです。 -
InvoiceableItemFlag: boolean
タイトル:
Invoiced
最大長:1
Oracle Receivables請求書に品目を含めるかどうかを示します。 -
InvoiceEnabledFlag: boolean
タイトル:
Invoice Enabled
最大長:1
Oracle Receivablesで請求の品目をアクティブ化するかどうかを示します。 -
InvOrgId: integer (int64)
タイトル:
Inventory Organization ID
読取り専用:true
在庫組織の一意の識別子。 -
ItemCatalogGroupId: integer (int64)
タイトル:
Item Catalog Group ID
製品が属するカタログ・グループの一意の識別子。 -
ItemNumber: string
タイトル:
Product Number
最大長:300
製品の一意の代替識別子。 -
ItemType: string
タイトル:
User Item Type
最大長:30
終了、購入など、品目のインジケータまたは分類。 -
LastUpdateDate: 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
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumLoadWeight: number
タイトル:
Maximum Load Weight
コンテナまたは車両の最大積載重量。 -
MinimumFillPercent: number
タイトル:
Minimum Fill Percent
使用するコンテナまたは車両の最小充填。 -
ModelConfigAttributes: string
タイトル:
Model Attributes
最大長:4000
製品のモデル構成。 -
ModelFamily: string
タイトル:
Model Family
最大長:1000
製品グループに関連付けられているモデル・ファミリの名前。 -
ModelLine: string
タイトル:
Model Line
最大長:1000
製品グループに関連付けられているモデル明細の名前。 -
ModelName: string
タイトル:
Model
最大長:1000
モデルの名前。 -
Name: string
タイトル:
Name
最大長:240
製品の作成時に生成された在庫品目の名前。 -
OrganizationCode: string
タイトル:
Organization Code
読取り専用:true
最大長:18
組織を一意に識別するコード。 この値は、ItemOrganizationIdから導出されます。 -
OrganizationId: integer (int64)
タイトル:
Organization ID
製品に関連付けられている在庫組織の一意の識別子。 -
PickComponentsFlag: boolean
タイトル:
Pick Components
最大長:1
品目にオプション、区分、完成品在庫からピックされた展開品目を含む部品構成表があるかどうかを示します。 -
ProcessingDays: number
タイトル:
Processing Days
オーダーのリード・タイム。 -
ProductAttachments: array Product Attachments
タイトル:
Product Attachments
添付リソースは、製品の添付の表示、作成および更新に使用されます。 添付には、製品に関する追加情報が含まれます。 -
ProductImageAttachments: array Product Image Attachments
タイトル:
Product Image Attachments
添付リソースは、製品のイメージ添付の表示、作成および更新に使用されます。 -
ProductLaunchFlag: boolean
タイトル:
Product Launch Indicator
最大長:1
デフォルト値:false
製品を販売する準備ができているかどうかを示します。 -
ProductStatusCode: string
タイトル:
Launch Status
最大長:30
デフォルト値:ORA_CREATED
製品ローンチを追跡するステータス。 -
ProductTranslations: array Product Translations
タイトル:
Product Translations
製品翻訳リソースは、製品の様々なインストール済言語での製品翻訳の表示、作成、更新および削除に使用されます。 -
ProductType: string
タイトル:
Sales Product Type
最大長:80
販売製品のタイプを示すコード。 たとえば、商品、含まれる保証、延長保証、サービス・レベル契約、トレーニング、サブスクリプションなどです。 -
ProductTypeCode: string
タイトル:
Sales Product Type Code
最大長:30
製品のタイプを示すコード。 受け入れられる値は、COVERAGE、GOODS、INCLUDED_WARRANTY、INSTALLATION、ONE_TIME_SERVICE、PREVENTIVE_MAINTENANCE、SERVICE_LEVEL_AGREEMENT、SOFTWARE_MAINTENANCE、SUBSCRIPTIONおよびTRAININGです。 -
ReplenishToOrderFlag: boolean
タイトル:
Assemble to Order
最大長:1
販売オーダーの詳細に基づいて作成される最終アセンブリ作業オーダーです。 -
ReturnableFlag: boolean
タイトル:
Returnable
最大長:1
顧客が品目を返品できるようにするかどうかを示します。 -
SalesProductLookupType: object SalesProductLookupType
販売製品タイプの参照タイプ。
-
SerialNumberControlCode: string
タイトル:
Serial Number Control
最大長:30
アイテムの各ユニットに割り当てられ、アイテムの追跡に使用される番号。 -
ServiceDuration: number
タイトル:
Service Duration
サービス期間を示す数値。 -
ServiceDurationPeriodCode: string
タイトル:
Service Duration Period
最大長:10
サービス期間を示す数値。 -
ServiceDurationTypeCode: string
タイトル:
Service Duration Type
最大長:3
サービス・アイテムに適用可能な期間のタイプ。 -
ServiceStartDelay: number
タイトル:
Service Start Delay
マイルストンの後にサービスを開始する際の遅延を指定する属性。 -
ServiceStartTypeCode: string
タイトル:
Service Start Type
最大長:3
サービス・アイテムに使用されるサービス開始ルールのタイプ。 -
ShippableItemFlag: boolean
タイトル:
Shippable
最大長:1
品目を顧客に出荷するかどうかを示します。 -
smartActions: array Smart Actions
タイトル:
Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。 -
StartAutoSerialNumber: string
タイトル:
Starting Serial Number
最大長:80
このアイテムのすべてのシリアル番号の開始番号。 -
TemplateName: string
タイトル:
Product Template
最大長:960
テンプレートの名前。 -
UnitHeight: number
タイトル:
Height
アイテムの高さ。 -
UnitLength: number
タイトル:
Length
アイテムの長さ。 -
UnitVolume: number
タイトル:
Unit Volume
1単位の品目の容積。 -
UnitWeight: number
タイトル:
Unit Weight
1単位のアイテムの重量。 -
UnitWidth: number
タイトル:
Width
アイテムの幅。 -
UpdateFlag: boolean
読取り専用:
true
製品を更新できるかどうかを示します。 デフォルト値はtrueです。 -
VehicleItemFlag: boolean
タイトル:
Vehicle
最大長:1
車両が品目の出荷に使用されるかどうかを示します。 -
VolumeUOMCode: string
タイトル:
Volume Unit of Measure
最大長:3
容積単位。 -
WeightUOMCode: string
タイトル:
Weight Unit of Measure
最大長:3
重量単位。 -
WIPSupplyType: integer (int64)
タイトル:
Supply Type
コンポーネントの供給タイプ。
ネストされたスキーマ : デフォルト価格
タイプ:
array
タイトル:
Default Prices
デフォルトの価格リソースは、製品のデフォルト価格を表示、作成、更新および削除するために使用されます。
ソースを表示
ネストされたスキーマ : 製品添付
タイプ:
array
タイトル:
Product Attachments
添付リソースは、製品の添付の表示、作成および更新に使用されます。 添付には、製品に関する追加情報が含まれます。
ソースを表示
ネストされたスキーマ : 製品イメージ添付
タイプ:
array
タイトル:
Product Image Attachments
添付リソースは、製品のイメージ添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : 製品翻訳
タイプ:
array
タイトル:
Product Translations
製品翻訳リソースは、製品の様々なインストール済言語での製品翻訳の表示、作成、更新および削除に使用されます。
ソースを表示
ネストされたスキーマ : SalesProductLookupType
タイプ:
object
販売製品タイプの参照タイプ。
ネストされたスキーマ : スマートなアクション
タイプ:
array
タイトル:
Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。
ソースを表示
ネストされたスキーマ : products-DefaultPrices-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
デフォルト価格を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
デフォルト価格が作成された日時。 -
CurrencyCode: string
タイトル:
Currency
最大長:15
デフォルト価格の通貨のコード。 -
DefaultPriceId: integer (int64)
読取り専用:
true
デフォルト価格の一意の識別子。 この値は、デフォルト価格の作成時に生成されます。 -
InvItemId: integer (int64)
タイトル:
Inventory Item ID
読取り専用:true
デフォルト価格に関連付けられた在庫品目の一意の識別子 -
InvOrgId: integer (int64)
読取り専用:
true
デフォルト価格に関連付けられた在庫組織の一意の識別子。 -
ItemNumber: string
タイトル:
Product Number
最大長:300
製品の一意の代替識別子。 -
LastUpdateDate: string (date-time)
読取り専用:
true
デフォルト価格が最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
デフォルト価格を最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
デフォルト価格を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ListPrice: number
タイトル:
List Price
デフォルト値:0
製品、通貨および単位の組合せの定価。 -
ObjectVersionNumber: 整数(int32)
読取り専用:
true
オプティミスティック・ロックの実装に使用される数。 この番号は、行を更新するたびに増分されます。 この数値は、トランザクションの開始時と終了時に比較され、別のセッションがその行を更新したかどうかが判断されます。 -
PricebookId: integer (int64)
デフォルト価格に関連付けられた価格台帳の一意の識別子
-
PriceBookName: string
タイトル:
Name
読取り専用:true
最大長:150
デフォルト価格に関連付けられた価格表の名前。 -
PriceUOMCode: string
タイトル:
UOM
最大長:30
デフォルト価格の単位コード。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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値を変更します。
ネストされたスキーマ : products-ProductAttachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付されたイメージ・ドキュメントの一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリの名前。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
添付を作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
添付画像をアップロードした個人のユーザー名。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
添付レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示すコード。 たとえば、ファイルまたはwebページです。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の現在のバージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・タイプ(ある場合)を示すコード。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツが失効する日付。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
添付のURL。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
写真の添付を最後に更新した個人のユーザー名。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルの長さ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
添付のテキスト。 -
Uri: string
タイトル:
Uri
最大長:4000
添付のURI。 -
Url: string
タイトル:
Url
最大長:4000
添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付に関連付けられているログイン。
ネストされたスキーマ : products-ProductImageAttachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される一意の識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付されたイメージ・ドキュメントの一意の識別子。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリの名前。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
添付を作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
添付画像をアップロードした個人のユーザー名。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
添付レコードが作成された日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を示すコード。 たとえば、ファイルまたはwebページです。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付文書の一意の識別子。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付の現在のバージョン番号。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー・タイプ(ある場合)を示すコード。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージ(ある場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付ファイルのコンテンツが失効する日付。 -
FileContents: 文字列(バイト)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
添付のURL。 -
FileWebImage: 文字列(バイト)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
レコードが最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
レコードを最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
写真の添付を最後に更新した個人のユーザー名。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルの長さ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
添付のテキスト。 -
Uri: string
タイトル:
Uri
最大長:4000
添付のURI。 -
Url: string
タイトル:
Url
最大長:4000
添付のURL。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付に関連付けられているログイン。
ネストされたスキーマ : products-ProductTranslations-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:64
製品レコードを作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
製品レコードが作成された日時。 -
Description: string
タイトル:
Description
最大長:4000
製品の詳細説明。 -
ExtendedDescriptionOne: 文字列(バイト)
タイトル:
Extended Description 1
製品の最初の追加説明。 -
ExtendedDescriptionTwo: 文字列(バイト)
タイトル:
Extended Description 2
製品の2番目の追加摘要。 -
InventoryItemId: integer (int64)
タイトル:
Inventory Item ID
在庫品目の一意の識別子。 この値は、製品の作成時に生成されます。 -
ItemNumber: string
読取り専用:
true
最大長:300
製品の一意の代替識別子。 -
Language: string
最大長:
4
翻訳レコードの翻訳済言語。 -
LastUpdateDate: 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
リソース・インスタンスに関連付けられたリンク関係。 -
Name: string
タイトル:
Name
最大長:240
製品の摘要。 -
OrganizationId: integer (int64)
タイトル:
Organization ID
製品に関連付けられている在庫組織の一意の識別子。 -
SourceLang: string
最大長:
4
翻訳レコードのソース言語。
ネストされたスキーマ : products-smartActions-item-response
タイプ:
ソースを表示
object
-
ActionIntent: 文字列(バイト)
タイトル:
Action Intent
アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。 -
ActiveFlag: boolean
タイトル:
Active
最大長:1
アクションがアクティブか非アクティブかを示すブール値。 -
ApplicationRoles: string
タイトル:
Application Roles
最大長:1000
スマート処理に関連付けられたアプリケーション・ロール。 -
Condition: string
タイトル:
Filter Condition
最大長:1000
このアクションの修飾に使用するGroovyスクリプト。 -
ConfirmationMessage: string
タイトル:
Confirmation Message
最大長:1024
実行中のアクションの確認を求めるメッセージ。 -
ContentType: string
タイトル:
Content Type
最大長:50
RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。 -
ContextualFlag: boolean
タイトル:
Contextual
最大長:1
スマート処理がコンテキスト処理であるかどうかを示します。 -
DataPrivilege: string
タイトル:
Data Security Privilege
最大長:250
権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。 -
DisplayLabel: string
タイトル:
Action Name
最大長:256
わかりやすいアクション名。 -
Entity: string
タイトル:
Parent Entity
最大長:150
処理が属するRESTリソース。 -
Href: string
タイトル:
REST Endpoint
最大長:150
アクションを実行するRESTエンドポイント。 -
IncludedIn: string
タイトル:
Included In
最大長:150
このアクションが属するビュー・オブジェクト。 複数のカンマ区切り値を含めることができます。 -
IncludedInApplication: string
タイトル:
Included in Application
最大長:512
このアクションを使用できるアプリケーションのリスト。 -
InternalFlag: boolean
タイトル:
Restricted
最大長:1
この処理が内部かどうかを示すブール型。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MassActionFlag: boolean
タイトル:
Mass Action
最大長:1
この処理を一括処理できるかどうかを示すブール・タイプです。 -
Method: string
タイトル:
HTTP Method
最大長:15
HREFで使用するHTTPメソッド。 -
ObjectFunctionName: string
タイトル:
Object Function
最大長:64
スマート・アクションに関連付けられたオブジェクト関数。 -
PageType: string
タイトル:
Page Type
最大長:256
このアクションを使用できるページのリスト。 -
SmartSuggestFlag: boolean
タイトル:
Smart Suggest
最大長:1
処理に対してスマート提案が使用可能かどうかを示します。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
アクションがシード済かカスタムかを示すブール型。 -
UpdateOfAttributes: string
タイトル:
Attributes to Update
最大長:512
処理UIの起動時に更新される属性。 -
UserActionId: integer (int64)
タイトル:
User Action ID
処理を一意に識別します。 内部使用。 -
UserActionName: string
タイトル:
Action Name
最大長:256
名前でアクションを一意に識別します。 内部使用。 - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer (int64)
タイトル:
Priority
処理の優先度を示す番号。 -
UserActionRequestPayload: array Smart Action REST Payload Definitions
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。 -
UserActionURLBinding: array Smart Action User Interface Definitions
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。 -
UserPrivilege: string
タイトル:
User Security Privilege
最大長:2000
ユーザー・セキュリティ権限。
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ:
array
タイトル:
Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
ソースを表示
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ:
array
タイトル:
Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ソースを表示
ネストされたスキーマ : products-smartActions-UserActionRequestPayload-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
Payload Value Binding Type
最大長:64
値のバインディング・タイプを示します。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MandatoryFlag: boolean
タイトル:
Mandatory
最大長:1
ペイロードが必須かどうかを示すブール値。 -
RequestPayloadId: integer (int64)
スマート・アクションのペイロードを一意に識別します。 内部使用。
-
RequestPayloadName: string
タイトル:
Request Payload Attribute Name
最大長:256
ペイロードを形成するキー値ペアのキー。 -
SmartSuggestPath: string
タイトル:
Smart Suggest Path
最大長:2048
スマート候補に使用されるパス。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール値。 -
Value: string
タイトル:
Request Payload Attribute Value
最大長:250
ペイロードを形成するキー値ペアの値。 -
ValueStruct: string
タイトル:
Payload Value Structure
最大長:20
キー値ペアの値が単一の値でない場合は、これが設定されます。
ネストされたスキーマ : products-smartActions-UserActionURLBinding-item-response
タイプ:
ソースを表示
object
-
Binding: string
タイトル:
URL Binding Type
最大長:64
これは、URLバインディング・ランタイムを処理するためのヒントです。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
SystemActionFlag: boolean
タイトル:
System Action
最大長:1
デフォルト値:false
ブール・インジケータ。 -
URLBindingId: integer (int64)
スマート・アクションのURLバインドを一意に識別します。 内部使用。
-
URLBindingName: string
タイトル:
URL Binding Parameter Name
最大長:50
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。 -
Value: string
タイトル:
URL Binding Parameter Value
最大長:80
ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。
例:
次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行して、すべての製品を取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/products
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ -items: [25] -0: { InventoryItemId: 300100072827858 InventoryItemStatusCode: "Active" ItemCatalogGroupId: 100000011369001 ItemNumber: "NewProductded95808922" Description: "New_Desc2ac95808950" OrganizationId: 204 Name: "New_ProdName2f595808963" EligibleToSellFlag: true DefaultUOMCode: "Box" ProductTypeCode: "GOODS" DefaultUOM: "Box" UOMCode: "Box" ... }