Jump to

• Request
• Response
• Examples

Create one asset

post

/fscmRestApi/resources/11.13.18.05/customerAssets

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.
• AssetCharge: array Charges
  Title: Charges

  The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.
• AssetMeter: array Meters
  Title: Meters

  The Asset Meters resource gets the meters associated with the maintenance assets.
• AssetNumber(required): string
  Title: Number

  Maximum Length: 80

  Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.
• AssetStructure: array Relationships
  Title: Relationships

  The Customer Asset Relationships resource manages customer asset relationships.
• BOMExplosionFlag: boolean
  Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.
• CurrentLocationContext: string
  Maximum Length: 80

  Default Value: ORA_CUSTOMER

  Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute. You cannot use location context ORA_INVENTORY in the context of customer asset updates. If you can maintain the asset, and if the asset is work in process, then you cannot use location context ORA_WORK_CENTER in the context of customer asset updates. This attribute is required to create the asset. You can update this attribute.
• CurrentLocationId: integer (int64)
  Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN.
• CustomerAccountId: integer (int64)
  Value that uniquely identifies the customer account. The application bills this account for the asset or service. This attribute is optional and you can update it.
• CustomerAccountSiteId: integer (int64)
  Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.
• CustomerAccountSiteUseId: integer (int64)
  Value that uniquely identifies usage for the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.
• CustomerAssetDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.
• CustomerAssetEndDate: string (date-time)
  Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. This attribute is optional to create the asset. You can update this attribute.
• CustomerAssetStartDate: string (date-time)
  Date and time when the customer asset becomes active. The application uses the shipment date to determine the value for this attribute. This attribute is read-only.
• CustomerId: integer (int64)
  Value that uniquely identifies the customer party who currently owns or uses the asset. This attribute is required. You can update this attribute.
• CustomerSiteId: integer (int64)
  Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
• CustomerSitePartyId: integer (int64)
  Value that uniquely identifies the customer site party where the asset is located. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute.
• DfltWoSubType: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.
• DfltWoType: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.
• InServiceDate: string (date)
  Date and time when the organization put the asset in service. The in-service date must occur after the installed date. This attribute is optional to define the asset. You can update this attribute.
• InstalledDate: string (date)
  Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date. This attribute is optional to define the asset. You can update this attribute.
• IotEnabledFlag: boolean
  Title: Enable IoT

  Maximum Length: 1

  Default Value: true

  Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false.
• ItemId(required): integer (int64)
  Title: Item

  Value that uniquely identifies the item that the asset references. Asset tracking for the item must use customer asset or lifecycle. This attribute is required. You cannot update this attribute.
• ItemOrganizationId(required): integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
• ItemRevision: string
  Maximum Length: 18

  Number that identifies the item revision that the asset references. This attribute is optional. You can update this attribute.
• LocationOrganizationId: integer (int64)
  Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the location organization is required.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

  Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute.
• MaintainableFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable.
• NewWoAllowedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.
• PurchaseDate: string (date)
  Date and time when the customer purchased the asset. If you provide the registration date, then you must provide the purchase date. The purchased date must occur before the registration date.
• Quantity(required): number
  Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.
• RegistrationDate: string (date)
  Date and time when the customer registered the asset. This attribute is optional to define the asset. You can update this attribute.
• SalesOrderId: integer (int64)
  Value that uniquely identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderLineId: integer (int64)
  Value that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderLineNumber: string
  Title: Line

  Maximum Length: 120

  Number that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderNumber: string
  Title: Sales Order

  Maximum Length: 120

  Number that identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderSourceSystem: string
  Title: Source

  Maximum Length: 30

  Name of the source system where the sales order originated. If SalesOrderSourceSystemType attribute is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of a source system that resides outside of Oracle Fusion. If SalesOrderSourceSystemType attribute is ORA_INTERNAL, then SalesOrderSourceSystem identifies an Oracle Fusion Application. This attribute is optional. You can update this attribute.
• SalesOrderSourceSystemType: string
  Maximum Length: 30

  Type of source system that originates the sales order. You can use one of the following values: ORA_EXTERNAL or ORA_INTERNAL. The ORA_CSE_SOURCE_SYSTEM_TYPE lookup defines these values. This attribute is optional. You can update this attribute.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.
• ShipmentDate: string (date-time)
  Date when the application ships the asset to the customer. This date must occur before the current date. This attribute is required. You can update this attribute.
• SoldByBusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit that sold the asset. This attribute is optional. You can update this attribute.
• SourceTransactionDate: string (date-time)
  Date and time when the source system created the transaction for the asset change. This attribute is optional to create the asset. If this attribute does not contain a value, then the application uses the system date.
• UpdateContractFlag: boolean
  Contains one of the following values. Y: the application interfaces the asset change to Enterprise Contract. N: not interfaced to Enterprise Contract. The default value is Y. The intended usage for this attribute applies when you import the asset and the contract through Enterprise Contract. Set this attribute to N only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context.
• WorkCenterId: integer (int64)
  Title: Work Center

  Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.

