Get a mapped product template
get
/crmRestApi/resources/11.13.18.05/mappedProductTemplates/{mappedProductTemplatesUniqID}
Request
Path Parameters
-
mappedProductTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- InventoryItemId and OrganizationId ---for the Mapped Product Templates resource and used to uniquely identify an instance of Mapped Product Templates. The client should not generate the hash key value. Instead, the client should query on the Mapped Product Templates collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapped Product Templates.
For example: mappedProductTemplates?q=InventoryItemId=<value1>;OrganizationId=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : mappedProductTemplates-item-response
Type:
Show Source
object
-
AllowMaintenanceAsset: string
Read Only:
true
Maximum Length:1
The maintainable asset configuration. -
AllowMaintenanceAssetFlag: boolean
Read Only:
true
Indicates whether maintainable assets can be defined for the item. -
AllowSuspend: string
Read Only:
true
Maximum Length:1
Indicates whether a service can be suspended. -
AllowSuspendFlag: boolean
Read Only:
true
Indicates whether a service can be suspended. -
AllowTerminate: string
Read Only:
true
Maximum Length:1
Indicates whether a service can be terminated. -
AllowTerminateFlag: boolean
Read Only:
true
Indicates whether a service can be terminated. -
ApprovalStatus: string
Read Only:
true
Maximum Length:30
The approval status of the item. -
AssetTracked: string
Read Only:
true
Maximum Length:1
Indicates whether an item is tracked as an asset in installed base. -
AssetTrackedFlag: boolean
Read Only:
true
Indicates whether an item is tracked as an asset in installed base. -
ATPCode: string
Read Only:
true
Maximum Length:1
The ATP code to check if available to promise and/or capable to promise information, when placing demand. -
ATPComponentsCode: string
Read Only:
true
Maximum Length:1
Indicates whether to include, in available to promise checking, additional components in the bill of material for ATO and PTO items. -
AutoSerialAlphaPrefix: string
Read Only:
true
Maximum Length:80
The starting alphabet prefix for all serial numbers which are being defined for the Item. -
BOMItemType: number
Read Only:
true
The type of bill of material the item can possess such as standard, model, planning, and other. -
Collateral: string
Read Only:
true
Maximum Length:1
Indicates whether the item is a collateral. -
CollateralFlag: boolean
Read Only:
true
Indicates whether the item is a collateral. -
ContainerItem: string
Read Only:
true
Maximum Length:1
Indicates whether containers are used for shipping the items. -
ContainerItemFlag: boolean
Read Only:
true
Indicates whether containers are used for Shipping the items. -
ContainerTypeCode: string
Read Only:
true
Maximum Length:30
The code that specifies the type of the container. -
CoverageScheduleId: integer
(int64)
Read Only:
true
The template associated with the contract item type. -
CSSEnabled: string
Read Only:
true
Maximum Length:1
Indicates if the product is enabled for customer self-service. The default value is No. -
CSSEnabledFlag: boolean
Read Only:
true
Indicates if the product is enabled for customer self-service. The default value is No. -
CustomerOrder: string
Read Only:
true
Maximum Length:1
Indicates whether to allow an item to be ordered by external customers. -
CustomerOrderFlag: boolean
Read Only:
true
Indicates whether to allow an item to be ordered by external customers. -
DefaultTemplate: string
Read Only:
true
Maximum Length:1
Indicates whether it???s a default item template of that organization under root item class. -
DefaultTemplateFlag: boolean
Read Only:
true
Indicates whether it???s a default item template of that organization under root item class. -
DefaultUOM: string
Read Only:
true
The default unit of measure (UOM) for the product. -
DefaultUOMCode: string
Read Only:
true
Maximum Length:3
The default unit of measure (UOM) code for the product. -
DimensionUOMCode: string
Read Only:
true
Maximum Length:3
The unit of measure for the dimension of the item. -
EligibilityCompatibilityRule: string
Read Only:
true
Maximum Length:1
A specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer. -
EligibilityCompatibilityRuleFlag: boolean
Read Only:
true
Indicates a specific set of constraints or requirements that must be met for the offer to be available to a customer. For example, the customer may need to be a member of the loyalty program, or live in a certain state, or be in good financial standing with the company, or not be locked into an existing contract to be eligible for an offer. -
EligibleToSell: string
Read Only:
true
Maximum Length:1
Indicates whether the item can be sold or not. -
EligibleToSellFlag: boolean
Read Only:
true
Indicates whether the item can be sold or not. -
EquipmentType: number
Read Only:
true
Indicates whether the item is equipment. -
EquipmentTypeFlag: boolean
Read Only:
true
Indicates whether the item is equipment. -
Event: string
Read Only:
true
Maximum Length:1
Indicates whether the item is event. -
EventFlag: boolean
Read Only:
true
Indicates whether the item is event. -
FinancingAllowed: string
Read Only:
true
Maximum Length:1
Indicates whether a customer can finance this item. -
FinancingAllowedFlag: boolean
Read Only:
true
Indicates whether a customer can finance this item. -
InternalVolume: number
Read Only:
true
The internal volume of the container or vehicle. -
InventoryItemId: integer
(int64)
Read Only:
true
The unique identifier of the inventory item. -
InventoryItemStatusCode: string
Read Only:
true
Maximum Length:10
The predefined code that indicates the status of the product. The default value is active. -
InvoiceableItem: string
Read Only:
true
Maximum Length:1
Indicates whether to include an item on an Oracle Receivables invoice. -
InvoiceableItemFlag: boolean
Read Only:
true
Indicates whether to include an item on an Oracle Receivables invoice. -
InvoiceEnabled: string
Read Only:
true
Maximum Length:1
Indicates whether to activate an item for invoicing in Oracle Receivables. -
InvoiceEnabledFlag: boolean
Read Only:
true
Indicates whether to activate an item for invoicing in Oracle Receivables. -
ItemCatalogGroupId: integer
(int64)
Read Only:
true
The unique identifier of the catalog group that the product belongs to. -
ItemTemplateName: string
Read Only:
true
Maximum Length:960
The name of item template. -
ItemType: string
Read Only:
true
Maximum Length:30
Indicator or classification for an item, such as finished or purchased. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumLoadWeight: number
Read Only:
true
The maximum load weight of the container or vehicle. -
MinimumFillPercent: number
Read Only:
true
The minimum fill of the container or vehicle to be used. -
OrganizationCode: string
Read Only:
true
Maximum Length:1000
The unique code of the sales product item organization. -
OrganizationId: integer
(int64)
Read Only:
true
The unique identifier of the inventory item organization associated with the item template. -
PickComponents: string
Read Only:
true
Maximum Length:1
Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory. -
PickComponentsFlag: boolean
Read Only:
true
Indicates whether an item has a bill of material with options, classes, or included items picked from finished goods inventory. -
ProcessingDays: number
Read Only:
true
The lead time for the order. -
ProdTmplMappingCode: string
Read Only:
true
Maximum Length:300
The unique identifer of product template mapping. -
ProductType: string
Read Only:
true
Maximum Length:80
The code indicating the type of the sales product, such as Goods, Included Warranty, Extended arranty, Service Level Agreement, Training, or Subscription. -
ProductTypeCode: string
Read Only:
true
Maximum Length:30
The code indicating the type of the product. The accepted values are COVERAGE, GOODS, INCLUDED_WARRANTY, INSTALLATION, ONE_TIME_SERVICE, PREVENTIVE_MAINTENANCE, SERVICE_LEVEL_AGREEMENT, SOFTWARE_MAINTENANCE, SUBSCRIPTION, and TRAINING. -
ReplenishToOrder: string
Read Only:
true
Maximum Length:1
The final assembly work order which is created based on sales order details. -
ReplenishToOrderFlag: boolean
Read Only:
true
Indicates if the final assembly work order is to be created based on sales order details. -
Returnable: string
Read Only:
true
Maximum Length:1
Indicates whether we should allow the customers to return the item. -
ReturnableFlag: boolean
Read Only:
true
Indicates whether to allow customers to return an item. -
SerialNumberControlCode: number
Read Only:
true
The number assigned to each unit of an item and used to track the item. -
ServiceDuration: number
Read Only:
true
The number indicating the service duration. -
ServiceDurationPeriodCode: string
Read Only:
true
Maximum Length:10
The number indicating the service duration period. -
ServiceDurationTypeCode: string
Read Only:
true
Maximum Length:3
The type of duration applicable for a service item. -
ServiceStartDelay: number
Read Only:
true
The attribute specifying the delay in starting a service after a milestone. -
ServiceStartTypeCode: string
Read Only:
true
Maximum Length:3
The type of service start rule which should be used for a service item. -
ServReqEnabledCode: string
Read Only:
true
Maximum Length:30
Indicates whether the product is eligible for service. -
ShippableItem: string
Read Only:
true
Maximum Length:1
Indicates whether to ship an item to a customer. -
ShippableItemFlag: boolean
Read Only:
true
Indicates whether to ship an item to a customer. -
StartAutoSerialNumber: string
Read Only:
true
Maximum Length:80
The starting number for all serial numbers for this item. -
TemplateItem: string
Read Only:
true
Maximum Length:1
Indicates whether it???s a template. The value will be always Y. -
TemplateItemFlag: boolean
Read Only:
true
Indicates whether it???s a template. The value will be always true. -
TemplateName: string
Read Only:
true
Maximum Length:255
The name of the product template. -
UnitHeight: number
Read Only:
true
The height of the item. -
UnitLength: number
Read Only:
true
The length of the item. -
UnitVolume: number
Read Only:
true
The volume of one unit of item. -
UnitWeight: number
Read Only:
true
The weight of one unit of item. -
UnitWidth: number
Read Only:
true
The width of the item. -
VehicleItem: string
Read Only:
true
Maximum Length:1
Indicates whether vehicles are used for shipping the items. -
VehicleItemFlag: boolean
Read Only:
true
Indicates whether vehicles are used for shipping the items. -
VolumeUOMCode: string
Read Only:
true
Maximum Length:3
The volume unit of measure. -
WeightUOMCode: string
Read Only:
true
Maximum Length:3
The weight unit of measure. -
WIPSupplyType: integer
(int64)
Read Only:
true
The supply type for components.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- AtpLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DEGP_ORDATPCHECKVS_TYPE
The lookups resource is used to view standard lookup codes. - finder: