Get one asset
get
/fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}
Request
Path Parameters
-
AssetId(required): integer(int64)
Value that uniquely identifies the asset. The application creates this value from the asset number when it creates the asset. This attribute is read-only.
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 : customerAssets-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.
-
AssetCharge: array
Charges
Title:
Charges
The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract. -
AssetId: integer
(int64)
Read Only:
true
Value that uniquely identifies the asset. The application creates this value from the asset number when it creates the asset. This attribute is read-only. -
AssetMeter: array
Meters
Title:
Meters
The Asset Meters resource gets the meters associated with the maintenance assets. -
AssetNumber: string
Title:
Number
Maximum Length:80
Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset. -
AssetStructure: array
Relationships
Title:
Relationships
The Customer Asset Relationships resource manages customer asset relationships. -
BOMExplosionFlag: boolean
Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.
-
CurrentLocationContext: string
Maximum Length:
80
Default Value:ORA_CUSTOMER
Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute. You cannot use location context ORA_INVENTORY in the context of customer asset updates. If you can maintain the asset, and if the asset is work in process, then you cannot use location context ORA_WORK_CENTER in the context of customer asset updates. This attribute is required to create the asset. You can update this attribute. -
CurrentLocationId: integer
(int64)
Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN.
-
CurrentLocationName: string
Title:
Meaning
Read Only:true
Maximum Length:80
Name of the location where the asset currently resides. The application determines this value from the attribute that identifies the customer site. This attribute is read-only. -
CustomerAccountId: integer
(int64)
Value that uniquely identifies the customer account. The application bills this account for the asset or service. This attribute is optional and you can update it.
-
CustomerAccountName: string
Title:
Account Description
Read Only:true
Maximum Length:240
Name of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only. -
CustomerAccountNumber: string
Title:
Account Number
Read Only:true
Maximum Length:30
Number that uniquely identifies the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only. -
CustomerAccountSiteId: integer
(int64)
Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.
-
CustomerAccountSiteName: string
Title:
Site Name
Read Only:true
Maximum Length:240
Site name of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only. -
CustomerAccountSiteNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
Site number of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only. -
CustomerAccountSiteUseCode: string
Title:
Purpose
Read Only:true
Maximum Length:30
Abbreviation that identifies the usage of the customer account site for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only. -
CustomerAccountSiteUseId: integer
(int64)
Value that uniquely identifies usage for the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.
-
CustomerAssetDFF: array
Flexfields
Title:
Flexfields
The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets. -
CustomerAssetEndDate: string
(date-time)
Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. This attribute is optional to create the asset. You can update this attribute.
-
CustomerAssetStartDate: string
(date-time)
Date and time when the customer asset becomes active. The application uses the shipment date to determine the value for this attribute. This attribute is read-only.
-
CustomerBillingPartyId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer party that the application bills for the asset. The application uses account details to determine this value. This attribute is read-only. -
CustomerBillingPartySiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the billing party site for the customer. The application uses account details to determine this value. This attribute is read-only. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer party who currently owns or uses the asset. This attribute is required. You can update this attribute.
-
CustomerName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the customer who currently owns or uses the asset. The application uses the customer to determine the value for this attribute. This attribute is read-only. -
CustomerNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Number that uniquely identifies the customer who currently owns or uses the asset. The application uses the customer to determine the value for this attribute. This attribute is read-only. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
-
CustomerSiteName: string
Title:
Site Name
Read Only:true
Maximum Length:240
Name of the customer site where the asset currently resides. The application uses the customer site to determine the value for this attribute. This attribute is read-only. -
CustomerSiteNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
Number that uniquely identifies the customer site where the asset currently resides. The application uses the customer site to determine the value for this attribute. This attribute is read-only. -
CustomerSitePartyId: integer
(int64)
Value that uniquely identifies the customer site party where the asset is located. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
-
CustomerSitePartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the customer party site where the asset is located. The application uses the customer party site to determine the value for this attribute. This attribute is read-only. -
CustomerSitePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Number that uniquely identifies the customer site party where the asset is located. The application uses the customer party site to determine the value for this attribute. This attribute is read-only. -
Description: string
Title:
Description
Maximum Length:240
Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute. -
DfltWoSubType: string
Maximum Length:
30
Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute. -
DfltWoType: string
Maximum Length:
30
Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute. -
InServiceDate: string
(date)
Date and time when the organization put the asset in service. The in-service date must occur after the installed date. This attribute is optional to define the asset. You can update this attribute.
-
InstalledDate: string
(date)
Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date. This attribute is optional to define the asset. You can update this attribute.
-
IotEnabledFlag: boolean
Title:
Enable IoT
Maximum Length:1
Default Value:true
Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false. -
ItemId: integer
(int64)
Title:
Item
Value that uniquely identifies the item that the asset references. Asset tracking for the item must use customer asset or lifecycle. This attribute is required. You cannot update this attribute. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that uniquely identifies the item that the asset references. The application determines this value from the attribute that identifies the item. This attribute is read-only. -
ItemOrganizationId: integer
(int64)
Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
-
ItemRevision: string
Maximum Length:
18
Number that identifies the item revision that the asset references. This attribute is optional. You can update this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationOrganizationId: integer
(int64)
Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the location organization is required.
-
LotNumber: string
Title:
Lot
Maximum Length:80
Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute. -
MaintainableFlag: boolean
Maximum Length:
1
Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable. -
NewWoAllowedFlag: boolean
Maximum Length:
1
Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that uniquely identifies the organization that creates or uses the asset. The application determines this value from the organization Id. This attribute is read-only. -
PurchaseDate: string
(date)
Date and time when the customer purchased the asset. If you provide the registration date, then you must provide the purchase date. The purchased date must occur before the registration date.
-
Quantity: number
Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.
-
RegistrationDate: string
(date)
Date and time when the customer registered the asset. This attribute is optional to define the asset. You can update this attribute.
-
SalesOrderId: integer
(int64)
Value that uniquely identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.
-
SalesOrderLineId: integer
(int64)
Value that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.
-
SalesOrderLineNumber: string
Title:
Line
Maximum Length:120
Number that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute. -
SalesOrderNumber: string
Title:
Sales Order
Maximum Length:120
Number that identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute. -
SalesOrderSourceSystem: string
Title:
Source
Maximum Length:30
Name of the source system where the sales order originated. If SalesOrderSourceSystemType attribute is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of a source system that resides outside of Oracle Fusion. If SalesOrderSourceSystemType attribute is ORA_INTERNAL, then SalesOrderSourceSystem identifies an Oracle Fusion Application. This attribute is optional. You can update this attribute. -
SalesOrderSourceSystemType: string
Maximum Length:
30
Type of source system that originates the sales order. You can use one of the following values: ORA_EXTERNAL or ORA_INTERNAL. The ORA_CSE_SOURCE_SYSTEM_TYPE lookup defines these values. This attribute is optional. You can update this attribute. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage. -
ShipmentDate: string
(date-time)
Date when the application ships the asset to the customer. This date must occur before the current date. This attribute is required. You can update this attribute.
-
SoldByBusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit that sold the asset. This attribute is optional. You can update this attribute.
-
SoldByBusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the business unit that sold the asset. The application uses the sold-by business unit to determine the value for this attribute. This attribute is read-only. -
SourceTransactionDate: string
(date-time)
Date and time when the source system created the transaction for the asset change. This attribute is optional to create the asset. If this attribute does not contain a value, then the application uses the system date.
-
UpdateContractFlag: boolean
Contains one of the following values. Y: the application interfaces the asset change to Enterprise Contract. N: not interfaced to Enterprise Contract. The default value is Y. The intended usage for this attribute applies when you import the asset and the contract through Enterprise Contract. Set this attribute to N only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context.
-
WorkCenterId: integer
(int64)
Title:
Work Center
Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.
Nested Schema : Charges
Type:
array
Title:
Charges
The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.
Show Source
Nested Schema : Meters
Type:
array
Title:
Meters
The Asset Meters resource gets the meters associated with the maintenance assets.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The Customer Asset Relationships resource manages customer asset relationships.
Show Source
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : customerAssets-AssetCharge-item-response
Type:
Show Source
object
-
AssetChargeId: integer
(int64)
Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
-
AssetId: integer
(int64)
Value that uniquely identifies the asset that the application charges. The application uses the asset that the charge references to determine the value for this attribute. This attribute is read-only.
-
ChargeComponentsRollupFlag: boolean
Maximum Length:
1
Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N. -
ChargeDefinitionCode: string
Maximum Length:
30
Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute. -
ChargesRollupFlag: boolean
Maximum Length:
1
Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PricedQuantityUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute. -
PriceElementCode: string
Maximum Length:
30
Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute. -
PriceElementUsageCode: string
Maximum Length:
30
Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute. -
PricePeriodicityCode: string
Maximum Length:
30
Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute. -
PrimaryFlag: boolean
Maximum Length:
1
Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N. -
TaxIncludedFlag: boolean
Maximum Length:
1
Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N. -
UnitPrice: number
Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.
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.
Nested Schema : customerAssets-AssetMeter-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Read Only:
true
Date when the application can no longer use the meter template for the asset. The application sets this value to the default, active end date for the meter that it created for the asset. The date must be equal to or greater than the system date, and it must be greater than the value in attribute ActiveStartDate. -
ActiveStartDate: string
(date-time)
Read Only:
true
Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value in attribute ActiveEndDate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the meter template. This value must use uppercase letters and it can be alphanumeric. Each meter that the application creates for the asset references this value. -
MeterDefinitionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only. -
MeterDescription: string
Read Only:
true
Maximum Length:240
Description of the meter template. Each meter that the application creates and displays in the contextual action area for the meter that references this value. -
MeterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the asset meter. The application uses this value and the value that identifies the asset to identify the asset meter, and then record a new meter reading. As an alternative, the application can use the meter code and the asset number to identify the asset meter and record the new reading. -
MeterName: string
Read Only:
true
Maximum Length:120
Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of attributes MeterName and MeterCode provide a unique value that identifies the meter template. -
MeterObjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business object that the application creates for this meter. This value represents the asset identifier that the application gets from the asset that references the meter. -
MeterTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for MeterCode are continuous, similar to an odometer, or a gauge, similar to a thermometer. You can use the ORA_CSE_METER_TYPE_CODE lookup to examine the values that this attribute uses. -
MeterUsageCode: string
Read Only:
true
Maximum Length:30
Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line. Contains one of the following values: ORA_ASSET or ORA_CONTRACT. You can use the ORA_CSE_METER_USAGE_CODE lookup to examine the values that this attribute uses. -
ReadingDirection: string
Read Only:
true
Maximum Length:30
Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. ReadingDirection specifies to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. You can use the ORA_CSE_DIRECTION lookup to examine the values that this attribute uses. -
ReadingTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. ReadingTypeCode specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. You can use the ORA_CSE_READING_TYPE_CODE lookup to examine the values that this attribute uses. -
ResetAllowedFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then do not allow. If true, then you must define attribute ResetValue. The default value is false. Each meter that the application creates for the asset references this value. You cannot define an indicator for a gauge meter. -
ResetValue: number
Read Only:
true
Reset value for the meter in the meter template. The application uses ResetValue as the reset value when it records the meter reading history. If you set attribute ResetAllowedFlag to true, then you must specify a value for attribute ResetValue. Each meter that the application creates for the asset references ResetValue. ResetValue must contain a value that is greater than zero, and that is equal to the lowest reading value that the physical meter allows for the asset. -
RolloverAllowedFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then do not allow rollover. If true, then you must also specify values for attributes RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedFlag is false. RolloverAllowedFlag is required. Each meter that the application creates for the asset references RolloverAllowedFlag. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording. -
RolloverMaximumValue: number
Read Only:
true
Maximum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If attribute RolloverAllowedFlag is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value in attribute RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset. -
RolloverResetValue: number
Read Only:
true
Minimum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If attribute RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value in RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. UOMCode provides a context that you can use to define, record, or view meter history. You can use the ORA_CSE_UOM_CODE lookup to examine the values that this attribute uses.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : customerAssets-AssetStructure-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
-
AssetNumber: string
Title:
Number
Read Only:true
Maximum Length:80
Number that uniquely identifies the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that uniquely identifies the item that the child asset references. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelationshipId: integer
(int64)
Read Only:
true
Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only. -
SerialNumber: string
Title:
Serial Number
Read Only:true
Maximum Length:80
Serial number of the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : customerAssets-CustomerAssetDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context of the asset. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Display value for the descriptive flexfield of the asset. -
AssetId: integer
(int64)
Value that uniquely identifies the asset. Use this attribute in the descriptive flexfield resource for the asset. This attribute is read-only.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AssetCharge
-
Parameters:
- AssetId:
$request.path.AssetId
The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract. - AssetId:
- AssetMeter
-
Parameters:
- AssetId:
$request.path.AssetId
The Asset Meters resource gets the meters associated with the maintenance assets. - AssetId:
- AssetStructure
-
Parameters:
- AssetId:
$request.path.AssetId
The Customer Asset Relationships resource manages customer asset relationships. - AssetId:
- CustomerAssetDFF
-
Parameters:
- AssetId:
$request.path.AssetId
The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets. - AssetId:
Examples
These examples describe different ways to get one asset.
Get One Asset According to AssetId
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssets?finder=AssetsByAssetId;AssetId=AssetId"
For example, the following command gets asset 300100092619273:
curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssets?finder=AssetsByAssetId;AssetId=300100092619273"
Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "ActiveEndDate": null, "AssetId": 300100092619273, "AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy4", "CurrentLocationContext": "ORA_CUSTOMER", "CurrentLocationId": 1, "CustomerAccountId": null, "CustomerAccountSiteId": null, "CustomerAccountSiteUseId": null, "CustomerBillingPartyId": null, "CustomerBillingPartySiteId": null, "CustomerId": 1000, "CustomerSiteId": null, "CustomerSitePartyId": null, "Description": "SN-REST-ASSET-1-NO-CHARGES", "ItemId": 300100092597422, "ItemOrganizationId": 207, "ItemRevision": null, "LotNumber": null, "ObjectVersionNumber": 1, "Quantity": 1, "SalesOrderId": null, "SalesOrderLineId": null, "SalesOrderLineNumber": null, "SalesOrderNumber": null, "SalesOrderSourceSystem": null, "SalesOrderSourceSystemType": null, "SerialNumber": null, "ShipmentDate": null, "SoldByBusinessUnitId": null, "UOMCode": "Ea", "ItemNumber": "SN-REST-ASSET-ITEM--041816", "OrganizationCode": null, "CurrentLocation": "Customer", "ItemNumberTransient": null, "OrganizationCodeTransient": null, "CustomerNumberTransient": null, "UpdateContractFlag": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000", "name": "customerAssets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000", "name": "customerAssets", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000/lov/OrgOrganizationDefinitionsVA", "name": "OrgOrganizationDefinitionsVA", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000/child/AssetCharge", "name": "AssetCharge", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/customerAssets", "name": "customerAssets", "kind": "collection" } ] }
Get One Asset According to Organization, Item, and Serial Number
This example gets one asset according to organization, item, and serial number:
curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssets?finder=AssetsByItemSerialOrg;ItemId=ItemId&ItemOrganiztionId=ItemOrganizationId"
The following command gets the asset for item 300100092597422 in organization 207:
curl -u username:password "https://servername/fscmRestApi/resources/version/customerAssets?finder=AssetsByItemSerialOrg;ItemId=300100092597422&ItemOrganiztionId=207"
Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "ActiveEndDate": null, "AssetId": 300100092619256, "AssetNumber": "SN-REST-ASSET-1-NO-041816", "CurrentLocationContext": "ORA_CUSTOMER", "CurrentLocationId": 1, "CustomerAccountId": null, "CustomerAccountSiteId": null, "CustomerAccountSiteUseId": null, "CustomerBillingPartyId": null, "CustomerBillingPartySiteId": null, "CustomerId": 1000, "CustomerSiteId": null, "CustomerSitePartyId": null, "Description": "SN-REST-ASSET-1-NO-CHARGES", "ItemId": 300100092597422, "ItemOrganizationId": 207, "ItemRevision": null, "LotNumber": null, "ObjectVersionNumber": 1, "Quantity": 1, "SalesOrderId": null, "SalesOrderLineId": null, "SalesOrderLineNumber": null, "SalesOrderNumber": null, "SalesOrderSourceSystem": null, "SalesOrderSourceSystemType": null, "SerialNumber": null, "ShipmentDate": null, "SoldByBusinessUnitId": null, "UOMCode": "Ea", "ItemNumber": "SN-REST-ASSET-ITEM--041816", "OrganizationCode": null, "CurrentLocation": "Customer", "ItemNumberTransient": null, "OrganizationCodeTransient": null, "CustomerNumberTransient": null, "UpdateContractFlag": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AE9F80000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000", "name": "customerAssets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AE9F80000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000", "name": "customerAssets", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AE9F80000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000/lov/OrgOrganizationDefinitionsVA", "name": "OrgOrganizationDefinitionsVA", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AE9F80000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000/child/AssetCharge", "name": "AssetCharge", "kind": "collection" } ] }, :::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::: { "ActiveEndDate": null, "AssetId": 300100092619273, "AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy4", "CurrentLocationContext": "ORA_CUSTOMER", "CurrentLocationId": 1, "CustomerAccountId": null, "CustomerAccountSiteId": null, "CustomerAccountSiteUseId": null, "CustomerBillingPartyId": null, "CustomerBillingPartySiteId": null, "CustomerId": 1000, "CustomerSiteId": null, "CustomerSitePartyId": null, "Description": "SN-REST-ASSET-1-NO-CHARGES", "ItemId": 300100092597422, "ItemOrganizationId": 207, "ItemRevision": null, "LotNumber": null, "ObjectVersionNumber": 1, "Quantity": 1, "SalesOrderId": null, "SalesOrderLineId": null, "SalesOrderLineNumber": null, "SalesOrderNumber": null, "SalesOrderSourceSystem": null, "SalesOrderSourceSystemType": null, "SerialNumber": null, "ShipmentDate": null, "SoldByBusinessUnitId": null, "UOMCode": "Ea", "ItemNumber": "SN-REST-ASSET-ITEM--041816", "OrganizationCode": null, "CurrentLocation": "Customer", "ItemNumberTransient": null, "OrganizationCodeTransient": null, "CustomerNumberTransient": null, "UpdateContractFlag": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000", "name": "customerAssets", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000", "name": "customerAssets", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000/lov/OrgOrganizationDefinitionsVA", "name": "OrgOrganizationDefinitionsVA", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA090000000EACED00057708000110F07F6A94AE0000000EACED0005770800000000000000CFFFFFFFFF0000001B4F52415F4353455F43555252454E545F4C4F435F434F4E544558540000000C4F52415F435553544F4D45520000000EACED0005770800000000000000000000000EACED000577080000000000000000/child/AssetCharge", "name": "AssetCharge", "kind": "collection" } ] } ], "count": 6, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/customerAssets", "name": "customerAssets", "kind": "collection" } ] }