Create an asset
post
/fscmRestApi/resources/11.13.18.05/installedBaseAssets
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Title:
Asset End Date
Date when the asset becomes inactive. For maintenance assets, the asset active end date must be a future date. For customer assets, the asset active end date must be a past date and not earlier than the customer active start date. When the asset end date is populated, the other asset attributes cannot be updated. -
Address1: string
Title:
Address 1
First line of the address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Address2: string
Title:
Address 2
Second line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Address3: string
Title:
Address 3
Third line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Address4: string
Title:
Address 4
Fourth line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
assetDFF: array
Flexfields for Assets
Title:
Flexfields for Assets
The Flexfields for Assets resource manages the descriptive flexfields that contain additional details about the assets. -
AssetId: integer
(int64)
Title:
Asset ID
Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only. -
AssetNumber(required): string
Title:
Asset Number
Maximum Length:80
Value that uniquely identifies the asset. This attribute is optional. If you do not provide a value, the application uses the asset identifier. -
assetQualifications: array
Asset Qualifications
Title:
Asset Qualifications
The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add,update and view the qualifications recorded for an asset. -
BOMExplosionFlag: boolean
Title:
Show logical assets
Contains one of the following values: true or false. If true, then 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. If false, then do not create child assets from the primary bill of material. The default value is false. -
charges: array
Charges
Title:
Charges
The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal. -
City: string
Title:
City
City of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
CompetitorAssetFlag: boolean
Title:
Competitor asset
Maximum Length:1
Contains one of the following values: true or false. If true, then the asset represents a competitor asset. if false, then the asset does not represents a competitor asset. The default value is false. -
ContactId: integer
(int64)
Title:
Contact ID
Value that uniquely identifies the asset contact. You must provide either the contact identifier or the contact number or the contact name to associate a contact to the asset. This attribute is optional and updatable. The contact identifier corresponds to the party identifier in the customer data model where the asset contact is defined as person-type party. -
ContactName: string
Title:
Contact
Maximum Length:255
Name of the contact person of the asset. This attribute is same as the party name in the customer data model where the party type is PERSON. The contact name is the concatenation of first name, middle name, last name, and the suffix. The contact name is not unique. You can use contact identifier, contact number, or contact name to create or update the asset contact. -
ContactNumber: string
Title:
Phone
Maximum Length:255
Number that uniquely identifies the contact person of the asset. This attribute is same as the party number in the customer data model where the party type is PERSON. For enterprise assets, the contact person would be the employee identified with usage as HR Employee. For customer assets, the contact person would be a contact with usage as customer contact. You can use contact identifier, contact number, or contact name to create or update the asset contact. -
Country: string
Title:
Country
Country of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
County: string
Title:
County
County of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
CurrentLocationContextCode(required): string
Title:
Location Type
Maximum Length:80
Abbreviation that uniquely identifies the location context where the asset currently resides. A list of accepted values is defined in the lookup type ORA_CSE_CURRENT_LOC_CONTEXT. This attribute is required to create the asset. -
CurrentLocationId: integer
(int64)
Title:
Location ID
Value that uniquely identifies the location where the asset currently resides. You can provide the value for this attribute when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION or ORA_INTERNAL_LOCATION. -
CustomerAccountId: integer
(int64)
Title:
Bill-to Account Number
Value that uniquely identifies the customer account to which the asset is billed. -
CustomerAccountNumber: string
Title:
Customer Account
Maximum Length:255
Number that uniquely identifies the customer account to which the asset is billed. This attribute is read-only. -
CustomerAccountSiteId: integer
(int64)
Title:
Customer Account Site ID
Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. -
CustomerAccountSiteNumber: string
Title:
Account Site
Maximum Length:255
Number that identifies the site of the customer account for the asset. This attribute is read-only. -
CustomerAccountSiteUseCode: string
Title:
Customer Account Site Use Code
Maximum Length:255
Abbreviation that identifies the usage of the customer account site for the asset. This attribute is read-only. -
CustomerAccountSiteUseId: integer
(int64)
Title:
Customer Account Site Use ID
Value that uniquely identifies the usage of the customer account site for the asset. This attribute must be part of the customer account site. -
CustomerAssetEndDate: string
(date-time)
Title:
Customer Asset End Date
Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. -
CustomerAssetStartDate: string
(date-time)
Title:
Customer Asset Start Date
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)
Title:
Bill-to Customer
Value that uniquely identifies the customer party that the application bills for the asset. This attribute is read-only. -
CustomerBillingPartySiteId: integer
(int64)
Title:
Bill-to Site Number
Value that uniquely identifies the billing party site for the customer. This attribute is read-only. -
CustomerId: integer
(int64)
Title:
Customer ID
Value that uniquely identifies the customer party who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber. -
CustomerName: string
Title:
Customer
Name of the customer who currently owns or uses the asset. This attribute is read-only. -
CustomerNumber: string
Title:
Customer Number
Number that uniquely identifies the customer who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber. -
CustomerPartyType: string
Title:
Customer Party Type
Maximum Length:30
Value that identifies the party type of the customer of the asset.The Customer can be of either Organization party or Person party. -
CustomerSiteId: integer
(int64)
Title:
Customer Site ID
Value that uniquely identifies the customer site where the asset currently resides. You can provide this attribute when the value for CurrentLocationContextCode is ORA_CUSTOMER. -
CustomerSiteNumber: string
Title:
Customer Site Number
Maximum Length:255
Default Value:CustomerSiteNumberNU
Value that uniquely identifies the customer site where the asset currently resides. This attribute is read-only. -
CustomerSitePartyId: integer
(int64)
Title:
Customer Site Party ID
Value that uniquely identifies the customer site party where the asset is located. -
CustomerSitePartyNumber: string
Title:
Customer Site Party Number
Maximum Length:255
Number that uniquely identifies the customer site party where the asset is located. This attribute is read-only. -
Description: string
Title:
Asset Description
Maximum Length:240
Description of an asset. You can use this attribute to describe the asset features, characteristics, and so on. -
DfltWoSubTypeCode: string
Title:
Default Maintenance Work Order Subtype
Maximum Length:30
Abbreviation that uniquely identifies the work order sub type. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. The application uses this attribute to set the work order subtype when it creates a work order for the asset. -
DfltWoTypeCode: string
Title:
Default Maintenance Work Order Type
Maximum Length:30
Abbreviation that uniquely identifies the work order type. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The application uses this attribute to set the work order type when it creates a work order for the asset. -
fixedAssetAssociations: array
Fixed Asset Associations
Title:
Fixed Asset Associations
The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones. -
InServiceDate: string
(date)
Title:
Date in Service
Date and time when the organization put the asset in service. The in-service date must occur after the installed date. -
InstalledDate: string
(date)
Title:
Installed 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. -
IotEnabledFlag: boolean
Title:
IoT Enabled
Maximum Length:1
Contains one of the following values: true or false. If true, then synchronize the asset with the application that controls the lot. If false, then do not synchronize. The default value is true. The response payload translates Y to true and N to false. -
ItemId(required): integer
(int64)
Title:
Item ID
Value that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredFlag is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle. -
ItemNumber: string
Title:
Item
Number that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredFlag is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle. -
ItemRequiredFlag: boolean
Title:
Item Required
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then the item is required to create an asset. If false, then the item is not required to create an asset. The default value is false. -
ItemRevision: string
Title:
Item Revision
Maximum Length:18
Number that identifies the item revision that the asset references. -
LocationOrganizationCode: string
Title:
Location Organization Code
Maximum Length:255
Abbreviation that uniquely identifies the organization where the asset currently resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER. -
LocationOrganizationId: integer
(int64)
Title:
Location Organization ID
Value that uniquely identifies the organization where the asset currently resides. You can provide the location organization if the value of CurrentLocationContextCode is ORA_WORK CENTER. -
LotNumber: string
Title:
Lot Number
Maximum Length:80
Number that uniquely identifying the lot that that the asset references to control the item in inventory. This attribute is applicable when the item is lot controlled. If the lot number does not exist in the inventory, then the application creates a lot in the inventory application. -
MaintainableFlag(required): boolean
Title:
Allow maintenance programs
Maximum Length:1
Contains one of the following values: true or false. If true, then enable the asset for a maintenance activity such as a maintenance program or maintenance work order. If false, then do not enable. The default value is true for maintainable items. -
ManageAssetPrivilege: string
Title:
Manage Asset Privilege
Contains one of the following values. C: Customer asset responsibility. M : Enterprise asset responsibility. MC: Super user responsibility. -
meters: array
Meters
Title:
Meters
The Meters resource gets the details of the meters associated with the assets. -
NewWoAllowedFlag: boolean
Title:
Allow work orders
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the application to create a work order for the asset. If false, then do not allow. The default value is true for maintainable items. -
notes: array
Notes
Title:
Notes
The Notes resource manages the asset notes that provide additional details about the asset. You can add, edit and delete the notes. -
OperatingOrganizationCode: string
Title:
Operating Organization
Abbreviation that uniquely identifies the organization that creates or operates the asset. You need the organization code to create an enterprise asset for a customer asset. If the organization is not provided, the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode. -
OperatingOrganizationId(required): integer
(int64)
Title:
Operating Organization ID
Value that uniquely identifies the organization that creates or operates the asset. You need the organization identifier to create an enterprise asset for a customer asset. If the organization is not provided the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode. -
ParentAssetId: integer
Title:
Parent Asset ID
Value that uniquely identifies the parent asset number to which the imported asset needs to be added. -
partsListComponents: array
Parts
Title:
Parts
The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components. -
PostalCode: string
Title:
Postal Code
Abbreviation that identifies the postal area where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Province: string
Title:
Province
Province where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
PurchaseDate: string
(date)
Title:
Customer Purchase 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(required): number
Title:
Quantity
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)
Title:
Registration Date
Date and time when the customer registered the asset. -
relationships: array
Relationships
Title:
Relationships
The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure. -
ReturnOrderFulfillLineId: integer
(int64)
Value that unique identify the Return Order Fulfill Line Identifier. This Attribute is read-only and it is a system generated number when return sales order is created.
-
ReturnOrderId: integer
(int64)
Value the unique identify the Return Order Identifier. This Attribute is read-only and it is a system generated number when return sales order is created.
-
ReturnOrderLineId: integer
(int64)
Value that unique identify the Return Order Line Identifier. This attribute is read-only and it is a system generated number when return sales order is created.
-
ReturnOrderNumber: string
Maximum Length:
255
Reference the unique identifier the Number of the Return Sales Order Number. This attribute is read-only and it is a system generated number when return sales order is created. -
ReturnSourceOrderNumber: string
Maximum Length:
255
Reference the unique identifier the Number of the Return Source Sales Order Number. This is a read-only and it is a system generated number when return sales order is created. -
SalesOrderId: integer
(int64)
Title:
Sales Order ID
Value that uniquely identifies the sales order that is used to order the asset. -
SalesOrderLineId: integer
(int64)
Title:
Sales Order Line ID
Value that uniquely identifies the line of the sales order that is used to order the asset. -
SalesOrderLineNumber: string
Title:
Sales Order Line Number
Maximum Length:120
Number that uniquely identifies the line of the sales order that is used to order the asset. -
SalesOrderNumber: string
Title:
Sales Order Number
Maximum Length:120
Number that identifies the sales order that is used to order the asset. -
SalesOrderSourceSystem: string
Title:
Sales Order Source System
Maximum Length:30
Name of the source application where the sales order originated. If SalesOrderSourceSystemType is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of the source application that is not an Oracle Fusion application. If SalesOrderSourceSystemType is ORA_INTERNAL, then SalesOrderSourceSystem identifies the Oracle Fusion application. -
SalesOrderSourceSystemType: string
Title:
Sales Order Source System Type
Maximum Length:30
Description of the type of source application. This attribute is read-only. -
SecondaryQuantity: number
Title:
Secondary Quantity
Secondary quantity of product that the asset references. If item is not defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity is not required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Number that uniquely identifies the serial that the asset references. This attribute is used when item is serial controlled. If the serial number does not exist in the inventory, then the application creates a serial in the inventory application. -
ShipmentDate: string
(date-time)
Title:
Shipment Date
Date when the asset is shipped to the customer. This attribute is optional. If you do not provide a value, the application uses the application date. -
SoldByBusinessUnitId: integer
(int64)
Title:
Selling Business Unit ID
Value that uniquely identifies the business unit that sold the asset. This attribute is optional. -
SoldByBusinessUnitName: string
Title:
Selling Business Unit
Maximum Length:255
Name of the business unit that sold the asset. This attribute is read-only. -
SplitFromAssetId: integer
(int64)
Title:
Split from Asset ID
Value that uniquely identifies the split from asset reference. For non-serial assets, when assets are split during partial return, the new asset created with the remaining quantity will have this split from asset reference. -
State: string
Title:
State
State where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
StructureActionCode: string
Title:
Structure Action Code
Abbreviation that uniquely identifies the import action to be performed on the asset relationship. Valid values are ORA_ADD or ORA_REMOVE. ORA_ADD: Add the imported asset to a parent asset. ORA_REMOVE: Remove the asset from its parent asset. A list of accepted values is defined in the lookup type ORA_CSE_ASSET_IMP_CONF_ACTION. -
UOMCode(required): string
Title:
UOM
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure for the asset quantity. It must use the same unit of measure that the item uses as the primary unit of measure. If this attribute is empty, then the application sets the value to the item primary unit of measure. -
UpdateContractFlag: boolean
Title:
Update Contract
Contains one of the following values: true or false. If true, then the application interfaces the asset change to the enterprise contract application. If false, then the asset change is not interfaced to enterprise contract application. The default value is true. This attribute is used when you import the asset and the contract through enterprise contract. Set this attribute to false only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context. -
WorkCenterCode: string
Title:
Work Center Code
Maximum Length:255
Abbreviation that identifies the work center where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER. -
WorkCenterId: integer
(int64)
Title:
Work Center ID
Value that uniquely identifies the work center where the asset currently resides. You can provide the work center when the value of CurrentLocationContextCode is ORA_WORK CENTER.
Nested Schema : Flexfields for Assets
Type:
array
Title:
Flexfields for Assets
The Flexfields for Assets resource manages the descriptive flexfields that contain additional details about the assets.
Show Source
Nested Schema : Asset Qualifications
Type:
array
Title:
Asset Qualifications
The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add,update and view the qualifications recorded for an asset.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.
Show Source
Nested Schema : Fixed Asset Associations
Type:
array
Title:
Fixed Asset Associations
The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.
Show Source
Nested Schema : Meters
Type:
array
Title:
Meters
The Meters resource gets the details of the meters associated with the assets.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Notes resource manages the asset notes that provide additional details about the asset. You can add, edit and delete the notes.
Show Source
Nested Schema : Parts
Type:
array
Title:
Parts
The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for the asset. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for 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.
Nested Schema : schema
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies an asset. This attribute is read-only.
-
AssetQualificationId: integer
(int64)
Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
-
InspectionPlanId: integer
(int64)
Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
-
NextQualificationDate: string
(date-time)
Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.
-
QualificationRequirementCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement. -
QualificationRequirementId: integer
(int64)
Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
-
QualificationRequirementName: string
Maximum Length:
255
Name of the qualification requirement. This is unique and required attribute to create an asset qualification. -
QualifiedDate: string
(date-time)
Date when the asset qualification is created. This date can be set to a required value during creation. Once created the value can't be updated. The defauilt value is system date.
Nested Schema : schema
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: true or false. If true, then the charge component represents the aggregated value of the rollup charge. If false, then the charge component does not represent this value. The default value is false. -
ChargeDefinitionCode: string
Maximum Length:
30
Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the asset charge. -
ChargesRollupFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the pricing charge is a rollup charge. If false, then the pricing charge is not a rollup charge. The default value is false. -
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. -
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. -
PriceElementCode: string
Maximum Length:
30
Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the asset charge. -
PriceElementUsageCode: string
Maximum Length:
30
Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. -
PricePeriodicityCode: string
Maximum Length:
30
Abbreviation that identifies the recurring timeframe that the application uses to price the charge such as month or year. -
PrimaryFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the charge is a primary charge. If false, then the charge is not a primary charge. The default value is false. -
TaxIncludedFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the asset price includes taxes. If false, then the asset price does not include taxes. The default value is false. -
UnitPrice: number
Unit price of the asset. This is the current price of the asset or price that the organization used when it sold the asset.
Nested Schema : schema
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Date and time when the association between installed base and fixed asset becomes inactive.
-
ActiveStartDate: string
(date-time)
Date and time when the association between installed base and fixed asset becomes active.
-
AutoTerminationFlag: string
Maximum Length:
1
Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association is not inactivated automatically. This attribute value is set conditionally during the updation of the asset. -
FixedAssetId: integer
(int64)
Value that uniquely identifies the fixed asset.
-
FixedAssetNumber: string
Title:
Fixed Asset Number
Maximum Length:255
Number that uniquely identifies the fixed asset. -
TerminationReasonCode: string
Maximum Length:
30
Contains a value when the autoTerminationFlag is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.
Nested Schema : installedBaseAssets-notes-item-post-request
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the customer contact who created the note. This attribute is read-only. This attribute is not currently used. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the user who created the note. The application automatically sets this value during creation. This attribute is read-only. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency of the party who created the note. This attribute is read-only. This attribute is not currently used. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used. -
NoteNumber: string
Maximum Length:
30
Number that identifies the application used to generate the note. This attribute is automatically defaulted during creation. This attribute is read-only. -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note. This attribute is optional, which can be entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Actual text of the note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that uniquely identifies the type of note. The application automatically sets this value during creation. This attribute is read-only. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent note. The application assigns a value to this attribute during creation. This attribute is read-only. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Name of the source object that created the note. The application automatically sets this value to CSE_ASSET during creation. This attribute is read-only. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the source object for the note. The application automatically sets this value to Asset identifier during creation. This attribute is read-only. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that uniquely identifies the visibility to other users of the note. Valid values include INTERNAL, EXTERNAL and PRIVATE. If set to PRIVATE, then only the user who created the note can view, edit, or delete the note. This attribute is read-only.
Nested Schema : schema
Type:
Show Source
object
-
ComponentQuantity: number
Title:
Quantity
Quantity of each part list component for the asset. -
ItemId: integer
(int64)
Value that uniquely identifies the item that is part of the part list for the asset. Asset item cannot be part of the part list for the same asset.
-
ItemNumber: string
Maximum Length:
255
Number that uniquely identifies the item that is part of the part list for the asset. An asset item cannot be part of the part list for the same asset. -
ItemOrganizationId: integer
(int64)
Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.
-
ListComponentId: integer
(int64)
Value that uniquely identifies the parts list item that the asset references.
-
SecondaryQuantity: number
Title:
Secondary Quantity
Secondary quantity of product that the asset references. If item is not defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity is not required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.
Nested Schema : schema
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.
-
AssetNumber: string
Maximum Length:
255
Number that uniquely identifies the child asset in the structure. This attribute is read-only. -
RelationshipId: integer
(int64)
Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : installedBaseAssets-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Title:
Asset End Date
Date when the asset becomes inactive. For maintenance assets, the asset active end date must be a future date. For customer assets, the asset active end date must be a past date and not earlier than the customer active start date. When the asset end date is populated, the other asset attributes cannot be updated. -
Address1: string
Title:
Address 1
First line of the address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Address2: string
Title:
Address 2
Second line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Address3: string
Title:
Address 3
Third line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Address4: string
Title:
Address 4
Fourth line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
assetDFF: array
Flexfields for Assets
Title:
Flexfields for Assets
The Flexfields for Assets resource manages the descriptive flexfields that contain additional details about the assets. -
AssetId: integer
(int64)
Title:
Asset ID
Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only. -
AssetNumber: string
Title:
Asset Number
Maximum Length:80
Value that uniquely identifies the asset. This attribute is optional. If you do not provide a value, the application uses the asset identifier. -
assetQualifications: array
Asset Qualifications
Title:
Asset Qualifications
The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add,update and view the qualifications recorded for an asset. -
BOMExplosionFlag: boolean
Title:
Show logical assets
Contains one of the following values: true or false. If true, then 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. If false, then do not create child assets from the primary bill of material. The default value is false. -
charges: array
Charges
Title:
Charges
The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal. -
City: string
Title:
City
City of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
CompetitorAssetFlag: boolean
Title:
Competitor asset
Maximum Length:1
Contains one of the following values: true or false. If true, then the asset represents a competitor asset. if false, then the asset does not represents a competitor asset. The default value is false. -
ContactId: integer
(int64)
Title:
Contact ID
Value that uniquely identifies the asset contact. You must provide either the contact identifier or the contact number or the contact name to associate a contact to the asset. This attribute is optional and updatable. The contact identifier corresponds to the party identifier in the customer data model where the asset contact is defined as person-type party. -
ContactName: string
Title:
Contact
Maximum Length:255
Name of the contact person of the asset. This attribute is same as the party name in the customer data model where the party type is PERSON. The contact name is the concatenation of first name, middle name, last name, and the suffix. The contact name is not unique. You can use contact identifier, contact number, or contact name to create or update the asset contact. -
ContactNumber: string
Title:
Phone
Maximum Length:255
Number that uniquely identifies the contact person of the asset. This attribute is same as the party number in the customer data model where the party type is PERSON. For enterprise assets, the contact person would be the employee identified with usage as HR Employee. For customer assets, the contact person would be a contact with usage as customer contact. You can use contact identifier, contact number, or contact name to create or update the asset contact. -
Country: string
Title:
Country
Country of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
County: string
Title:
County
County of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
CurrentLocationContext: string
Title:
Location Type
Read Only:true
Maximum Length:80
Description of the location context where the asset currently resides. This attribute is read-only. -
CurrentLocationContextCode: string
Title:
Location Type
Maximum Length:80
Abbreviation that uniquely identifies the location context where the asset currently resides. A list of accepted values is defined in the lookup type ORA_CSE_CURRENT_LOC_CONTEXT. This attribute is required to create the asset. -
CurrentLocationId: integer
(int64)
Title:
Location ID
Value that uniquely identifies the location where the asset currently resides. You can provide the value for this attribute when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION or ORA_INTERNAL_LOCATION. -
CurrentLocationName: string
Title:
Location Name
Read Only:true
Maximum Length:255
Name of the location where the asset currently resides. This attribute is read-only. -
CurrentLocationNameFormatted: string
Read Only:
true
Maximum Length:255
Formatted location name where the asset currently resides. This attribute is read-only. -
CustomerAccountId: integer
(int64)
Title:
Bill-to Account Number
Value that uniquely identifies the customer account to which the asset is billed. -
CustomerAccountName: string
Title:
Customer Account Name
Read Only:true
Maximum Length:240
Name of the customer account to which the asset is billed. This attribute is read-only. -
CustomerAccountNumber: string
Title:
Customer Account
Maximum Length:255
Number that uniquely identifies the customer account to which the asset is billed. This attribute is read-only. -
CustomerAccountSiteId: integer
(int64)
Title:
Customer Account Site ID
Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. -
CustomerAccountSiteName: string
Title:
Customer Account Site Name
Read Only:true
Maximum Length:240
Site name of the customer account for the asset. This attribute is read-only. -
CustomerAccountSiteNumber: string
Title:
Account Site
Maximum Length:255
Number that identifies the site of the customer account for the asset. This attribute is read-only. -
CustomerAccountSiteUseCode: string
Title:
Customer Account Site Use Code
Maximum Length:255
Abbreviation that identifies the usage of the customer account site for the asset. This attribute is read-only. -
CustomerAccountSiteUseId: integer
(int64)
Title:
Customer Account Site Use ID
Value that uniquely identifies the usage of the customer account site for the asset. This attribute must be part of the customer account site. -
CustomerAssetEndDate: string
(date-time)
Title:
Customer Asset End Date
Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. -
CustomerAssetStartDate: string
(date-time)
Title:
Customer Asset Start Date
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)
Title:
Bill-to Customer
Value that uniquely identifies the customer party that the application bills for the asset. This attribute is read-only. -
CustomerBillingPartySiteId: integer
(int64)
Title:
Bill-to Site Number
Value that uniquely identifies the billing party site for the customer. This attribute is read-only. -
CustomerId: integer
(int64)
Title:
Customer ID
Value that uniquely identifies the customer party who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber. -
CustomerName: string
Title:
Customer
Name of the customer who currently owns or uses the asset. This attribute is read-only. -
CustomerNumber: string
Title:
Customer Number
Number that uniquely identifies the customer who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber. -
CustomerPartyType: string
Title:
Customer Party Type
Maximum Length:30
Value that identifies the party type of the customer of the asset.The Customer can be of either Organization party or Person party. -
CustomerSiteId: integer
(int64)
Title:
Customer Site ID
Value that uniquely identifies the customer site where the asset currently resides. You can provide this attribute when the value for CurrentLocationContextCode is ORA_CUSTOMER. -
CustomerSiteName: string
Title:
Customer Site
Read Only:true
Maximum Length:240
Name of the customer site where the asset currently resides. This attribute is read-only. -
CustomerSiteNumber: string
Title:
Customer Site Number
Maximum Length:255
Default Value:CustomerSiteNumberNU
Value that uniquely identifies the customer site where the asset currently resides. This attribute is read-only. -
CustomerSitePartyId: integer
(int64)
Title:
Customer Site Party ID
Value that uniquely identifies the customer site party where the asset is located. -
CustomerSitePartyName: string
Title:
Customer Site Party Name
Read Only:true
Maximum Length:360
Name of the customer party site where the asset is located. This attribute is read-only. -
CustomerSitePartyNumber: string
Title:
Customer Site Party Number
Maximum Length:255
Number that uniquely identifies the customer site party where the asset is located. This attribute is read-only. -
Description: string
Title:
Asset Description
Maximum Length:240
Description of an asset. You can use this attribute to describe the asset features, characteristics, and so on. -
DfltWoSubTypeCode: string
Title:
Default Maintenance Work Order Subtype
Maximum Length:30
Abbreviation that uniquely identifies the work order sub type. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. The application uses this attribute to set the work order subtype when it creates a work order for the asset. -
DfltWoTypeCode: string
Title:
Default Maintenance Work Order Type
Maximum Length:30
Abbreviation that uniquely identifies the work order type. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The application uses this attribute to set the work order type when it creates a work order for the asset. -
fixedAssetAssociations: array
Fixed Asset Associations
Title:
Fixed Asset Associations
The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones. -
FulfillLineId: integer
(int64)
Title:
Line
Read Only:true
Value that uniquely identifies the distributed order orchestration fulfillment line reference. This attribute is read-only. -
InServiceDate: string
(date)
Title:
Date in Service
Date and time when the organization put the asset in service. The in-service date must occur after the installed date. -
InstalledDate: string
(date)
Title:
Installed 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. -
IotEnabledFlag: boolean
Title:
IoT Enabled
Maximum Length:1
Contains one of the following values: true or false. If true, then synchronize the asset with the application that controls the lot. If false, then do not synchronize. The default value is true. The response payload translates Y to true and N to false. -
ItemCustomerSelfServiceFlag: boolean
Title:
Item Enabled for Customer Self-Service
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then the item is enabled for use on the customer self-service application. If false, then the item is not enabled. The default value is false. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item. This attribute is read-only. -
ItemId: integer
(int64)
Title:
Item ID
Value that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredFlag is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle. -
ItemLongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
Long description of the item. This attribute is read-only. -
ItemNumber: string
Title:
Item
Number that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredFlag is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle. -
ItemRequiredFlag: boolean
Title:
Item Required
Maximum Length:1
Default Value:true
Contains one of the following values: true or false. If true, then the item is required to create an asset. If false, then the item is not required to create an asset. The default value is false. -
ItemRevision: string
Title:
Item Revision
Maximum Length:18
Number that identifies the item revision that the asset references. -
ItemServiceRequestEnabledCode: string
Title:
Item Enabled for a Service Request
Read Only:true
Maximum Length:30
Abbreviation that indicates whether a service request can be created for the item. This attribute is read-only. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationOrganizationCode: string
Title:
Location Organization Code
Maximum Length:255
Abbreviation that uniquely identifies the organization where the asset currently resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER. -
LocationOrganizationId: integer
(int64)
Title:
Location Organization ID
Value that uniquely identifies the organization where the asset currently resides. You can provide the location organization if the value of CurrentLocationContextCode is ORA_WORK CENTER. -
LocatorId: integer
(int64)
Title:
Locator ID
Read Only:true
Value that uniquely identifies the locator where the asset resides. This attribute is read-only. -
LocatorName: string
Title:
Locator
Read Only:true
Maximum Length:255
Name of the locator where the asset resides. This attribute is read-only. -
LotNumber: string
Title:
Lot Number
Maximum Length:80
Number that uniquely identifying the lot that that the asset references to control the item in inventory. This attribute is applicable when the item is lot controlled. If the lot number does not exist in the inventory, then the application creates a lot in the inventory application. -
MaintainableFlag: boolean
Title:
Allow maintenance programs
Maximum Length:1
Contains one of the following values: true or false. If true, then enable the asset for a maintenance activity such as a maintenance program or maintenance work order. If false, then do not enable. The default value is true for maintainable items. -
ManageAssetPrivilege: string
Title:
Manage Asset Privilege
Contains one of the following values. C: Customer asset responsibility. M : Enterprise asset responsibility. MC: Super user responsibility. -
meters: array
Meters
Title:
Meters
The Meters resource gets the details of the meters associated with the assets. -
NewWoAllowedFlag: boolean
Title:
Allow work orders
Maximum Length:1
Contains one of the following values: true or false. If true, then allow the application to create a work order for the asset. If false, then do not allow. The default value is true for maintainable items. -
notes: array
Notes
Title:
Notes
The Notes resource manages the asset notes that provide additional details about the asset. You can add, edit and delete the notes. -
OperatingOrganizationCode: string
Title:
Operating Organization
Abbreviation that uniquely identifies the organization that creates or operates the asset. You need the organization code to create an enterprise asset for a customer asset. If the organization is not provided, the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode. -
OperatingOrganizationId: integer
(int64)
Title:
Operating Organization ID
Value that uniquely identifies the organization that creates or operates the asset. You need the organization identifier to create an enterprise asset for a customer asset. If the organization is not provided the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode. -
OperatingOrganizationName: string
Read Only:
true
Maximum Length:255
Name of the organization that creates or operates the asset. This attribute is read-only. -
ParentAssetId: integer
Title:
Parent Asset ID
Value that uniquely identifies the parent asset number to which the imported asset needs to be added. -
partsListComponents: array
Parts
Title:
Parts
The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components. -
PostalCode: string
Title:
Postal Code
Abbreviation that identifies the postal area where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
Province: string
Title:
Province
Province where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
PurchaseDate: string
(date)
Title:
Customer Purchase 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
Title:
Quantity
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)
Title:
Registration Date
Date and time when the customer registered the asset. -
relationships: array
Relationships
Title:
Relationships
The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure. -
ReturnOrderFulfillLineId: integer
(int64)
Value that unique identify the Return Order Fulfill Line Identifier. This Attribute is read-only and it is a system generated number when return sales order is created.
-
ReturnOrderId: integer
(int64)
Value the unique identify the Return Order Identifier. This Attribute is read-only and it is a system generated number when return sales order is created.
-
ReturnOrderLineId: integer
(int64)
Value that unique identify the Return Order Line Identifier. This attribute is read-only and it is a system generated number when return sales order is created.
-
ReturnOrderNumber: string
Maximum Length:
255
Reference the unique identifier the Number of the Return Sales Order Number. This attribute is read-only and it is a system generated number when return sales order is created. -
ReturnSourceOrderNumber: string
Maximum Length:
255
Reference the unique identifier the Number of the Return Source Sales Order Number. This is a read-only and it is a system generated number when return sales order is created. -
SalesOrderId: integer
(int64)
Title:
Sales Order ID
Value that uniquely identifies the sales order that is used to order the asset. -
SalesOrderLineId: integer
(int64)
Title:
Sales Order Line ID
Value that uniquely identifies the line of the sales order that is used to order the asset. -
SalesOrderLineNumber: string
Title:
Sales Order Line Number
Maximum Length:120
Number that uniquely identifies the line of the sales order that is used to order the asset. -
SalesOrderNumber: string
Title:
Sales Order Number
Maximum Length:120
Number that identifies the sales order that is used to order the asset. -
SalesOrderSourceSystem: string
Title:
Sales Order Source System
Maximum Length:30
Name of the source application where the sales order originated. If SalesOrderSourceSystemType is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of the source application that is not an Oracle Fusion application. If SalesOrderSourceSystemType is ORA_INTERNAL, then SalesOrderSourceSystem identifies the Oracle Fusion application. -
SalesOrderSourceSystemType: string
Title:
Sales Order Source System Type
Maximum Length:30
Description of the type of source application. This attribute is read-only. -
SecondaryQuantity: number
Title:
Secondary Quantity
Secondary quantity of product that the asset references. If item is not defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity is not required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Number that uniquely identifies the serial that the asset references. This attribute is used when item is serial controlled. If the serial number does not exist in the inventory, then the application creates a serial in the inventory application. -
ShipmentDate: string
(date-time)
Title:
Shipment Date
Date when the asset is shipped to the customer. This attribute is optional. If you do not provide a value, the application uses the application date. -
SoldByBusinessUnitId: integer
(int64)
Title:
Selling Business Unit ID
Value that uniquely identifies the business unit that sold the asset. This attribute is optional. -
SoldByBusinessUnitName: string
Title:
Selling Business Unit
Maximum Length:255
Name of the business unit that sold the asset. This attribute is read-only. -
SplitFromAssetId: integer
(int64)
Title:
Split from Asset ID
Value that uniquely identifies the split from asset reference. For non-serial assets, when assets are split during partial return, the new asset created with the remaining quantity will have this split from asset reference. -
State: string
Title:
State
State where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION. -
StructureActionCode: string
Title:
Structure Action Code
Abbreviation that uniquely identifies the import action to be performed on the asset relationship. Valid values are ORA_ADD or ORA_REMOVE. ORA_ADD: Add the imported asset to a parent asset. ORA_REMOVE: Remove the asset from its parent asset. A list of accepted values is defined in the lookup type ORA_CSE_ASSET_IMP_CONF_ACTION. -
SubinventoryCode: string
Title:
Subinventory
Read Only:true
Maximum Length:30
Abbreviation that identifies the subinventory where the asset resides. This attribute is read-only. -
UOMCode: string
Title:
UOM
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure for the asset quantity. It must use the same unit of measure that the item uses as the primary unit of measure. If this attribute is empty, then the application sets the value to the item primary unit of measure. -
UpdateContractFlag: boolean
Title:
Update Contract
Contains one of the following values: true or false. If true, then the application interfaces the asset change to the enterprise contract application. If false, then the asset change is not interfaced to enterprise contract application. The default value is true. This attribute is used when you import the asset and the contract through enterprise contract. Set this attribute to false only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context. -
WorkCenterCode: string
Title:
Work Center Code
Maximum Length:255
Abbreviation that identifies the work center where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER. -
WorkCenterId: integer
(int64)
Title:
Work Center ID
Value that uniquely identifies the work center where the asset currently resides. You can provide the work center when the value of CurrentLocationContextCode is ORA_WORK CENTER. -
WorkCenterName: string
Title:
Work Center
Read Only:true
Maximum Length:80
Name of the work center where the asset currently resides. This attribute is read-only.
Nested Schema : Flexfields for Assets
Type:
array
Title:
Flexfields for Assets
The Flexfields for Assets resource manages the descriptive flexfields that contain additional details about the assets.
Show Source
Nested Schema : Asset Qualifications
Type:
array
Title:
Asset Qualifications
The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add,update and view the qualifications recorded for an asset.
Show Source
Nested Schema : Charges
Type:
array
Title:
Charges
The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.
Show Source
Nested Schema : Fixed Asset Associations
Type:
array
Title:
Fixed Asset Associations
The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Meters
Type:
array
Title:
Meters
The Meters resource gets the details of the meters associated with the assets.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The Notes resource manages the asset notes that provide additional details about the asset. You can add, edit and delete the notes.
Show Source
Nested Schema : Parts
Type:
array
Title:
Parts
The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.
Show Source
Nested Schema : installedBaseAssets-assetDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for the asset. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for 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
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 : installedBaseAssets-assetQualifications-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies an asset. This attribute is read-only.
-
AssetNumber: string
Title:
Number
Read Only:true
Maximum Length:80
Number that uniquely identifies an asset. This attribute is read-only. -
AssetQualificationId: integer
(int64)
Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the qualification requirement The application automatically sets this value during creation.This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
true
Date when the qualification requirment is created. The application automatically sets this value during creation.This attribute is read-only. -
InspectionPlanId: integer
(int64)
Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation.This attribute is read-only. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextQualificationDate: string
(date-time)
Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.
-
QualificationRequirementCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement. -
QualificationRequirementId: integer
(int64)
Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
-
QualificationRequirementName: string
Maximum Length:
255
Name of the qualification requirement. This is unique and required attribute to create an asset qualification. -
QualifiedBy: string
Read Only:
true
Maximum Length:64
User who created the asset qualification. The application automatically sets this value during creation.This attribute is read-only. -
QualifiedDate: string
(date-time)
Date when the asset qualification is created. This date can be set to a required value during creation. Once created the value can't be updated. The defauilt value is system date.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-charges-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: true or false. If true, then the charge component represents the aggregated value of the rollup charge. If false, then the charge component does not represent this value. The default value is false. -
ChargeDefinitionCode: string
Maximum Length:
30
Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the asset charge. -
ChargesRollupFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the pricing charge is a rollup charge. If false, then the pricing charge is not a rollup charge. The default value is false. -
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. -
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. -
PriceElementCode: string
Maximum Length:
30
Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the asset charge. -
PriceElementUsageCode: string
Maximum Length:
30
Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. -
PricePeriodicityCode: string
Maximum Length:
30
Abbreviation that identifies the recurring timeframe that the application uses to price the charge such as month or year. -
PrimaryFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the charge is a primary charge. If false, then the charge is not a primary charge. The default value is false. -
TaxIncludedFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the asset price includes taxes. If false, then the asset price does not include taxes. The default value is false. -
UnitPrice: number
Unit price of the asset. This is the current price of the asset or price that the organization used when it sold the asset.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-fixedAssetAssociations-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Date and time when the association between installed base and fixed asset becomes inactive.
-
ActiveStartDate: string
(date-time)
Date and time when the association between installed base and fixed asset becomes active.
-
AutoTerminationFlag: string
Maximum Length:
1
Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association is not inactivated automatically. This attribute value is set conditionally during the updation of the asset. -
FixedAssetId: integer
(int64)
Value that uniquely identifies the fixed asset.
-
FixedAssetNumber: string
Title:
Fixed Asset Number
Maximum Length:255
Number that uniquely identifies the fixed asset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TerminationReasonCode: string
Maximum Length:
30
Contains a value when the autoTerminationFlag is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-meters-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 of 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 of ActiveEndDate. -
AllowInMaintProgramFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter cannot be used for scheduling a maintenance program. The default value is false. -
DailyUtilizationRate: number
Read Only:
true
Expected average daily total of readings that are to be entered for a meter. -
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. This attribute provides a brief user-defined text providing information on the template characteristics. -
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 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. A list of accepted values is defined in the lookup type ORA_CSE_METER_TYPE_CODE. -
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. Valid values include ORA_ASSET or ORA_CONTRACT. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE. -
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. This attribute specifies the direction 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. A list of accepted values is defined in the lookup type ORA_CSE_DIRECTION. -
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. This attribute 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. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE. -
RecordAtWoComplCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the option that is used to control the meter reading entry at work order completion. -
ResetAllowedFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. 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 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 this attribute as the reset value when it records the meter reading history. If you set ResetAllowedFlag to true, then you must specify a value for ResetValue. Each meter that the application creates for the asset references this attribute. This attribute 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: true or false. 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 specify values for 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. The default value is false. -
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 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 of 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 RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value of 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. This attribute provides a context that you can use to define, record, or view meter history. A list of accepted values is defined in the lookup type ORA_CSE_UOM_CODE. -
UtilizationRateComputedAt: number
Read Only:
true
Number of readings in history for which meter readings will be used to calculate a daily utilization rate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-notes-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
Value that uniquely identifies the customer contact who created the note. This attribute is read-only. This attribute is not currently used. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the note for the asset. The application automatically sets this value during creation.This attribute is read-only. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the note is created. The application automatically sets this value during creation.This attribute is read-only. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
Value that uniquely identifies the user who created the note. The application automatically sets this value during creation. This attribute is read-only. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
Type of currency of the party who created the note. This attribute is read-only. This attribute is not currently used. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
Abbreviation that identifies the currency of the party who created the note. This attribute is read-only. This attribute is not currently used. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Contains one of the following values: true or false. If true, then the user has access to delete the record. If false, then the user does not have access to delete the record. This attribute value is set during the creation of the note and the value is derived based on whether the user has permission to delete the note or not. This attribute is read-only. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
Email address of the user who created the note for the asset. The application automatically sets this value to the e-mail address of the logged in user during creation. This attribute is read-only. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
Address of the user who created the note for the asset. The application automatically sets this value to the formatted address of the logged in user during creation. This attribute is read-only. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
Phone number of the user who created the note for the asset. The application automatically sets this value to the formatted phone number of the logged in user during creation. This attribute is read-only. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the user most recently updated the note. The application automatically sets this value during creation.This attribute is read-only. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the note for the asset. The application assigns a value to this attribute during creation. This attribute is read-only. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Login that the user used when updating the note for the asset. The application assigns a value to this attribute during creation. This attribute is read-only. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
Value that uniquely identifies the note for the asset. The application sets this value during note creation. This attribute is read-only. -
NoteNumber: string
Maximum Length:
30
Number that identifies the application used to generate the note. This attribute is automatically defaulted during creation. This attribute is read-only. -
NoteTitle: string
Title:
Title
Maximum Length:500
Title of the note. This attribute is optional, which can be entered by the user. -
NoteTxt: string
(byte)
Title:
Note
Actual text of the note. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
Abbreviation that uniquely identifies the type of note. The application automatically sets this value during creation. This attribute is read-only. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
Value that uniquely identifies the parent note. The application assigns a value to this attribute during creation. This attribute is read-only. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Value that uniquely identifies the user who created the note. The application automatically sets this value during creation.This attribute is read-only. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
Name of the user who created the note for the asset. The application automatically sets this value during creation. This attribute is read-only. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
Name of the source object that created the note. The application automatically sets this value to CSE_ASSET during creation. This attribute is read-only. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
Value that uniquely identifies the source object for the note. The application automatically sets this value to Asset identifier during creation. This attribute is read-only. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Contains one of the following values: true or false. If true, then user has access to update the record. If false, then user does not have access to update the record. This attribute value is set during the creation of the note and the value is derived based on whether the user has permission to update the note or not. This attribute is read-only. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
Abbreviation that uniquely identifies the visibility to other users of the note. Valid values include INTERNAL, EXTERNAL and PRIVATE. If set to PRIVATE, then only the user who created the note can view, edit, or delete the note. This attribute is read-only.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-partsListComponents-item-response
Type:
Show Source
object
-
AssetId: integer
Read Only:
true
Value that uniquely identifies the asset for each component. You can create only one relationship between each value that is specified by ListComponentId and AssetId. -
ComponentQuantity: number
Title:
Quantity
Quantity of each part list component for the asset. -
ItemId: integer
(int64)
Value that uniquely identifies the item that is part of the part list for the asset. Asset item cannot be part of the part list for the same asset.
-
ItemNumber: string
Maximum Length:
255
Number that uniquely identifies the item that is part of the part list for the asset. An asset item cannot be part of the part list for the same asset. -
ItemOrganizationId: integer
(int64)
Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListComponentId: integer
(int64)
Value that uniquely identifies the parts list item that the asset references.
-
SecondaryQuantity: number
Title:
Secondary Quantity
Secondary quantity of product that the asset references. If item is not defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity is not required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure is not required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : installedBaseAssets-relationships-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.
-
AssetNumber: string
Maximum Length:
255
Number that uniquely identifies the child asset in the structure. This attribute is read-only. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that uniquely identifies the item that the child asset references. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LogicalObjectId: integer
(int64)
Read Only:
true
Value that uniquely identifies the superlative relationship (As Sold Structure) to present the sales view of the customer assets. This attribute is read-only. -
RelationshipId: integer
(int64)
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. You must provide the serial number in combination with the item to identify the asset.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- assetDFF
-
Parameters:
- AssetId:
$request.path.AssetId
The Flexfields for Assets resource manages the descriptive flexfields that contain additional details about the assets. - AssetId:
- assetQualifications
-
Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetQualificationsParameters:
- AssetId:
$request.path.AssetId
The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add,update and view the qualifications recorded for an asset. - AssetId:
- charges
-
Parameters:
- AssetId:
$request.path.AssetId
The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal. - AssetId:
- fixedAssetAssociations
-
Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/fixedAssetAssociationsParameters:
- AssetId:
$request.path.AssetId
The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones. - AssetId:
- meters
-
Parameters:
- AssetId:
$request.path.AssetId
The Meters resource gets the details of the meters associated with the assets. - AssetId:
- notes
-
Parameters:
- AssetId:
$request.path.AssetId
The Notes resource manages the asset notes that provide additional details about the asset. You can add, edit and delete the notes. - AssetId:
- partsListComponents
-
Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/partsListComponentsParameters:
- AssetId:
$request.path.AssetId
The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components. - AssetId:
- relationships
-
Parameters:
- AssetId:
$request.path.AssetId
The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure. - AssetId:
Examples
This example describes how to create one enterprise asset. For an example on how to create a customer asset, see the Create Customer Assets and Charges use case.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/installedBaseAssets"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "AssetNumber": "F/0554-3133", "Description": "Professional combined Bench Grinder Fervi", "Quantity": 1, "OperatingOrganizationCode": "MNTALM", "ItemNumber": "F/0554", "SerialNumber" : "SR554-341", "CurrentLocationContextCode":"ORA_WORK_CENTER", "LocationOrganizationId": 300100113363336, "WorkCenterId": 300100117993736, "MaintainableFlag": true, "NewWoAllowedFlag": true, "DfltWoTypeCode": "CORRECTIVE", "DfltWoSubTypeCode": "ORA_SAFETY", }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ActiveEndDate" : null, "AssetId" : 300100176686291, "AssetNumber" : "F/0554-3133", "BOMExplosionFlag" : null, "CompetitorAssetFlag" : false, "CurrentLocationContextCode" : "ORA_WORK_CENTER", "CurrentLocationId" : null, "CustomerAccountId" : null, "CustomerAccountSiteId" : null, "CustomerAccountSiteUseId" : null, "CustomerAssetEndDate" : null, "CustomerAssetStartDate" : null, "CustomerBillingPartyId" : null, "CustomerBillingPartySiteId" : null, "CustomerId" : null, "CustomerSiteId" : null, "CustomerSitePartyId" : null, "Description" : "Professional combined Bench Grinder Fervi", "DfltWoSubTypeCode" : "ORA_SAFETY", "DfltWoTypeCode" : "CORRECTIVE", "InServiceDate" : null, "InstalledDate" : null, "LocatorId" : null, "IotEnabledFlag" : null, "ItemId" : 300100114215977, "OperatingOrganizationId" : 300100113363336, "ItemRevision" : null, "LocationOrganizationId" : 300100113363336, "LotNumber" : null, "MaintainableFlag" : true, "NewWoAllowedFlag" : true, "PurchaseDate" : null, "Quantity" : 1, "RegistrationDate" : null, "SalesOrderId" : null, "SalesOrderLineId" : null, "SalesOrderLineNumber" : null, "SalesOrderNumber" : null, "SalesOrderSourceSystem" : null, "SalesOrderSourceSystemType" : null, "SerialNumber" : "SR554-3133", "ShipmentDate" : null, "SoldByBusinessUnitId" : null, "SubinventoryCode" : null, "UOMCode" : "Ea", "UpdateContractFlag" : null, "WorkCenterId" : 300100117993736, "WorkCenterName" : "Mechanical Maintenance", "LocationOrganizationCode" : null, "SoldByBusinessUnitName" : null, "CustomerSitePartyName" : null, "CustomerSitePartyNumber" : null, "CustomerSiteName" : null, "CustomerSiteNumber" : null, "CustomerAccountName" : null, "CustomerAccountNumber" : null, "CustomerAccountSiteName" : null, "CustomerAccountSiteNumber" : null, "CustomerAccountSiteUseCode" : null, "OperatingOrganizationCode" : null, "ManageAssetPrivilege" : "M", "ItemNumber" : null, "CustomerName" : null, "CustomerNumber" : null, "ItemRequiredFlag" : false, "Country" : null, "City" : null, "PostalCode" : null, "State" : null, "Address1" : null, "Address2" : null, "Address3" : null, "Address4" : null, "Province" : null, "County" : null, "OperatingOrganizationName" : null, "CurrentLocationContext" : null, "WorkCenterCode" : "Mechanical Maintenance", "LocatorName" : null, "CurrentLocationName" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291", "name" : "installedBaseAssets", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291", "name" : "installedBaseAssets", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/charges", "name" : "charges", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/meters", "name" : "meters", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/assetDFF", "name" : "assetDFF", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/partsListComponents", "name" : "partsListComponents", "kind" : "collection" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/installedBaseAssets/300100176686291/child/relationships", "name" : "relationships", "kind" : "collection" } ] }