{
    "required":[
        "AssetNumber",
        "ItemId",
        "ItemOrganizationId",
        "Quantity"
    ],
    "type":"object",
    "properties":{
        "IotEnabledFlag":{
            "title":"Enable IoT",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false.",
            "nullable":true,
            "default":true
        },
        "CurrentLocationContext":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute. You cannot use location context ORA_INVENTORY in the context of customer asset updates. If you can maintain the asset, and if the asset is work in process, then you cannot use location context ORA_WORK_CENTER in the context of customer asset updates. This attribute is required to create the asset. You can update this attribute.",
            "nullable":false,
            "default":"ORA_CUSTOMER",
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RegistrationDate":{
            "type":"string",
            "description":"Date and time when the customer registered the asset. This attribute is optional to define the asset. You can update this attribute.",
            "format":"date",
            "nullable":true
        },
        "CustomerAccountSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AssetStructure":{
            "title":"Relationships",
            "type":"array",
            "description":"The Customer Asset Relationships resource manages customer asset relationships.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-AssetStructure-item-post-request"
            }
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the asset references. Asset tracking for the item must use customer asset or lifecycle. This attribute is required. You cannot update this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.",
            "nullable":false
        },
        "SoldByBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that sold the asset. This attribute is optional. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DfltWoSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CurrentLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InstalledDate":{
            "type":"string",
            "description":"Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date. This attribute is optional to define the asset. You can update this attribute.",
            "format":"date",
            "nullable":true
        },
        "AssetCharge":{
            "title":"Charges",
            "type":"array",
            "description":"The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-AssetCharge-item-post-request"
            }
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer account. The application bills this account for the asset or service. This attribute is optional and you can update it.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderLineNumber":{
            "title":"Line",
            "maxLength":120,
            "type":"string",
            "description":"Number that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "UpdateContractFlag":{
            "type":"boolean",
            "description":"Contains one of the following values. Y: the application interfaces the asset change to Enterprise Contract. N: not interfaced to Enterprise Contract. The default value is Y. The intended usage for this attribute applies when you import the asset and the contract through Enterprise Contract. Set this attribute to N only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionDate":{
            "type":"string",
            "description":"Date and time when the source system created the transaction for the asset change. This attribute is optional to create the asset. If this attribute does not contain a value, then the application uses the system date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerAssetDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-CustomerAssetDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the item revision that the asset references. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "CustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies usage for the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "InServiceDate":{
            "type":"string",
            "description":"Date and time when the organization put the asset in service. The in-service date must occur after the installed date. This attribute is optional to define the asset. You can update this attribute.",
            "format":"date",
            "nullable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the location organization is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAssetStartDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "BOMExplosionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerSitePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site party where the asset is located. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NewWoAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "AssetMeter":{
            "title":"Meters",
            "type":"array",
            "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-AssetMeter-item-post-request"
            }
        },
        "Quantity":{
            "type":"number",
            "description":"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.",
            "nullable":false
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party who currently owns or uses the asset. This attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderSourceSystemType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source system that originates the sales order. You can use one of the following values: ORA_EXTERNAL or ORA_INTERNAL. The ORA_CSE_SOURCE_SYSTEM_TYPE lookup  defines these values. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "DfltWoType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true
        },
        "SalesOrderNumber":{
            "title":"Sales Order",
            "maxLength":120,
            "type":"string",
            "description":"Number that identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "SalesOrderSourceSystem":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Name of the source system where the sales order originated. If SalesOrderSourceSystemType attribute is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of a source system that resides outside of Oracle Fusion. If SalesOrderSourceSystemType attribute is ORA_INTERNAL, then SalesOrderSourceSystem identifies an Oracle Fusion Application. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.",
            "nullable":true
        },
        "ShipmentDate":{
            "type":"string",
            "description":"Date when the application ships the asset to the customer. This date must occur before the current date. This attribute is required. You can update this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "CustomerAssetEndDate":{
            "type":"string",
            "description":"Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. This attribute is optional to create the asset. You can update this attribute.",
            "format":"date-time",
            "nullable":true
        },
        "MaintainableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "PurchaseDate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.

Show Source

• Array of: object customerAssets-AssetCharge-item-post-request

{
    "title":"Charges",
    "type":"array",
    "description":"The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-AssetCharge-item-post-request"
    }
}

Nested Schema : Meters

Type: array

Title: Meters

The Asset Meters resource gets the meters associated with the maintenance assets.

Show Source

• Array of: object customerAssets-AssetMeter-item-post-request

{
    "title":"Meters",
    "type":"array",
    "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-AssetMeter-item-post-request"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The Customer Asset Relationships resource manages customer asset relationships.

Show Source

• Array of: object customerAssets-AssetStructure-item-post-request

{
    "title":"Relationships",
    "type":"array",
    "description":"The Customer Asset Relationships resource manages customer asset relationships.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-AssetStructure-item-post-request"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.

Show Source

• Array of: object schema

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-CustomerAssetDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : customerAssets-AssetCharge-item-post-request

Type: object

Show Source

• AssetChargeId: integer (int64)
  Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
• AssetId: integer (int64)
  Value that uniquely identifies the asset that the application charges. The application uses the asset that the charge references to determine the value for this attribute. This attribute is read-only.
• ChargeComponentsRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute.
• ChargesRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PricedQuantityUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PriceElementCode: string
  Maximum Length: 30

  Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PriceElementUsageCode: string
  Maximum Length: 30

  Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute.
• PrimaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N.
• TaxIncludedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N.
• UnitPrice: number
  Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.

{
    "type":"object",
    "properties":{
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":true
        },
        "AssetChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N.",
            "nullable":false
        },
        "PricedQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":false
        },
        "TaxIncludedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N.",
            "nullable":false
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute.",
            "nullable":false
        },
        "ChargesRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N.",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":false
        },
        "PriceElementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":false
        },
        "PriceElementUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":true
        },
        "ChargeComponentsRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N.",
            "nullable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : customerAssets-AssetMeter-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : customerAssets-AssetStructure-item-post-request

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context of the asset.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Display value for the descriptive flexfield of the asset.
• AssetId: integer (int64)
  Value that uniquely identifies the asset. Use this attribute in the descriptive flexfield resource for the asset. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. Use this attribute in the descriptive flexfield resource for the asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Display value for the descriptive flexfield of the asset.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context of the asset.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : customerAssets-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.
• AssetCharge: array Charges
  Title: Charges

  The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.
• AssetId: integer (int64)
  Read Only: true

  Value that uniquely identifies the asset. The application creates this value from the asset number when it creates the asset. This attribute is read-only.
• AssetMeter: array Meters
  Title: Meters

  The Asset Meters resource gets the meters associated with the maintenance assets.
• AssetNumber: string
  Title: Number

  Maximum Length: 80

  Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.
• AssetStructure: array Relationships
  Title: Relationships

  The Customer Asset Relationships resource manages customer asset relationships.
• BOMExplosionFlag: boolean
  Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.
• CurrentLocationContext: string
  Maximum Length: 80

  Default Value: ORA_CUSTOMER

  Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute. You cannot use location context ORA_INVENTORY in the context of customer asset updates. If you can maintain the asset, and if the asset is work in process, then you cannot use location context ORA_WORK_CENTER in the context of customer asset updates. This attribute is required to create the asset. You can update this attribute.
• CurrentLocationId: integer (int64)
  Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN.
• CurrentLocationName: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the location where the asset currently resides. The application determines this value from the attribute that identifies the customer site. This attribute is read-only.
• CustomerAccountId: integer (int64)
  Value that uniquely identifies the customer account. The application bills this account for the asset or service. This attribute is optional and you can update it.
• CustomerAccountName: string
  Title: Account Description

  Read Only: true

  Maximum Length: 240

  Name of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.
• CustomerAccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.
• CustomerAccountSiteId: integer (int64)
  Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.
• CustomerAccountSiteName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  Site name of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.
• CustomerAccountSiteNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  Site number of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.
• CustomerAccountSiteUseCode: string
  Title: Purpose

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the usage of the customer account site for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.
• CustomerAccountSiteUseId: integer (int64)
  Value that uniquely identifies usage for the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.
• CustomerAssetDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.
• CustomerAssetEndDate: string (date-time)
  Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. This attribute is optional to create the asset. You can update this attribute.
• CustomerAssetStartDate: string (date-time)
  Date and time when the customer asset becomes active. The application uses the shipment date to determine the value for this attribute. This attribute is read-only.
• CustomerBillingPartyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the customer party that the application bills for the asset. The application uses account details to determine this value. This attribute is read-only.
• CustomerBillingPartySiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the billing party site for the customer. The application uses account details to determine this value. This attribute is read-only.
• CustomerId: integer (int64)
  Value that uniquely identifies the customer party who currently owns or uses the asset. This attribute is required. You can update this attribute.
• CustomerName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the customer who currently owns or uses the asset. The application uses the customer to determine the value for this attribute. This attribute is read-only.
• CustomerNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer who currently owns or uses the asset. The application uses the customer to determine the value for this attribute. This attribute is read-only.
• CustomerSiteId: integer (int64)
  Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
• CustomerSiteName: string
  Title: Site Name

  Read Only: true

  Maximum Length: 240

  Name of the customer site where the asset currently resides. The application uses the customer site to determine the value for this attribute. This attribute is read-only.
• CustomerSiteNumber: string
  Title: Site Number

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer site where the asset currently resides. The application uses the customer site to determine the value for this attribute. This attribute is read-only.
• CustomerSitePartyId: integer (int64)
  Value that uniquely identifies the customer site party where the asset is located. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
• CustomerSitePartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the customer party site where the asset is located. The application uses the customer party site to determine the value for this attribute. This attribute is read-only.
• CustomerSitePartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer site party where the asset is located. The application uses the customer party site to determine the value for this attribute. This attribute is read-only.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute.
• DfltWoSubType: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.
• DfltWoType: string
  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.
• InServiceDate: string (date)
  Date and time when the organization put the asset in service. The in-service date must occur after the installed date. This attribute is optional to define the asset. You can update this attribute.
• InstalledDate: string (date)
  Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date. This attribute is optional to define the asset. You can update this attribute.
• IotEnabledFlag: boolean
  Title: Enable IoT

  Maximum Length: 1

  Default Value: true

  Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false.
• ItemId: integer (int64)
  Title: Item

  Value that uniquely identifies the item that the asset references. Asset tracking for the item must use customer asset or lifecycle. This attribute is required. You cannot update this attribute.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item that the asset references. The application determines this value from the attribute that identifies the item. This attribute is read-only.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
• ItemRevision: string
  Maximum Length: 18

  Number that identifies the item revision that the asset references. This attribute is optional. You can update this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationOrganizationId: integer (int64)
  Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the location organization is required.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

  Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute.
• MaintainableFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable.
• NewWoAllowedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the organization that creates or uses the asset. The application determines this value from the organization Id. This attribute is read-only.
• PurchaseDate: string (date)
  Date and time when the customer purchased the asset. If you provide the registration date, then you must provide the purchase date. The purchased date must occur before the registration date.
• Quantity: number
  Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.
• RegistrationDate: string (date)
  Date and time when the customer registered the asset. This attribute is optional to define the asset. You can update this attribute.
• SalesOrderId: integer (int64)
  Value that uniquely identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderLineId: integer (int64)
  Value that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderLineNumber: string
  Title: Line

  Maximum Length: 120

  Number that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderNumber: string
  Title: Sales Order

  Maximum Length: 120

  Number that identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.
• SalesOrderSourceSystem: string
  Title: Source

  Maximum Length: 30

  Name of the source system where the sales order originated. If SalesOrderSourceSystemType attribute is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of a source system that resides outside of Oracle Fusion. If SalesOrderSourceSystemType attribute is ORA_INTERNAL, then SalesOrderSourceSystem identifies an Oracle Fusion Application. This attribute is optional. You can update this attribute.
• SalesOrderSourceSystemType: string
  Maximum Length: 30

  Type of source system that originates the sales order. You can use one of the following values: ORA_EXTERNAL or ORA_INTERNAL. The ORA_CSE_SOURCE_SYSTEM_TYPE lookup defines these values. This attribute is optional. You can update this attribute.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.
• ShipmentDate: string (date-time)
  Date when the application ships the asset to the customer. This date must occur before the current date. This attribute is required. You can update this attribute.
• SoldByBusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit that sold the asset. This attribute is optional. You can update this attribute.
• SoldByBusinessUnitName: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of the business unit that sold the asset. The application uses the sold-by business unit to determine the value for this attribute. This attribute is read-only.
• SourceTransactionDate: string (date-time)
  Date and time when the source system created the transaction for the asset change. This attribute is optional to create the asset. If this attribute does not contain a value, then the application uses the system date.
• UpdateContractFlag: boolean
  Contains one of the following values. Y: the application interfaces the asset change to Enterprise Contract. N: not interfaced to Enterprise Contract. The default value is Y. The intended usage for this attribute applies when you import the asset and the contract through Enterprise Contract. Set this attribute to N only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context.
• WorkCenterId: integer (int64)
  Title: Work Center

  Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.

{
    "type":"object",
    "properties":{
        "IotEnabledFlag":{
            "title":"Enable IoT",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CustomerSitePartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer party site where the asset is located. The application uses the customer party site to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetStructure":{
            "title":"Relationships",
            "type":"array",
            "description":"The Customer Asset Relationships resource manages customer asset relationships.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-AssetStructure-item-response"
            }
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the asset references. Asset tracking for the item must use customer asset or lifecycle. This attribute is required. You cannot update this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "DfltWoSubType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountSiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Site name of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the customer who currently owns or uses the asset. The application uses the customer to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstalledDate":{
            "type":"string",
            "description":"Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date. This attribute is optional to define the asset. You can update this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssetCharge":{
            "title":"Charges",
            "type":"array",
            "description":"The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-AssetCharge-item-response"
            }
        },
        "CustomerAccountSiteNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"Site number of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateContractFlag":{
            "type":"boolean",
            "description":"Contains one of the following values. Y: the application interfaces the asset change to Enterprise Contract. N: not interfaced to Enterprise Contract. The default value is Y. The intended usage for this attribute applies when you import the asset and the contract through Enterprise Contract. Set this attribute to N only if you are certain that the application must handle each contract update separately, or if the update does not apply in the context.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the item revision that the asset references. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountSiteUseCode":{
            "title":"Purpose",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the usage of the customer account site for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the location organization is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAssetStartDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSitePartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the customer site party where the asset is located. The application uses the customer party site to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NewWoAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssetMeter":{
            "title":"Meters",
            "type":"array",
            "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-AssetMeter-item-response"
            }
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party who currently owns or uses the asset. This attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "title":"Site Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the customer site where the asset currently resides. The application uses the customer site to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderSourceSystemType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of source system that originates the sales order. You can use one of the following values: ORA_EXTERNAL or ORA_INTERNAL. The ORA_CSE_SOURCE_SYSTEM_TYPE lookup  defines these values. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DfltWoType":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentLocationName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the location where the asset currently resides. The application determines this value from the attribute that identifies the customer site. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "title":"Sales Order",
            "maxLength":120,
            "type":"string",
            "description":"Number that identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAssetEndDate":{
            "type":"string",
            "description":"Date and time when the customer asset becomes inactive. If this attribute contains a value, then you cannot update other asset attributes. This attribute is optional to create the asset. You can update this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PurchaseDate":{
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. The application creates this value from the asset number when it creates the asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CustomerBillingPartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the billing party site for the customer. The application uses account details to determine this value. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SoldByBusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that sold the asset. The application uses the sold-by business unit to determine the value for this attribute. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentLocationContext":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute. You cannot use location context ORA_INVENTORY in the context of customer asset updates. If you can maintain the asset, and if the asset is work in process, then you cannot use location context ORA_WORK_CENTER in the context of customer asset updates. This attribute is required to create the asset. You can update this attribute.",
            "nullable":false,
            "default":"ORA_CUSTOMER",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RegistrationDate":{
            "type":"string",
            "description":"Date and time when the customer registered the asset. This attribute is optional to define the asset. You can update this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SoldByBusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that sold the asset. This attribute is optional. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerBillingPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer party that the application bills for the asset. The application uses account details to determine this value. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that the asset references. The application determines this value from the attribute that identifies the item. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that ordered the asset. This attribute is optional. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer account. The application bills this account for the asset or service. This attribute is optional and you can update it.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "title":"Line",
            "maxLength":120,
            "type":"string",
            "description":"Number that uniquely identifies the sales order line that ordered the asset. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTransactionDate":{
            "type":"string",
            "description":"Date and time when the source system created the transaction for the asset change. This attribute is optional to create the asset. If this attribute does not contain a value, then the application uses the system date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerAssetDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.",
            "items":{
                "$ref":"#/components/schemas/customerAssets-CustomerAssetDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization that creates or uses the asset. The application determines this value from the organization Id. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer who currently owns or uses the asset. The application uses the customer to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountSiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies usage for the customer account site for the asset. This site must be part of the customer account. This attribute is optional and you can update it.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "InServiceDate":{
            "type":"string",
            "description":"Date and time when the organization put the asset in service. The in-service date must occur after the installed date. This attribute is optional to define the asset. You can update this attribute.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BOMExplosionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerSitePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site party where the asset is located. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerAccountName":{
            "title":"Account Description",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the customer account for the asset. The application uses the account to determine the value for this attribute. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderSourceSystem":{
            "title":"Source",
            "maxLength":30,
            "type":"string",
            "description":"Name of the source system where the sales order originated. If SalesOrderSourceSystemType attribute is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of a source system that resides outside of Oracle Fusion. If SalesOrderSourceSystemType attribute is ORA_INTERNAL, then SalesOrderSourceSystem identifies an Oracle Fusion Application. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer site where the asset currently resides. The application uses the customer site to determine the value for this attribute. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentDate":{
            "type":"string",
            "description":"Date when the application ships the asset to the customer. This date must occur before the current date. This attribute is required. You can update this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "MaintainableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.

Show Source

• Array of: object customerAssets-AssetCharge-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-AssetCharge-item-response"
    }
}

Nested Schema : Meters

Type: array

Title: Meters

The Asset Meters resource gets the meters associated with the maintenance assets.

Show Source

• Array of: object customerAssets-AssetMeter-item-response

{
    "title":"Meters",
    "type":"array",
    "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-AssetMeter-item-response"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The Customer Asset Relationships resource manages customer asset relationships.

Show Source

• Array of: object customerAssets-AssetStructure-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The Customer Asset Relationships resource manages customer asset relationships.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-AssetStructure-item-response"
    }
}

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.

Show Source

• Array of: object customerAssets-CustomerAssetDFF-item-response

{
    "title":"Flexfields",
    "type":"array",
    "description":"The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.",
    "items":{
        "$ref":"#/components/schemas/customerAssets-CustomerAssetDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : customerAssets-AssetCharge-item-response

Type: object

Show Source

• AssetChargeId: integer (int64)
  Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
• AssetId: integer (int64)
  Value that uniquely identifies the asset that the application charges. The application uses the asset that the charge references to determine the value for this attribute. This attribute is read-only.
• ChargeComponentsRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute.
• ChargesRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricedQuantityUOMCode: string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PriceElementCode: string
  Maximum Length: 30

  Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute.
• PriceElementUsageCode: string
  Maximum Length: 30

  Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute.
• PrimaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N.
• TaxIncludedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N.
• UnitPrice: number
  Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.

{
    "type":"object",
    "properties":{
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the recurring timeframe that the application uses to price the charge, such as month or year. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetChargeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the charge is a primary charge. N: the charge is not a primary charge. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "PricedQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the quantity that the application prices. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxIncludedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the asset price includes taxes. N: the asset price does not include taxes. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the charge for asset pricing. You cannot update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargesRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the pricing charge is a rollup charge. N: the pricing charge is not a rollup charge. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency that the pricing charge uses. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PriceElementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the charge for asset pricing. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Unit price of the asset. Current price of the asset or price that the organization used when it sold the asset. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PriceElementUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price. This attribute is optional to define the charge for asset pricing. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeComponentsRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. Y: the charge component represents the aggregated value of the rollup charge. N: the charge component does not represent this value. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : customerAssets-AssetMeter-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Read Only: true

  Date when the application can no longer use the meter template for the asset. The application sets this value to the default, active end date for the meter that it created for the asset. The date must be equal to or greater than the system date, and it must be greater than the value in attribute ActiveStartDate.
• ActiveStartDate: string (date-time)
  Read Only: true

  Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value in attribute ActiveEndDate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the meter template. This value must use uppercase letters and it can be alphanumeric. Each meter that the application creates for the asset references this value.
• MeterDefinitionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only.
• MeterDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the meter template. Each meter that the application creates and displays in the contextual action area for the meter that references this value.
• MeterId: integer (int64)
  Read Only: true

  Value that uniquely identifies the asset meter. The application uses this value and the value that identifies the asset to identify the asset meter, and then record a new meter reading. As an alternative, the application can use the meter code and the asset number to identify the asset meter and record the new reading.
• MeterName: string
  Read Only: true

  Maximum Length: 120

  Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of attributes MeterName and MeterCode provide a unique value that identifies the meter template.
• MeterObjectId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business object that the application creates for this meter. This value represents the asset identifier that the application gets from the asset that references the meter.
• MeterTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for MeterCode are continuous, similar to an odometer, or a gauge, similar to a thermometer. You can use the ORA_CSE_METER_TYPE_CODE lookup to examine the values that this attribute uses.
• MeterUsageCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line. Contains one of the following values: ORA_ASSET or ORA_CONTRACT. You can use the ORA_CSE_METER_USAGE_CODE lookup to examine the values that this attribute uses.
• ReadingDirection: string
  Read Only: true

  Maximum Length: 30

  Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. ReadingDirection specifies to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. You can use the ORA_CSE_DIRECTION lookup to examine the values that this attribute uses.
• ReadingTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. ReadingTypeCode specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. You can use the ORA_CSE_READING_TYPE_CODE lookup to examine the values that this attribute uses.
• ResetAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then do not allow. If true, then you must define attribute ResetValue. The default value is false. Each meter that the application creates for the asset references this value. You cannot define an indicator for a gauge meter.
• ResetValue: number
  Read Only: true

  Reset value for the meter in the meter template. The application uses ResetValue as the reset value when it records the meter reading history. If you set attribute ResetAllowedFlag to true, then you must specify a value for attribute ResetValue. Each meter that the application creates for the asset references ResetValue. ResetValue must contain a value that is greater than zero, and that is equal to the lowest reading value that the physical meter allows for the asset.
• RolloverAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then do not allow rollover. If true, then you must also specify values for attributes RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedFlag is false. RolloverAllowedFlag is required. Each meter that the application creates for the asset references RolloverAllowedFlag. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording.
• RolloverMaximumValue: number
  Read Only: true

  Maximum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If attribute RolloverAllowedFlag is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value in attribute RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.
• RolloverResetValue: number
  Read Only: true

  Minimum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If attribute RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value in RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. UOMCode provides a context that you can use to define, record, or view meter history. You can use the ORA_CSE_UOM_CODE lookup to examine the values that this attribute uses.

{
    "type":"object",
    "properties":{
        "MeterUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line.  Contains one of the following values: ORA_ASSET or ORA_CONTRACT. You can use the ORA_CSE_METER_USAGE_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then do not allow rollover. If true, then you must also specify values for attributes RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedFlag is false. RolloverAllowedFlag is required. Each meter that the application creates for the asset references RolloverAllowedFlag. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverResetValue":{
            "type":"number",
            "description":"Minimum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If attribute RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value in RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for MeterCode are continuous, similar to an odometer, or a gauge, similar to a thermometer. You can use the ORA_CSE_METER_TYPE_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterCode":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. ReadingTypeCode specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. You can use the ORA_CSE_READING_TYPE_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResetAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then do not allow. If true, then you must define attribute ResetValue. The default value is false. Each meter that the application creates for the asset references this value. You cannot define an indicator for a gauge meter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeterDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the meter template. Each meter that the application creates and displays in the contextual action area for the meter that references this value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterObjectId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveStartDate":{
            "type":"string",
            "description":"Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value in attribute ActiveEndDate.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReadingDirection":{
            "maxLength":30,
            "type":"string",
            "description":"Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. ReadingDirection specifies to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. You can use the ORA_CSE_DIRECTION lookup to examine the values that this attribute uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of attributes MeterName and MeterCode provide a unique value that identifies the meter template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResetValue":{
            "type":"number",
            "description":"Reset value for the meter in the meter template. The application uses ResetValue as the reset value when it records the meter reading history. If you set attribute ResetAllowedFlag to true, then you must specify a value for attribute ResetValue. Each meter that the application creates for the asset references ResetValue. ResetValue must contain a value that is greater than zero, and that is equal to the lowest reading value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the application can no longer use the meter template for the asset. The application sets this value to the default, active end date for the meter that it created for the asset. The date must be equal to or greater than the system date, and it must be greater than the value in attribute ActiveStartDate.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. UOMCode provides a context that you can use to define, record, or view meter history. You can use the ORA_CSE_UOM_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverMaximumValue":{
            "type":"number",
            "description":"Maximum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If attribute RolloverAllowedFlag is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value in attribute RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : customerAssets-AssetStructure-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
• AssetNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item that the child asset references. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationshipId: integer (int64)
  Read Only: true

  Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  Serial number of the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that the child asset references. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the asset. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. To add or remove a child asset of the asset that you are updating, you must provide the value that identifies the asset, the asset number, or the value that identifies the item and serial number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : customerAssets-CustomerAssetDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context of the asset.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Display value for the descriptive flexfield of the asset.
• AssetId: integer (int64)
  Value that uniquely identifies the asset. Use this attribute in the descriptive flexfield resource for the asset. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset. Use this attribute in the descriptive flexfield resource for the asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Display value for the descriptive flexfield of the asset.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context of the asset.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AssetCharge

Operation: /fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/AssetCharge

Parameters:

• AssetId: $request.path.AssetId

The Asset Charges resource manages asset charges. The customer asset charge provides pricing details that the customer can use for billing or to renew the contract.

AssetMeter

Operation: /fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/AssetMeter

Parameters:

• AssetId: $request.path.AssetId

The Asset Meters resource gets the meters associated with the maintenance assets.

AssetStructure

Operation: /fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/AssetStructure

Parameters:

• AssetId: $request.path.AssetId

The Customer Asset Relationships resource manages customer asset relationships.

CustomerAssetDFF

Operation: /fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/CustomerAssetDFF

Parameters:

• AssetId: $request.path.AssetId

The Flexfields for Customer Assets resource manages descriptive flexfields that contain details about the customer assets.

Back to Top

Examples

This example describes how to create one customer asset.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example creates a simple customer asset that does not include asset charge details:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/customerAssets"

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": "SN-REST-ASSET-1-NO-041816 - Copy2",
"CustomerId": 1000,
"Description": "SN-REST-ASSET-1-NO-CHARGES",
"ItemId": 300100092597422,
"ItemOrganizationId": 207,
"Quantity": 1,
"UOMCode": "Ea",
"UpdateContractFlag":"Y",
"SerialNumber":"BATstSer01"
}"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
"ActiveEndDate": null,
"AssetId": 300100092619266,
"AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy2",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": 1,
"CustomerAccountId": null,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": null,
"CustomerBillingPartyId": null,
"CustomerBillingPartySiteId": null,
"CustomerId": 1000,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "SN-REST-ASSET-1-NO-CHARGES",
"ItemId": 300100092597422,
"ItemOrganizationId": 207,
"ItemRevision": null,
"LotNumber": null,
"ObjectVersionNumber": 1,
"Quantity": 1,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderLineNumber": null,
"SalesOrderNumber": null,
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": null,
"SoldByBusinessUnitId": null,
"UOMCode": "Ea",
"ItemNumber": null,
"OrganizationCode": null,
"CurrentLocation": null,
"ItemNumberTransient": null,
"OrganizationCodeTransient": null,
"CustomerNumberTransient": null,
"UpdateContractFlag": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA02FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA02FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA02FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/lov/OrgOrganizationDefinitionsVA",
"name": "OrgOrganizationDefinitionsVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA02FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/AssetCharge",
"name": "AssetCharge",
"kind": "collection"
}
]
}

Example Two cURL Command

This example creates a complex customer asset that does not include asset charge details. It includes the customer, customer account, account site, and sales order:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/customerAssets"

Example Two Request Body

The following example includes the contents of the request body in JSON format:

{
"AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy3",
"CustomerId": 1000,
"Description": "SN-REST-ASSET-1-NO-CHARGES",
"ItemId": 300100092597422,
"ItemOrganizationId": 207,
"ObjectVersionNumber": 1,
"Quantity": 1,
"UOMCode": "Ea",
"CustomerAccountId": 10000,
"CustomerAccountSiteId": 10010,
"SalesOrderNumber":"BA_02_29_06_SO01",
"SalesOrderId": 10000,
"SalesOrderLineNumber":"BA_02_29_06_SOLN01",
"SalesOrderLineId": 10000
}

Example Two Response Body

The following example includes the contents of the response body in JSON format:

{
"ActiveEndDate": null,
"AssetId": 300100092619269,
"AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy3",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": 1,
"CustomerAccountId": 10000,
"CustomerAccountSiteId": 10010,
"CustomerAccountSiteUseId": null,
"CustomerBillingPartyId": null,
"CustomerBillingPartySiteId": null,
"CustomerId": 1000,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "SN-REST-ASSET-1-NO-CHARGES",
"ItemId": 300100092597422,
"ItemOrganizationId": 207,
"ItemRevision": null,
"LotNumber": null,
"ObjectVersionNumber": 1,
"Quantity": 1,
"SalesOrderId": 10000,
"SalesOrderLineId": 10000,
"SalesOrderLineNumber": "BA_02_29_06_SOLN01",
"SalesOrderNumber": "BA_02_29_06_SO01",
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": null,
"SoldByBusinessUnitId": null,
"UOMCode": "Ea",
"ItemNumber": null,
"OrganizationCode": null,
"CurrentLocation": null,
"ItemNumberTransient": null,
"OrganizationCodeTransient": null,
"CustomerNumberTransient": null,
"UpdateContractFlag": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA05FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA05FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA05FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/lov/OrgOrganizationDefinitionsVA",
"name": "OrgOrganizationDefinitionsVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA05FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/AssetCharge",
"name": "AssetCharge",
"kind": "collection"
}
]
}

Example Three cURL Command

This example creates a customer asset that includes asset charge details:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/customerAssets"

Example Three Request Body

The following example includes the contents of the request body in JSON format:

{
"AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy4",
"CustomerId": 1000,
"Description": "SN-REST-ASSET-1-NO-CHARGES",
"ItemId": 300100092597422,
"ItemOrganizationId": 207,
"Quantity": 1,
"UOMCode": "Ea",
"AssetCharge": [
{
"ChargeDefinitionCode":"PRICE",
"PricedQuantityUOMCode":"Ea",
"UnitPrice":1,
"ObjectVersionNumber":1,
"CurrencyCode":"USD",
"PrimaryFlag":"Y",
"ChargesRollupFlag":"Y",
"ChargeComponentsRollupFlag":"Y",
"TaxIncludedFlag":"Y"
}
]
}

Example Three Response Body

The following example includes the contents of the response body in JSON format:

{
"ActiveEndDate": null,
"AssetId": 300100092619273,
"AssetNumber": "SN-REST-ASSET-1-NO-041816 - Copy4",
"CurrentLocationContext": "ORA_CUSTOMER",
"CurrentLocationId": 1,
"CustomerAccountId": null,
"CustomerAccountSiteId": null,
"CustomerAccountSiteUseId": null,
"CustomerBillingPartyId": null,
"CustomerBillingPartySiteId": null,
"CustomerId": 1000,
"CustomerSiteId": null,
"CustomerSitePartyId": null,
"Description": "SN-REST-ASSET-1-NO-CHARGES",
"ItemId": 300100092597422,
"ItemOrganizationId": 207,
"ItemRevision": null,
"LotNumber": null,
"ObjectVersionNumber": 1,
"Quantity": 1,
"SalesOrderId": null,
"SalesOrderLineId": null,
"SalesOrderLineNumber": null,
"SalesOrderNumber": null,
"SalesOrderSourceSystem": null,
"SalesOrderSourceSystemType": null,
"SerialNumber": null,
"ShipmentDate": null,
"SoldByBusinessUnitId": null,
"UOMCode": "Ea",
"ItemNumber": null,
"OrganizationCode": null,
"CurrentLocation": null,
"ItemNumberTransient": null,
"OrganizationCodeTransient": null,
"CustomerNumberTransient": null,
"UpdateContractFlag": null,
"AssetCharge": [
{
"ChargeDefinitionCodeTransient": null,
"AssetChargeId": 300100092619274,
"AssetId": 300100092619273,
"ChargeComponentsRollupFlag": true,
"ChargeDefinitionCode": "PRICE",
"ChargesRollupFlag": true,
"CurrencyCode": "USD",
"ObjectVersionNumber": 1,
"PriceElementCode": null,
"PriceElementUsageCode": null,
"PricePeriodicityCode": null,
"PricedQuantityUOMCode": "Ea",
"PrimaryFlag": true,
"TaxIncludedFlag": true,
"UnitPrice": 1,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/AssetCharge/300100092619274",
"name": "AssetCharge",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/AssetCharge/300100092619274",
"name": "AssetCharge",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/child/AssetCharge/300100092619274/lov/ChargeDefinitionVA",
"name": "ChargeDefinitionVA",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000006737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
"name": "customerAssets",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername/fscmRestApi/resources/version/customerAssets/00080000000EACED00057708000110F07F6AEA09FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/lov/OrgOrganizationDefinitionsVA",
"name": "OrgOrganizationDefinitionsVA",
"kind": "collection"
}
]
}

Back to Top