Jump to

• Request
• Response

Update an asset

patch

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}

Request

Path Parameters

• AssetId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Asset End Date

  Date when the asset becomes inactive. For maintenance assets, the asset active end date must be a future date. For customer assets, the asset active end date must be a past date and not earlier than the customer active start date. When the asset end date is populated, the other asset attributes can't be updated.
• Address1: string
  Title: Address 1

  First line of the address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Address2: string
  Title: Address 2

  Second line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Address3: string
  Title: Address 3

  Third line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Address4: string
  Title: Address 4

  Fourth line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• assetDFF: array assetDFF
• assetImageAttachments: array Image Attachments
  Title: Image Attachments

  Attachment management capabilities: view, create, and update.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 80

  Value that uniquely identifies the asset. This attribute is optional. If you don't provide a value, the application uses the asset identifier.
• assetQualifications: array Asset Qualifications
  Title: Asset Qualifications

  The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.
• attachments: array Image Attachments
  Title: Image Attachments

  Attachment management capabilities: view, create, and update.
• BOMExplosionFlag: boolean
  Title: Show logical assets

  Contains one of the following values: true or false. If true, then create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. If false, then don't create child assets from the primary bill of material. The default value is false.
• charges: array Charges
  Title: Charges

  The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.
• City: string
  Title: City

  City of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• CompetitorAssetFlag: boolean
  Title: Competitor asset

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the asset represents a competitor asset. if false, then the asset doesn't represents a competitor asset. The default value is false.
• ContactId: integer (int64)
  Title: Contact ID

  Value that uniquely identifies the asset contact. You must provide either the contact identifier or the contact number or the contact name to associate a contact to the asset. This attribute is optional and updatable. The contact identifier corresponds to the party identifier in the customer data model where the asset contact is defined as person-type party.
• ContactName: string
  Title: Contact

  Maximum Length: 255

  Name of the contact person of the asset. This attribute is same as the party name in the customer data model where the party type is PERSON. The contact name is the concatenation of first name, middle name, last name, and the suffix. The contact name isn't unique. You can use contact identifier, contact number, or contact name to create or update the asset contact.
• ContactNumber: string
  Title: Phone

  Maximum Length: 255

  Number that uniquely identifies the contact person of the asset. This attribute is same as the party number in the customer data model where the party type is PERSON. For enterprise assets, the contact person would be the employee identified with usage as HR Employee. For customer assets, the contact person would be a contact with usage as customer contact. You can use contact identifier, contact number, or contact name to create or update the asset contact.
• Country: string
  Title: Country

  Country of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• County: string
  Title: County

  County of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• CurrentLocationContextCode: string
  Title: Location Type

  Maximum Length: 80

  Abbreviation that uniquely identifies the location context where the asset currently resides. A list of accepted values is defined in the lookup type ORA_CSE_CURRENT_LOC_CONTEXT. This attribute is required to create the asset.
• CurrentLocationId: integer (int64)
  Title: Location ID

  Value that uniquely identifies the location where the asset currently resides. You can provide the value for this attribute when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION or ORA_INTERNAL_LOCATION.
• CustomerAccountId: integer (int64)
  Title: Bill-to Account Number

  Value that uniquely identifies the customer account to which the asset is billed.
• CustomerAccountNumber: string
  Title: Customer Account

  Maximum Length: 255

  Number that uniquely identifies the customer account to which the asset is billed. This attribute is read-only.
• CustomerAccountSiteId: integer (int64)
  Title: Customer Account Site ID

  Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account.
• CustomerAccountSiteNumber: string
  Title: Account Site

  Maximum Length: 255

  Number that identifies the site of the customer account for the asset. This attribute is read-only.
• CustomerAccountSiteUseCode: string
  Title: Customer Account Site Use Code

  Maximum Length: 255

  Abbreviation that identifies the usage of the customer account site for the asset. This attribute is read-only.
• CustomerAccountSiteUseId: integer (int64)
  Title: Customer Account Site Use ID

  Value that uniquely identifies the usage of the customer account site for the asset. This attribute must be part of the customer account site.
• CustomerAssetEndDate: string (date-time)
  Title: Customer Asset End Date

  Date and time when the customer asset becomes inactive. If this attribute contains a value, then you can't update other asset attributes.
• CustomerAssetStartDate: string (date-time)
  Title: Customer Asset Start Date

  Date and time when the customer asset becomes active. The application uses the shipment date to determine the value for this attribute. This attribute is read-only.
• CustomerBillingPartyId: integer (int64)
  Title: Bill-to Customer

  Value that uniquely identifies the customer party that the application bills for the asset. This attribute is read-only.
• CustomerBillingPartySiteId: integer (int64)
  Title: Bill-to Site Number

  Value that uniquely identifies the billing party site for the customer. This attribute is read-only.
• CustomerId: integer (int64)
  Title: Customer ID

  Value that uniquely identifies the customer party who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.
• CustomerName: string
  Title: Customer

  Name of the customer who currently owns or uses the asset. This attribute is read-only.
• CustomerNumber: string
  Title: Customer Number

  Number that uniquely identifies the customer who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.
• CustomerPartyType: string
  Title: Customer Party Type

  Maximum Length: 30

  Value that identifies the party type of the customer of the asset. The Customer can be of either Organization party or Person party.
• CustomerSiteId: integer (int64)
  Title: Customer Site ID

  Value that uniquely identifies the customer site where the asset currently resides. You can provide this attribute when the value for CurrentLocationContextCode is ORA_CUSTOMER.
• CustomerSiteNumber: string
  Title: Customer Site Number

  Maximum Length: 255

  Default Value: CustomerSiteNumberNU

  Value that uniquely identifies the customer site where the asset currently resides. This attribute is read-only.
• CustomerSitePartyId: integer (int64)
  Title: Customer Site Party ID

  Value that uniquely identifies the customer site party where the asset is located.
• CustomerSitePartyNumber: string
  Title: Customer Site Party Number

  Maximum Length: 255

  Number that uniquely identifies the customer site party where the asset is located. This attribute is read-only.
• Description: string
  Title: Asset Description

  Maximum Length: 240

  Description of an asset. You can use this attribute to describe the asset features, characteristics, and so on.
• DfltWoSubTypeCode: string
  Title: Default Maintenance Work Order Subtype

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order subtype. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. The application uses this attribute to set the work order subtype when it creates a work order for the asset.
• DfltWoTypeCode: string
  Title: Default Maintenance Work Order Type

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The application uses this attribute to set the work order type when it creates a work order for the asset.
• fixedAssetAssociations: array Fixed Asset Associations
  Title: Fixed Asset Associations

  The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.
• FulfillLineId: integer (int64)
  Title: Line

  Value that uniquely identifies the distributed order orchestration fulfillment line reference. This attribute is read-only.
• InServiceDate: string (date)
  Title: Date in Service

  Date and time when the organization put the asset in service. The in-service date must occur after the installed date.
• InstalledDate: string (date)
  Title: Installed Date

  Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date.
• IotEnabledFlag: boolean
  Title: IoT Enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then synchronize the asset with the application that controls the lot. If false, then don't synchronize. The default value is true. The response payload translates Y to true and N to false.
• ItemId: integer (int64)
  Title: Item ID

  Value that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.
• ItemNumber: string
  Title: Item

  Number that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.
• ItemRevision: string
  Title: Item Revision

  Maximum Length: 18

  Number that identifies the item revision that the asset references.
• LocationOrganizationCode: string
  Title: Location Organization Code

  Maximum Length: 255

  Abbreviation that uniquely identifies the organization where the asset currently resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.
• LocationOrganizationId: integer (int64)
  Title: Location Organization ID

  Value that uniquely identifies the organization where the asset currently resides. You can provide the location organization if the value of CurrentLocationContextCode is ORA_WORK CENTER.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Number that uniquely identifying the lot that the asset references to control the item in inventory. This attribute is applicable when the item is lot controlled. If the lot number doesn't exist in the inventory, then the application creates a lot in the inventory application.
• MaintainableFlag: boolean
  Title: Allow maintenance programs

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then enable the asset for a maintenance activity such as a maintenance program or maintenance work order. If false, then don't enable. The default value is true for maintainable items.
• ManageAssetPrivilege: string
  Title: Manage Asset Privilege

  Contains one of the following values. C: Customer asset responsibility. M : Enterprise asset responsibility. MC: Superuser responsibility.
• meters: array Meters
  Title: Meters

  Details of the meters associated with an asset.
• NewWoAllowedFlag: boolean
  Title: Allow work orders

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the application to create a work order for the asset. If false, then don't allow. The default value is true for maintainable items.
• notes: array Notes
  Title: Notes

  The note objects resource is used to view the note objects.
• OperatingOrganizationCode: string
  Title: Operating Organization

  Abbreviation that uniquely identifies the organization that creates or operates the asset. You need the organization code to create an enterprise asset for a customer asset. If the organization isn't provided, the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.
• OperatingOrganizationId: integer (int64)
  Title: Operating Organization ID

  Value that uniquely identifies the organization that creates or operates the asset. You need the organization identifier to create an enterprise asset for a customer asset. If the organization isn't provided the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.
• ParentAssetId: integer
  Title: Parent Asset ID

  Value that uniquely identifies the parent asset number to which the imported asset needs to be added.
• partsListComponents: array Parts
  Title: Parts

  The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.
• PostalCode: string
  Title: Postal Code

  Abbreviation that identifies the postal area where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Province: string
  Title: Province

  Province where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• PurchaseDate: string (date)
  Title: Customer Purchase Date

  Date and time when the customer purchased the asset. If you provide the registration date, then you must provide the purchase date. The purchased date must occur before the registration date.
• Quantity: number
  Title: Quantity

  Quantity for the item that the asset references. If the item is serial controlled, then the quantity can't exceed one. This attribute is required to create the asset.
• RegistrationDate: string (date)
  Title: Registration Date

  Date and time when the customer registered the asset.
• relationships: array Relationships
  Title: Relationships

  The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.
• ReturnOrderFulfillLineId: integer (int64)
  Value that unique identify the Return Order Fulfill Line Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.
• ReturnOrderId: integer (int64)
  Value the unique identify the Return Order Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.
• ReturnOrderLineId: integer (int64)
  Value that unique identify the Return Order Line Identifier. This attribute is read-only and it's a system generated number when return sales order is created.
• ReturnOrderNumber: string
  Maximum Length: 255

  Reference the unique identifier the Number of the Return Sales Order Number. This attribute is read-only and it's a system generated number when return sales order is created.
• ReturnSourceOrderNumber: string
  Maximum Length: 255

  Reference the unique identifier the Number of the Return Source Sales Order Number. This is a read-only and it's a system generated number when return sales order is created.
• SalesOrderId: integer (int64)
  Title: Sales Order ID

  Value that uniquely identifies the sales order that's used to order the asset.
• SalesOrderLineId: integer (int64)
  Title: Sales Order Line ID

  Value that uniquely identifies the line of the sales order that's used to order the asset.
• SalesOrderLineNumber: string
  Title: Sales Order Line Number

  Maximum Length: 120

  Number that uniquely identifies the line of the sales order that's used to order the asset.
• SalesOrderNumber: string
  Title: Sales Order Number

  Maximum Length: 120

  Number that identifies the sales order that's used to order the asset.
• SalesOrderSourceSystem: string
  Title: Sales Order Source System

  Maximum Length: 30

  Name of the source application where the sales order originated. If SalesOrderSourceSystemType is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of the source application that isn't an Oracle Fusion application. If SalesOrderSourceSystemType is ORA_INTERNAL, then SalesOrderSourceSystem identifies the Oracle Fusion application.
• SalesOrderSourceSystemType: string
  Title: Sales Order Source System Type

  Maximum Length: 30

  Description of the type of source application. This attribute is read-only.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. This attribute is used when item is serial controlled. If the serial number doesn't exist in the inventory, then the application creates a serial in the inventory application.
• ShipmentDate: string (date-time)
  Title: Shipment Date

  Date when the asset is shipped to the customer. This attribute is optional. If you don't provide a value, the application uses the application date.
• SoldByBusinessUnitId: integer (int64)
  Title: Selling Business Unit ID

  Value that uniquely identifies the business unit that sold the asset. This attribute is optional.
• SoldByBusinessUnitName: string
  Title: Selling Business Unit

  Maximum Length: 255

  Name of the business unit that sold the asset. This attribute is read-only.
• SplitFromAssetId: integer (int64)
  Title: Split from Asset ID

  Value that uniquely identifies the split from asset reference. For nonserial assets, when assets are split during partial return, the new asset created with the remaining quantity will have this split from asset reference.
• State: string
  Title: State

  State where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• StructureActionCode: string
  Title: Structure Action Code

  Abbreviation that uniquely identifies the import action to be performed on the asset relationship. Valid values are ORA_ADD or ORA_REMOVE. ORA_ADD: Add the imported asset to a parent asset. ORA_REMOVE: Remove the asset from its parent asset. A list of accepted values is defined in the lookup type ORA_CSE_ASSET_IMP_CONF_ACTION.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  Abbreviation that uniquely identifies the unit of measure for the asset quantity. It must use the same unit of measure that the item uses as the primary unit of measure. If this attribute is empty, then the application sets the value to the item primary unit of measure.
• UpdateContractFlag: boolean
  Title: Update Contract

  Contains one of the following values: true or false. If true, then the application interfaces the asset change to the enterprise contract application. If false, then the asset change isn't interfaced to enterprise contract application. The default value is true. This attribute is used when you import the asset and the contract through enterprise contract. Set this attribute to false only if you're certain that the application must handle each contract update separately, or if the update doesn't apply in the context.
• WorkCenterCode: string
  Title: Work Center Code

  Maximum Length: 255

  Abbreviation that identifies the work center where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.
• WorkCenterId: integer (int64)
  Title: Work Center ID

  Value that uniquely identifies the work center where the asset currently resides. You can provide the work center when the value of CurrentLocationContextCode is ORA_WORK CENTER.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Asset End Date",
            "type":"string",
            "description":"Date when the asset becomes inactive. For maintenance assets, the asset active end date must be a future date. For customer assets, the asset active end date must be a past date and not earlier than the customer active start date. When the asset end date is populated, the other asset attributes can't be updated.",
            "format":"date-time",
            "nullable":true
        },
        "Address1":{
            "title":"Address 1",
            "type":"string",
            "description":"First line of the address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "Address2":{
            "title":"Address 2",
            "type":"string",
            "description":"Second line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "Address3":{
            "title":"Address 3",
            "type":"string",
            "description":"Third line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "Address4":{
            "title":"Address 4",
            "type":"string",
            "description":"Fourth line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the asset. This attribute is optional. If you don't provide a value, the application uses the asset identifier.",
            "nullable":false
        },
        "BOMExplosionFlag":{
            "title":"Show logical assets",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. If false, then don't create child assets from the primary bill of material. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "type":"string",
            "description":"City of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "CompetitorAssetFlag":{
            "title":"Competitor asset",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the asset represents a competitor asset. if false, then the asset doesn't represents a competitor asset. The default value is false.",
            "nullable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset contact. You must provide either the contact identifier or the contact number or the contact name to associate a contact to the asset. This attribute is optional and updatable. The contact identifier corresponds to the party identifier in the customer data model where the asset contact is defined as person-type party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the contact person of the asset. This attribute is same as the party name in the customer data model where the party type is PERSON. The contact name is the concatenation of first name, middle name, last name, and the suffix. The contact name isn't unique. You can use contact identifier, contact number, or contact name to create or update the asset contact.",
            "nullable":true
        },
        "ContactNumber":{
            "title":"Phone",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the contact person of the asset. This attribute is same as the party number in the customer data model where the party type is PERSON. For enterprise assets, the contact person would be the employee identified with usage as HR Employee. For customer assets, the contact person would be a contact with usage as customer contact. You can use contact identifier, contact number, or contact name to create or update the asset contact.",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "type":"string",
            "description":"Country of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "County":{
            "title":"County",
            "type":"string",
            "description":"County of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "CurrentLocationContextCode":{
            "title":"Location Type",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the location context where the asset currently resides. A list of accepted values is defined in the lookup type ORA_CSE_CURRENT_LOC_CONTEXT. This attribute is required to create the asset.",
            "nullable":false
        },
        "CurrentLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the location where the asset currently resides. You can provide the value for this attribute when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION or ORA_INTERNAL_LOCATION.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAccountId":{
            "title":"Bill-to Account Number",
            "type":"integer",
            "description":"Value that uniquely identifies the customer account to which the asset is billed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAccountNumber":{
            "title":"Customer Account",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the customer account to which the asset is billed. This attribute is read-only.",
            "nullable":true
        },
        "CustomerAccountSiteId":{
            "title":"Customer Account Site ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAccountSiteNumber":{
            "title":"Account Site",
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the site of the customer account for the asset. This attribute is read-only.",
            "nullable":true
        },
        "CustomerAccountSiteUseCode":{
            "title":"Customer Account Site Use Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the usage of the customer account site for the asset. This attribute is read-only.",
            "nullable":true
        },
        "CustomerAccountSiteUseId":{
            "title":"Customer Account Site Use ID",
            "type":"integer",
            "description":"Value that uniquely identifies the usage of the customer account site for the asset. This attribute must be part of the customer account site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerAssetEndDate":{
            "title":"Customer Asset End Date",
            "type":"string",
            "description":"Date and time when the customer asset becomes inactive. If this attribute contains a value, then you can't update other asset attributes.",
            "format":"date-time",
            "nullable":true
        },
        "CustomerAssetStartDate":{
            "title":"Customer Asset Start Date",
            "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
        },
        "CustomerBillingPartyId":{
            "title":"Bill-to Customer",
            "type":"integer",
            "description":"Value that uniquely identifies the customer party that the application bills for the asset. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerBillingPartySiteId":{
            "title":"Bill-to Site Number",
            "type":"integer",
            "description":"Value that uniquely identifies the billing party site for the customer. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer party who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerName":{
            "title":"Customer",
            "type":"string",
            "description":"Name of the customer who currently owns or uses the asset. This attribute is read-only.",
            "nullable":true
        },
        "CustomerNumber":{
            "title":"Customer Number",
            "type":"string",
            "description":"Number that uniquely identifies the customer who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.",
            "nullable":true
        },
        "CustomerPartyType":{
            "title":"Customer Party Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the party type of the customer of the asset. The Customer can be of either Organization party or Person party.",
            "nullable":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "CustomerSiteId":{
            "title":"Customer Site ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. You can provide this attribute when the value for CurrentLocationContextCode is ORA_CUSTOMER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerSiteNumber":{
            "title":"Customer Site Number",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. This attribute is read-only.",
            "nullable":true,
            "default":"CustomerSiteNumberNU"
        },
        "CustomerSitePartyId":{
            "title":"Customer Site Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer site party where the asset is located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerSitePartyNumber":{
            "title":"Customer Site Party Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the customer site party where the asset is located. This attribute is read-only.",
            "nullable":true
        },
        "Description":{
            "title":"Asset Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of an asset. You can use this attribute to describe the asset features, characteristics, and so on.",
            "nullable":true
        },
        "DfltWoSubTypeCode":{
            "title":"Default Maintenance Work Order Subtype",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order subtype. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. The application uses this attribute to set the work order subtype when it creates a work order for the asset.",
            "nullable":true
        },
        "DfltWoTypeCode":{
            "title":"Default Maintenance Work Order Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The application uses this attribute to set the work order type when it creates a work order for the asset.",
            "nullable":true
        },
        "FulfillLineId":{
            "title":"Line",
            "type":"integer",
            "description":"Value that uniquely identifies the distributed order orchestration fulfillment line reference. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InServiceDate":{
            "title":"Date in Service",
            "type":"string",
            "description":"Date and time when the organization put the asset in service. The in-service date must occur after the installed date.",
            "format":"date",
            "nullable":true
        },
        "InstalledDate":{
            "title":"Installed Date",
            "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.",
            "format":"date",
            "nullable":true
        },
        "IotEnabledFlag":{
            "title":"IoT Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then synchronize the asset with the application that controls the lot. If false, then don't synchronize. The default value is true. The response payload translates Y to true and N to false.",
            "nullable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "title":"Item",
            "type":"string",
            "description":"Number that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.",
            "nullable":true
        },
        "ItemRevision":{
            "title":"Item Revision",
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the item revision that the asset references.",
            "nullable":true
        },
        "LocationOrganizationCode":{
            "title":"Location Organization Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization where the asset currently resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationOrganizationId":{
            "title":"Location Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the asset currently resides. You can provide the location organization if the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifying the lot that the asset references to control the item in inventory. This attribute is applicable when the item is lot controlled. If the lot number doesn't exist in the inventory, then the application creates a lot in the inventory application.",
            "nullable":true
        },
        "MaintainableFlag":{
            "title":"Allow maintenance programs",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then enable the asset for a maintenance activity such as a maintenance program or maintenance work order. If false, then don't enable. The default value is true for maintainable items.",
            "nullable":false
        },
        "ManageAssetPrivilege":{
            "title":"Manage Asset Privilege",
            "type":"string",
            "description":"Contains one of the following values. C: Customer asset responsibility. M : Enterprise asset responsibility. MC: Superuser responsibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NewWoAllowedFlag":{
            "title":"Allow work orders",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the application to create a work order for the asset. If false, then don't allow. The default value is true for maintainable items.",
            "nullable":false
        },
        "OperatingOrganizationCode":{
            "title":"Operating Organization",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization that creates or operates the asset. You need the organization code to create an enterprise asset for a customer asset. If the organization isn't provided, the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.",
            "nullable":true
        },
        "OperatingOrganizationId":{
            "title":"Operating Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or operates the asset. You need the organization identifier to create an enterprise asset for a customer asset. If the organization isn't provided the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ParentAssetId":{
            "title":"Parent Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the parent asset number to which the imported asset needs to be added.",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "type":"string",
            "description":"Abbreviation that identifies the postal area where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "Province":{
            "title":"Province",
            "type":"string",
            "description":"Province where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "PurchaseDate":{
            "title":"Customer Purchase Date",
            "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
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for the item that the asset references. If the item is serial controlled, then the quantity can't exceed one. This attribute is required to create the asset.",
            "nullable":false
        },
        "RegistrationDate":{
            "title":"Registration Date",
            "type":"string",
            "description":"Date and time when the customer registered the asset.",
            "format":"date",
            "nullable":true
        },
        "ReturnOrderFulfillLineId":{
            "type":"integer",
            "description":"Value that unique identify the Return Order Fulfill Line Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReturnOrderId":{
            "type":"integer",
            "description":"Value the unique identify the Return Order Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReturnOrderLineId":{
            "type":"integer",
            "description":"Value that unique identify the Return Order Line Identifier. This attribute is read-only and it's a system generated number when return sales order is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReturnOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Reference the unique identifier the Number of the Return Sales Order Number. This attribute is read-only and it's a system generated number when return sales order is created.",
            "nullable":true
        },
        "ReturnSourceOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Reference the unique identifier the Number of the Return Source Sales Order Number. This is a read-only and it's a system generated number when return sales order is created.",
            "nullable":true
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that's used to order the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderLineId":{
            "title":"Sales Order Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the line of the sales order that's used to order the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SalesOrderLineNumber":{
            "title":"Sales Order Line Number",
            "maxLength":120,
            "type":"string",
            "description":"Number that uniquely identifies the line of the sales order that's used to order the asset.",
            "nullable":true
        },
        "SalesOrderNumber":{
            "title":"Sales Order Number",
            "maxLength":120,
            "type":"string",
            "description":"Number that identifies the sales order that's used to order the asset.",
            "nullable":true
        },
        "SalesOrderSourceSystem":{
            "title":"Sales Order Source System",
            "maxLength":30,
            "type":"string",
            "description":"Name of the source application where the sales order originated. If SalesOrderSourceSystemType is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of the source application that isn't an Oracle Fusion application. If SalesOrderSourceSystemType is ORA_INTERNAL, then SalesOrderSourceSystem identifies the Oracle Fusion application.",
            "nullable":true
        },
        "SalesOrderSourceSystemType":{
            "title":"Sales Order Source System Type",
            "maxLength":30,
            "type":"string",
            "description":"Description of the type of source application. This attribute is read-only.",
            "nullable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.",
            "nullable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.",
            "nullable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. This attribute is used when item is serial controlled. If the serial number doesn't exist in the inventory, then the application creates a serial in the inventory application.",
            "nullable":true
        },
        "ShipmentDate":{
            "title":"Shipment Date",
            "type":"string",
            "description":"Date when the asset is shipped to the customer. This attribute is optional. If you don't provide a value, the application uses the application date.",
            "format":"date-time",
            "nullable":true
        },
        "SoldByBusinessUnitId":{
            "title":"Selling Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that sold the asset. This attribute is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SoldByBusinessUnitName":{
            "title":"Selling Business Unit",
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit that sold the asset. This attribute is read-only.",
            "nullable":true
        },
        "SplitFromAssetId":{
            "title":"Split from Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the split from asset reference. For nonserial assets, when assets are split during partial return, the new asset created with the remaining quantity will have this split from asset reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "State":{
            "title":"State",
            "type":"string",
            "description":"State where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true
        },
        "StructureActionCode":{
            "title":"Structure Action Code",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the import action to be performed on the asset relationship. Valid values are ORA_ADD or ORA_REMOVE. ORA_ADD: Add the imported asset to a parent asset. ORA_REMOVE: Remove the asset from its parent asset. A list of accepted values is defined in the lookup type ORA_CSE_ASSET_IMP_CONF_ACTION.",
            "nullable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the unit of measure for the asset quantity. It must use the same unit of measure that the item uses as the primary unit of measure. If this attribute is empty, then the application sets the value to the item primary unit of measure.",
            "nullable":false
        },
        "UpdateContractFlag":{
            "title":"Update Contract",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application interfaces the asset change to the enterprise contract application. If false, then the asset change isn't interfaced to enterprise contract application. The default value is true. This attribute is used when you import the asset and the contract through enterprise contract. Set this attribute to false only if you're certain that the application must handle each contract update separately, or if the update doesn't apply in the context.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkCenterCode":{
            "title":"Work Center Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the work center where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "nullable":true
        },
        "WorkCenterId":{
            "title":"Work Center ID",
            "type":"integer",
            "description":"Value that uniquely identifies the work center where the asset currently resides. You can provide the work center when the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "assetDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "assetImageAttachments":{
            "title":"Image Attachments",
            "type":"array",
            "description":"Attachment management capabilities: view, create, and update.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetImageAttachments-item-patch-request"
            }
        },
        "assetQualifications":{
            "title":"Asset Qualifications",
            "type":"array",
            "description":"The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-item-patch-request"
            }
        },
        "attachments":{
            "title":"Image Attachments",
            "type":"array",
            "description":"Attachment management capabilities: view, create, and update.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-attachments-item-patch-request"
            }
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-charges-item-patch-request"
            }
        },
        "fixedAssetAssociations":{
            "title":"Fixed Asset Associations",
            "type":"array",
            "description":"The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-fixedAssetAssociations-item-patch-request"
            }
        },
        "meters":{
            "title":"Meters",
            "type":"array",
            "description":"Details of the meters associated with an asset.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-meters-item-patch-request"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The note objects resource is used to view the note objects.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-notes-item-patch-request"
            }
        },
        "partsListComponents":{
            "title":"Parts",
            "type":"array",
            "description":"The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-partsListComponents-item-patch-request"
            }
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-relationships-item-patch-request"
            }
        }
    }
}

Nested Schema : assetDFF

Type: array

Show Source

• Array of: object installedBaseAssets-assetDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Image Attachments

Type: array

Title: Image Attachments

Attachment management capabilities: view, create, and update.

Show Source

• Array of: object schema

{
    "title":"Image Attachments",
    "type":"array",
    "description":"Attachment management capabilities: view, create, and update.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetImageAttachments-item-patch-request"
    }
}

Nested Schema : Asset Qualifications

Type: array

Title: Asset Qualifications

The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.

Show Source

• Array of: object schema

{
    "title":"Asset Qualifications",
    "type":"array",
    "description":"The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-item-patch-request"
    }
}

Nested Schema : Image Attachments

Type: array

Title: Image Attachments

Attachment management capabilities: view, create, and update.

Show Source

• Array of: object schema

{
    "title":"Image Attachments",
    "type":"array",
    "description":"Attachment management capabilities: view, create, and update.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-attachments-item-patch-request"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.

Show Source

• Array of: object schema

{
    "title":"Charges",
    "type":"array",
    "description":"The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-charges-item-patch-request"
    }
}

Nested Schema : Fixed Asset Associations

Type: array

Title: Fixed Asset Associations

The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.

Show Source

• Array of: object schema

{
    "title":"Fixed Asset Associations",
    "type":"array",
    "description":"The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-fixedAssetAssociations-item-patch-request"
    }
}

Nested Schema : Meters

Type: array

Title: Meters

Details of the meters associated with an asset.

Show Source

• Array of: object schema

{
    "title":"Meters",
    "type":"array",
    "description":"Details of the meters associated with an asset.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-meters-item-patch-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note objects resource is used to view the note objects.

Show Source

• Array of: object schema

{
    "title":"Notes",
    "type":"array",
    "description":"The note objects resource is used to view the note objects.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-notes-item-patch-request"
    }
}

Nested Schema : Parts

Type: array

Title: Parts

The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.

Show Source

• Array of: object schema

{
    "title":"Parts",
    "type":"array",
    "description":"The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-partsListComponents-item-patch-request"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.

Show Source

• Array of: object installedBaseAssets-relationships-item-patch-request

{
    "title":"Relationships",
    "type":"array",
    "description":"The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-relationships-item-patch-request"
    }
}

Nested Schema : installedBaseAssets-assetDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AssetId: integer (int64)

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Indicates the source document ID for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Indicates the source folder path for the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the document used as the source for the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after the attachment is uploaded.
• PrimaryCategoryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Designates one of the attached images as the primary image, which will be displayed as the main visual.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the source document ID for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the source folder path for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document used as the source for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after the attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates one of the attached images as the primary image, which will be displayed as the main visual.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies an asset. This attribute is read-only.
• AssetQualificationId: integer (int64)
  Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
• attachments: array Image Attachments
  Title: Image Attachments

  Attachment management capabilities: view, create, and update.
• CurrentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Value that identifies current asset qualification.
• InspectionPlanId: integer (int64)
  Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
• IpEventId: integer (int64)
  Unique identifier of the inspection event associated while performing the asset qualification.
• NextQualificationDate: string (date-time)
  Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.
• QualificationRequirementCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.
• QualificationRequirementId: integer (int64)
  Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
• QualificationRequirementName: string
  Maximum Length: 255

  Name of the qualification requirement. This is unique and required attribute to create an asset qualification.
• WorkOrderId: integer (int64)
  Unique identifier of the work order associated while performing the asset qualification.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies an asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetQualificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CurrentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies current asset qualification.",
            "nullable":false,
            "default":false
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IpEventId":{
            "type":"integer",
            "description":"Unique identifier of the inspection event associated while performing the asset qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NextQualificationDate":{
            "type":"string",
            "description":"Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.",
            "format":"date-time",
            "nullable":true
        },
        "QualificationRequirementCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.",
            "nullable":true
        },
        "QualificationRequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QualificationRequirementName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualification requirement. This is unique and required attribute to create an asset qualification.",
            "nullable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Unique identifier of the work order associated while performing the asset qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "attachments":{
            "title":"Image Attachments",
            "type":"array",
            "description":"Attachment management capabilities: view, create, and update.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-attachments-item-patch-request"
            }
        }
    }
}

Nested Schema : Image Attachments

Type: array

Title: Image Attachments

Attachment management capabilities: view, create, and update.

Show Source

• Array of: object schema

{
    "title":"Image Attachments",
    "type":"array",
    "description":"Attachment management capabilities: view, create, and update.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-attachments-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Indicates the source document ID for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Indicates the source folder path for the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the document used as the source for the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after the attachment is uploaded.
• PrimaryCategoryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Designates one of the attached images as the primary image, which will be displayed as the main visual.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the source document ID for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the source folder path for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document used as the source for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after the attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates one of the attached images as the primary image, which will be displayed as the main visual.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Indicates the source document ID for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Indicates the source folder path for the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the document used as the source for the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after the attachment is uploaded.
• PrimaryCategoryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Designates one of the attached images as the primary image, which will be displayed as the main visual.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the source document ID for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the source folder path for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document used as the source for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after the attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates one of the attached images as the primary image, which will be displayed as the main visual.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

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: true or false. If true, then the charge component represents the aggregated value of the rollup charge. If false, then the charge component doesn't represent this value. The default value is false.
• ChargeDefinitionCode: string
  Maximum Length: 30

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

  Contains one of the following values: true or false. If true, then the pricing charge is a rollup charge. If false, then the pricing charge isn't a rollup charge. The default value is false.
• CurrencyCode: string
  Maximum Length: 15

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

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

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

  Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the recurring time frame that the application uses to price the charge such as month or year.
• PrimaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the charge is a primary charge. If false, then the charge isn't a primary charge. The default value is false.
• TaxIncludedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the asset price includes taxes. If false, then the asset price doesn't include taxes. The default value is false.
• UnitPrice: number
  Unit price of the asset. This is the current price of the asset or price that the organization used when it sold the asset.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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
            }
        },
        "ChargeComponentsRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge component represents the aggregated value of the rollup charge. If false, then the charge component doesn't represent this value. The default value is false.",
            "nullable":false
        },
        "ChargeDefinitionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the asset charge.",
            "nullable":false
        },
        "ChargesRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the pricing charge is a rollup charge. If false, then the pricing charge isn't a rollup charge. The default value is false.",
            "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.",
            "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 asset charge.",
            "nullable":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.",
            "nullable":true
        },
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the recurring time frame that the application uses to price the charge such as month or year.",
            "nullable":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.",
            "nullable":false
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge is a primary charge. If false, then the charge isn't a primary charge. The default value is false.",
            "nullable":false
        },
        "TaxIncludedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the asset price includes taxes. If false, then the asset price doesn't include taxes. The default value is false.",
            "nullable":false
        },
        "UnitPrice":{
            "type":"number",
            "description":"Unit price of the asset. This is the current price of the asset or price that the organization used when it sold the asset.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes inactive.
• ActiveStartDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes active.
• AutoTerminationFlag: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association isn't inactivated automatically. This attribute value is set conditionally during the asset update.
• ErrorMessage: string
  Maximum Length: 4000
• FaAssociationId: integer (int64)
  Number that uniquely identifies the fixed asset association.
• FaBookTypeCode: string
  Maximum Length: 30
• FixedAssetId: integer (int64)
  Value that uniquely identifies the fixed asset.
• FixedAssetNumber: string
  Title: Fixed Asset Number

  Maximum Length: 255

  Number that uniquely identifies the fixed asset.
• SynchronizationStatusCode: string
  Maximum Length: 30
• TerminationReasonCode: string
  Maximum Length: 30

  Contains a value when the autoTerminationCheckbox is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.
• ValidatedFlag: string
  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "ActiveStartDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes active.",
            "format":"date-time",
            "nullable":true
        },
        "AutoTerminationFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association isn't inactivated automatically. This attribute value is set conditionally during the asset update.",
            "nullable":false
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "nullable":true
        },
        "FaAssociationId":{
            "type":"integer",
            "description":"Number that uniquely identifies the fixed asset association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FaBookTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "FixedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fixed asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FixedAssetNumber":{
            "title":"Fixed Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the fixed asset.",
            "nullable":true
        },
        "SynchronizationStatusCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "TerminationReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Contains a value when the autoTerminationCheckbox is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.",
            "nullable":true
        },
        "ValidatedFlag":{
            "maxLength":1,
            "type":"string",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: End Date

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

  Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value of ActiveEndDate.
• AllowInMaintProgramFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter can't be used for scheduling a maintenance program. The default value is false.
• DailyUtilizationRate: number
  Title: Estimated Daily Utilization Rate

  Expected average daily total of readings that are to be entered for a meter.
• InitialReadingValue: number
  The value of the initial meter reading.
• MeterDefinitionId: integer (int64)
  Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only.
• MeterId: integer (int64)
  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.
• ReadingLockDate: string (date-time)
  The date indicating the meter lock date.
• RecordAtWoComplCode: string
  Maximum Length: 30

  Abbreviation that identifies the option that's used to control the meter reading entry at work order completion.
• UtilizationRateComputedAt: integer
  Number of readings in history for which meter readings will be used to calculate a daily utilization rate.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"End Date",
            "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 of ActiveStartDate.",
            "format":"date-time",
            "nullable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "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 of ActiveEndDate.",
            "format":"date-time",
            "nullable":false
        },
        "AllowInMaintProgramFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter can't be used for scheduling a maintenance program. The default value is false.",
            "nullable":false,
            "default":false
        },
        "DailyUtilizationRate":{
            "title":"Estimated Daily Utilization Rate",
            "type":"number",
            "description":"Expected average daily total of readings that are to be entered for a meter.",
            "nullable":true
        },
        "InitialReadingValue":{
            "type":"number",
            "description":"The value of the initial meter reading.",
            "nullable":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,
            "x-hints":{
                "precision":18
            }
        },
        "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,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ReadingLockDate":{
            "type":"string",
            "description":"The date indicating the meter lock date.",
            "format":"date-time",
            "nullable":true
        },
        "RecordAtWoComplCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the option that's used to control the meter reading entry at work order completion.",
            "nullable":true
        },
        "UtilizationRateComputedAt":{
            "type":"integer",
            "description":"Number of readings in history for which meter readings will be used to calculate a daily utilization rate.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code for extensibility.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for extensibility.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The column which stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The note type code for categorization of note.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the parent source object associated to the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the parent source object associated to the note.",
            "nullable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AssetExistsFlag: boolean
  Maximum Length: 1

  Asset exists indicator on the Parts List Components resource, which is part of the Installed Base Assets root resource.
• ComponentQuantity: number
  Title: Quantity

  Quantity of each part list component for the asset.
• ItemId: integer (int64)
  Value that uniquely identifies the item that's part of the part list for the asset. Asset Item can't be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.
• ListComponentId: integer (int64)
  Value that uniquely identifies the parts list item that the asset references.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.
• SecondaryUOMName: string
  Maximum Length: 255

  Secondary UOM Name on the Parts List Components resource, which is part of the Installed Base Assets root resource.

{
    "type":"object",
    "properties":{
        "AssetExistsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Asset exists indicator on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":true
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of each part list component for the asset.",
            "nullable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that's part of the part list for the asset. Asset Item can't be part of the part list for the same asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ListComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parts list item that the asset references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.",
            "nullable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.",
            "nullable":true
        },
        "SecondaryUOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Secondary UOM Name on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":true
        }
    }
}

Nested Schema : installedBaseAssets-relationships-item-patch-request

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.
• AssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the child asset in the structure. This attribute is read-only.
• RelationshipId: integer (int64)
  Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the child asset in the structure. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : installedBaseAssets-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Asset End Date

  Date when the asset becomes inactive. For maintenance assets, the asset active end date must be a future date. For customer assets, the asset active end date must be a past date and not earlier than the customer active start date. When the asset end date is populated, the other asset attributes can't be updated.
• Address1: string
  Title: Address 1

  First line of the address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Address2: string
  Title: Address 2

  Second line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Address3: string
  Title: Address 3

  Third line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• Address4: string
  Title: Address 4

  Fourth line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• assetDFF: array assetDFF
• AssetId: integer (int64)
  Title: Asset ID

  Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.
• assetImageAttachments: array Image Attachments
  Title: Image Attachments

  Attachment management capabilities: view, create, and update.
• AssetItemUpdateAllowedFlag: boolean
  Title: IoT Enabled

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the asset item can be updated. If false, then the asset item can't be updated. The default value is false.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 80

  Value that uniquely identifies the asset. This attribute is optional. If you don't provide a value, the application uses the asset identifier.
• assetQualifications: array Asset Qualifications
  Title: Asset Qualifications

  The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.
• attachments: array Image Attachments
  Title: Image Attachments

  Attachment management capabilities: view, create, and update.
• BOMExplosionFlag: boolean
  Title: Show logical assets

  Contains one of the following values: true or false. If true, then create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. If false, then don't create child assets from the primary bill of material. The default value is false.
• charges: array Charges
  Title: Charges

  The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.
• City: string
  Title: City

  City of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• CompetitorAssetFlag: boolean
  Title: Competitor asset

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the asset represents a competitor asset. if false, then the asset doesn't represents a competitor asset. The default value is false.
• ContactId: integer (int64)
  Title: Contact ID

  Value that uniquely identifies the asset contact. You must provide either the contact identifier or the contact number or the contact name to associate a contact to the asset. This attribute is optional and updatable. The contact identifier corresponds to the party identifier in the customer data model where the asset contact is defined as person-type party.
• ContactName: string
  Title: Contact

  Maximum Length: 255

  Name of the contact person of the asset. This attribute is same as the party name in the customer data model where the party type is PERSON. The contact name is the concatenation of first name, middle name, last name, and the suffix. The contact name isn't unique. You can use contact identifier, contact number, or contact name to create or update the asset contact.
• ContactNumber: string
  Title: Phone

  Maximum Length: 255

  Number that uniquely identifies the contact person of the asset. This attribute is same as the party number in the customer data model where the party type is PERSON. For enterprise assets, the contact person would be the employee identified with usage as HR Employee. For customer assets, the contact person would be a contact with usage as customer contact. You can use contact identifier, contact number, or contact name to create or update the asset contact.
• Country: string
  Title: Country

  Country of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• CountryOfOriginCode: string
  Read Only: true

  Maximum Length: 2

  This value uniquely identifies the country of manufacture used to track inventory transactions.
• CountryOfOriginName: string
  Title: Country of Origin

  Read Only: true

  Maximum Length: 255

  Name of the country of manufacture used to track inventory transactions.
• County: string
  Title: County

  County of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the asset is created. This date can be set to a specific value during creation but can't be updated afterward. By default, it's set to the system date.
• CurrentLocationContext: string
  Title: Location Type

  Read Only: true

  Maximum Length: 80

  Description of the location context where the asset currently resides. This attribute is read-only.
• CurrentLocationContextCode: string
  Title: Location Type

  Maximum Length: 80

  Abbreviation that uniquely identifies the location context where the asset currently resides. A list of accepted values is defined in the lookup type ORA_CSE_CURRENT_LOC_CONTEXT. This attribute is required to create the asset.
• CurrentLocationId: integer (int64)
  Title: Location ID

  Value that uniquely identifies the location where the asset currently resides. You can provide the value for this attribute when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION or ORA_INTERNAL_LOCATION.
• CurrentLocationName: string
  Title: Location Name

  Read Only: true

  Maximum Length: 255

  Name of the location where the asset currently resides. This attribute is read-only.
• CurrentLocationNameFormatted: string
  Read Only: true

  Maximum Length: 255

  Formatted location name where the asset currently resides. This attribute is read-only.
• CustomerAccountId: integer (int64)
  Title: Bill-to Account Number

  Value that uniquely identifies the customer account to which the asset is billed.
• CustomerAccountName: string
  Title: Customer Account Name

  Read Only: true

  Maximum Length: 240

  Name of the customer account to which the asset is billed. This attribute is read-only.
• CustomerAccountNumber: string
  Title: Customer Account

  Maximum Length: 255

  Number that uniquely identifies the customer account to which the asset is billed. This attribute is read-only.
• CustomerAccountSiteId: integer (int64)
  Title: Customer Account Site ID

  Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account.
• CustomerAccountSiteName: string
  Title: Customer Account Site Name

  Read Only: true

  Maximum Length: 240

  Site name of the customer account for the asset. This attribute is read-only.
• CustomerAccountSiteNumber: string
  Title: Account Site

  Maximum Length: 255

  Number that identifies the site of the customer account for the asset. This attribute is read-only.
• CustomerAccountSiteUseCode: string
  Title: Customer Account Site Use Code

  Maximum Length: 255

  Abbreviation that identifies the usage of the customer account site for the asset. This attribute is read-only.
• CustomerAccountSiteUseId: integer (int64)
  Title: Customer Account Site Use ID

  Value that uniquely identifies the usage of the customer account site for the asset. This attribute must be part of the customer account site.
• CustomerAssetEndDate: string (date-time)
  Title: Customer Asset End Date

  Date and time when the customer asset becomes inactive. If this attribute contains a value, then you can't update other asset attributes.
• CustomerAssetStartDate: string (date-time)
  Title: Customer Asset Start Date

  Date and time when the customer asset becomes active. The application uses the shipment date to determine the value for this attribute. This attribute is read-only.
• CustomerBillingPartyId: integer (int64)
  Title: Bill-to Customer

  Value that uniquely identifies the customer party that the application bills for the asset. This attribute is read-only.
• CustomerBillingPartySiteId: integer (int64)
  Title: Bill-to Site Number

  Value that uniquely identifies the billing party site for the customer. This attribute is read-only.
• CustomerId: integer (int64)
  Title: Customer ID

  Value that uniquely identifies the customer party who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.
• CustomerName: string
  Title: Customer

  Name of the customer who currently owns or uses the asset. This attribute is read-only.
• CustomerNumber: string
  Title: Customer Number

  Number that uniquely identifies the customer who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.
• CustomerPartyType: string
  Title: Customer Party Type

  Maximum Length: 30

  Value that identifies the party type of the customer of the asset. The Customer can be of either Organization party or Person party.
• CustomerSiteId: integer (int64)
  Title: Customer Site ID

  Value that uniquely identifies the customer site where the asset currently resides. You can provide this attribute when the value for CurrentLocationContextCode is ORA_CUSTOMER.
• CustomerSiteName: string
  Title: Customer Site

  Read Only: true

  Maximum Length: 240

  Name of the customer site where the asset currently resides. This attribute is read-only.
• CustomerSiteNumber: string
  Title: Customer Site Number

  Maximum Length: 255

  Default Value: CustomerSiteNumberNU

  Value that uniquely identifies the customer site where the asset currently resides. This attribute is read-only.
• CustomerSitePartyId: integer (int64)
  Title: Customer Site Party ID

  Value that uniquely identifies the customer site party where the asset is located.
• CustomerSitePartyName: string
  Title: Customer Site Party Name

  Read Only: true

  Maximum Length: 360

  Name of the customer party site where the asset is located. This attribute is read-only.
• CustomerSitePartyNumber: string
  Title: Customer Site Party Number

  Maximum Length: 255

  Number that uniquely identifies the customer site party where the asset is located. This attribute is read-only.
• Description: string
  Title: Asset Description

  Maximum Length: 240

  Description of an asset. You can use this attribute to describe the asset features, characteristics, and so on.
• DfltWoSubTypeCode: string
  Title: Default Maintenance Work Order Subtype

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order subtype. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. The application uses this attribute to set the work order subtype when it creates a work order for the asset.
• DfltWoSubTypeMeaning: string
  Title: Default Work Order Subtype

  Read Only: true

  Maximum Length: 255

  Description of the work order subtype.
• DfltWoTypeCode: string
  Title: Default Maintenance Work Order Type

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order type. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The application uses this attribute to set the work order type when it creates a work order for the asset.
• DfltWoTypeMeaning: string
  Title: Default Work Order Type

  Read Only: true

  Maximum Length: 255

  Description of the work order type.
• fixedAssetAssociations: array Fixed Asset Associations
  Title: Fixed Asset Associations

  The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.
• FulfillLineId: integer (int64)
  Title: Line

  Value that uniquely identifies the distributed order orchestration fulfillment line reference. This attribute is read-only.
• InServiceDate: string (date)
  Title: Date in Service

  Date and time when the organization put the asset in service. The in-service date must occur after the installed date.
• InstalledDate: string (date)
  Title: Installed Date

  Date and time when the organization installed the asset. The installed date must occur after the shipment date and before the in-service date.
• IotEnabledFlag: boolean
  Title: IoT Enabled

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then synchronize the asset with the application that controls the lot. If false, then don't synchronize. The default value is true. The response payload translates Y to true and N to false.
• ItemCustomerSelfServiceFlag: boolean
  Title: Item Enabled for Customer Self-Service

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the item is enabled for use on the customer self-service application. If false, then the item isn't enabled. The default value is false.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item. This attribute is read-only.
• ItemId: integer (int64)
  Title: Item ID

  Value that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.
• ItemLongDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  Long description of the item. This attribute is read-only.
• ItemNumber: string
  Title: Item

  Number that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.
• ItemRequiredFlag: boolean
  Title: Item Required

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the item is required to create an asset. If false, then the item isn't required to create an asset. The default value is false.
• ItemRevision: string
  Title: Item Revision

  Maximum Length: 18

  Number that identifies the item revision that the asset references.
• ItemServiceRequestEnabledCode: string
  Title: Item Enabled for a Service Request

  Read Only: true

  Maximum Length: 30

  Abbreviation that indicates whether a service request can be created for the item. This attribute is read-only.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the asset was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationOrganizationCode: string
  Title: Location Organization Code

  Maximum Length: 255

  Abbreviation that uniquely identifies the organization where the asset currently resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.
• LocationOrganizationId: integer (int64)
  Title: Location Organization ID

  Value that uniquely identifies the organization where the asset currently resides. You can provide the location organization if the value of CurrentLocationContextCode is ORA_WORK CENTER.
• LocatorId: integer (int64)
  Title: Locator ID

  Read Only: true

  Value that uniquely identifies the locator where the asset resides. This attribute is read-only.
• LocatorName: string
  Title: Locator

  Read Only: true

  Maximum Length: 255

  Name of the locator where the asset resides. This attribute is read-only.
• LotNumber: string
  Title: Lot Number

  Maximum Length: 80

  Number that uniquely identifying the lot that the asset references to control the item in inventory. This attribute is applicable when the item is lot controlled. If the lot number doesn't exist in the inventory, then the application creates a lot in the inventory application.
• MaintainableFlag: boolean
  Title: Allow maintenance programs

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then enable the asset for a maintenance activity such as a maintenance program or maintenance work order. If false, then don't enable. The default value is true for maintainable items.
• ManageAssetPrivilege: string
  Title: Manage Asset Privilege

  Contains one of the following values. C: Customer asset responsibility. M : Enterprise asset responsibility. MC: Superuser responsibility.
• meters: array Meters
  Title: Meters

  Details of the meters associated with an asset.
• NewWoAllowedFlag: boolean
  Title: Allow work orders

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the application to create a work order for the asset. If false, then don't allow. The default value is true for maintainable items.
• notes: array Notes
  Title: Notes

  The note objects resource is used to view the note objects.
• OperatingOrganizationCode: string
  Title: Operating Organization

  Abbreviation that uniquely identifies the organization that creates or operates the asset. You need the organization code to create an enterprise asset for a customer asset. If the organization isn't provided, the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.
• OperatingOrganizationId: integer (int64)
  Title: Operating Organization ID

  Value that uniquely identifies the organization that creates or operates the asset. You need the organization identifier to create an enterprise asset for a customer asset. If the organization isn't provided the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.
• OperatingOrganizationName: string
  Read Only: true

  Maximum Length: 255

  Name of the organization that creates or operates the asset. This attribute is read-only.
• ParentAssetId: integer
  Title: Parent Asset ID

  Value that uniquely identifies the parent asset number to which the imported asset needs to be added.
• ParentAssetNumber: string
  Title: Parent Asset

  Read Only: true

  Maximum Length: 255

  Indicates the relationship between the parent asset and its child asset.
• partsListComponents: array Parts
  Title: Parts

  The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.
• PostalCode: string
  Title: Postal Code

  Abbreviation that identifies the postal area where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• ProjectId: integer (int64)
  Read Only: true

  Value uniquely identifies the assigned project.
• ProjectNumber: string
  Title: Project

  Read Only: true

  Maximum Length: 255

  This value indicates the assigned project number.
• Province: string
  Title: Province

  Province where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• PurchaseDate: string (date)
  Title: Customer Purchase Date

  Date and time when the customer purchased the asset. If you provide the registration date, then you must provide the purchase date. The purchased date must occur before the registration date.
• Quantity: number
  Title: Quantity

  Quantity for the item that the asset references. If the item is serial controlled, then the quantity can't exceed one. This attribute is required to create the asset.
• RegistrationDate: string (date)
  Title: Registration Date

  Date and time when the customer registered the asset.
• relationships: array Relationships
  Title: Relationships

  The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.
• ReturnOrderFulfillLineId: integer (int64)
  Value that unique identify the Return Order Fulfill Line Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.
• ReturnOrderId: integer (int64)
  Value the unique identify the Return Order Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.
• ReturnOrderLineId: integer (int64)
  Value that unique identify the Return Order Line Identifier. This attribute is read-only and it's a system generated number when return sales order is created.
• ReturnOrderNumber: string
  Maximum Length: 255

  Reference the unique identifier the Number of the Return Sales Order Number. This attribute is read-only and it's a system generated number when return sales order is created.
• ReturnSourceOrderNumber: string
  Maximum Length: 255

  Reference the unique identifier the Number of the Return Source Sales Order Number. This is a read-only and it's a system generated number when return sales order is created.
• SalesOrderId: integer (int64)
  Title: Sales Order ID

  Value that uniquely identifies the sales order that's used to order the asset.
• SalesOrderLineId: integer (int64)
  Title: Sales Order Line ID

  Value that uniquely identifies the line of the sales order that's used to order the asset.
• SalesOrderLineNumber: string
  Title: Sales Order Line Number

  Maximum Length: 120

  Number that uniquely identifies the line of the sales order that's used to order the asset.
• SalesOrderNumber: string
  Title: Sales Order Number

  Maximum Length: 120

  Number that identifies the sales order that's used to order the asset.
• SalesOrderSourceSystem: string
  Title: Sales Order Source System

  Maximum Length: 30

  Name of the source application where the sales order originated. If SalesOrderSourceSystemType is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of the source application that isn't an Oracle Fusion application. If SalesOrderSourceSystemType is ORA_INTERNAL, then SalesOrderSourceSystem identifies the Oracle Fusion application.
• SalesOrderSourceSystemType: string
  Title: Sales Order Source System Type

  Maximum Length: 30

  Description of the type of source application. This attribute is read-only.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 255

  Indicates the unit of measure code for the secondary quantity.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. This attribute is used when item is serial controlled. If the serial number doesn't exist in the inventory, then the application creates a serial in the inventory application.
• ShipmentDate: string (date-time)
  Title: Shipment Date

  Date when the asset is shipped to the customer. This attribute is optional. If you don't provide a value, the application uses the application date.
• SoldByBusinessUnitId: integer (int64)
  Title: Selling Business Unit ID

  Value that uniquely identifies the business unit that sold the asset. This attribute is optional.
• SoldByBusinessUnitName: string
  Title: Selling Business Unit

  Maximum Length: 255

  Name of the business unit that sold the asset. This attribute is read-only.
• SplitFromAssetId: integer (int64)
  Title: Split from Asset ID

  Value that uniquely identifies the split from asset reference. For nonserial assets, when assets are split during partial return, the new asset created with the remaining quantity will have this split from asset reference.
• State: string
  Title: State

  State where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.
• StructureActionCode: string
  Title: Structure Action Code

  Abbreviation that uniquely identifies the import action to be performed on the asset relationship. Valid values are ORA_ADD or ORA_REMOVE. ORA_ADD: Add the imported asset to a parent asset. ORA_REMOVE: Remove the asset from its parent asset. A list of accepted values is defined in the lookup type ORA_CSE_ASSET_IMP_CONF_ACTION.
• SubinventoryCode: string
  Title: Subinventory

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the subinventory where the asset resides. This attribute is read-only.
• SubinventoryName: string
  Title: Subinventory Name

  Read Only: true

  Maximum Length: 30

  Name of the subinventory where the asset is stored.
• TaskId: integer (int64)
  Read Only: true

  Value uniquely identifies the assigned project task.
• TaskNumber: string
  Title: Task

  Read Only: true

  Maximum Length: 255

  This value indicates the assigned project task number.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Meaning of the unit of measure.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  Abbreviation that uniquely identifies the unit of measure for the asset quantity. It must use the same unit of measure that the item uses as the primary unit of measure. If this attribute is empty, then the application sets the value to the item primary unit of measure.
• UpdateContractFlag: boolean
  Title: Update Contract

  Contains one of the following values: true or false. If true, then the application interfaces the asset change to the enterprise contract application. If false, then the asset change isn't interfaced to enterprise contract application. The default value is true. This attribute is used when you import the asset and the contract through enterprise contract. Set this attribute to false only if you're certain that the application must handle each contract update separately, or if the update doesn't apply in the context.
• WorkAreaName: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the work area where the asset resides.
• WorkCenterCode: string
  Title: Work Center Code

  Maximum Length: 255

  Abbreviation that identifies the work center where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.
• WorkCenterId: integer (int64)
  Title: Work Center ID

  Value that uniquely identifies the work center where the asset currently resides. You can provide the work center when the value of CurrentLocationContextCode is ORA_WORK CENTER.
• WorkCenterName: string
  Title: Work Center

  Read Only: true

  Maximum Length: 120

  Name of the work center where the asset currently resides. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Asset End Date",
            "type":"string",
            "description":"Date when the asset becomes inactive. For maintenance assets, the asset active end date must be a future date. For customer assets, the asset active end date must be a past date and not earlier than the customer active start date. When the asset end date is populated, the other asset attributes can't be updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address 1",
            "type":"string",
            "description":"First line of the address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address 2",
            "type":"string",
            "description":"Second line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address 3",
            "type":"string",
            "description":"Third line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address 4",
            "type":"string",
            "description":"Fourth line of the external address where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssetItemUpdateAllowedFlag":{
            "title":"IoT Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the asset item can be updated. If false, then the asset item can't be updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the asset. This attribute is optional. If you don't provide a value, the application uses the asset identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "BOMExplosionFlag":{
            "title":"Show logical assets",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. If false, then don't create child assets from the primary bill of material. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "type":"string",
            "description":"City of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "CompetitorAssetFlag":{
            "title":"Competitor asset",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the asset represents a competitor asset. if false, then the asset doesn't represents a competitor asset. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset contact. You must provide either the contact identifier or the contact number or the contact name to associate a contact to the asset. This attribute is optional and updatable. The contact identifier corresponds to the party identifier in the customer data model where the asset contact is defined as person-type party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactName":{
            "title":"Contact",
            "maxLength":255,
            "type":"string",
            "description":"Name of the contact person of the asset. This attribute is same as the party name in the customer data model where the party type is PERSON. The contact name is the concatenation of first name, middle name, last name, and the suffix. The contact name isn't unique. You can use contact identifier, contact number, or contact name to create or update the asset contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Phone",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the contact person of the asset. This attribute is same as the party number in the customer data model where the party type is PERSON. For enterprise assets, the contact person would be the employee identified with usage as HR Employee. For customer assets, the contact person would be a contact with usage as customer contact. You can use contact identifier, contact number, or contact name to create or update the asset contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "type":"string",
            "description":"Country of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryOfOriginCode":{
            "maxLength":2,
            "type":"string",
            "description":"This value uniquely identifies the country of manufacture used to track inventory transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryOfOriginName":{
            "title":"Country of Origin",
            "maxLength":255,
            "type":"string",
            "description":"Name of the country of manufacture used to track inventory transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "County":{
            "title":"County",
            "type":"string",
            "description":"County of the external address where the asset is located. You can provide a value for this attribute when CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the asset is created. This date can be set to a specific value during creation but can't be updated afterward. By default, it's set to the system date.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentLocationContext":{
            "title":"Location Type",
            "maxLength":80,
            "type":"string",
            "description":"Description of the location context where the asset currently resides. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentLocationContextCode":{
            "title":"Location Type",
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the location context where the asset currently resides. A list of accepted values is defined in the lookup type ORA_CSE_CURRENT_LOC_CONTEXT. This attribute is required to create the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrentLocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the location where the asset currently resides. You can provide the value for this attribute when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION or ORA_INTERNAL_LOCATION.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentLocationName":{
            "title":"Location Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the location where the asset currently resides. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentLocationNameFormatted":{
            "maxLength":255,
            "type":"string",
            "description":"Formatted location name where the asset currently resides. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CurrentLocationContextCode",
                    "CurrentLocationId"
                ]
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Bill-to Account Number",
            "type":"integer",
            "description":"Value that uniquely identifies the customer account to which the asset is billed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountName":{
            "title":"Customer Account Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer account to which the asset is billed. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "title":"Customer Account",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the customer account to which the asset is billed. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountSiteId":{
            "title":"Customer Account Site ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer account site for the asset. This site must be part of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAccountSiteName":{
            "title":"Customer Account Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Site name of the customer account for the asset. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountSiteNumber":{
            "title":"Account Site",
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the site of the customer account for the asset. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountSiteUseCode":{
            "title":"Customer Account Site Use Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the usage of the customer account site for the asset. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountSiteUseId":{
            "title":"Customer Account Site Use ID",
            "type":"integer",
            "description":"Value that uniquely identifies the usage of the customer account site for the asset. This attribute must be part of the customer account site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerAssetEndDate":{
            "title":"Customer Asset End Date",
            "type":"string",
            "description":"Date and time when the customer asset becomes inactive. If this attribute contains a value, then you can't update other asset attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAssetStartDate":{
            "title":"Customer Asset Start Date",
            "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
        },
        "CustomerBillingPartyId":{
            "title":"Bill-to Customer",
            "type":"integer",
            "description":"Value that uniquely identifies the customer party that the application bills for the asset. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerBillingPartySiteId":{
            "title":"Bill-to Site Number",
            "type":"integer",
            "description":"Value that uniquely identifies the billing party site for the customer. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer party who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Customer",
            "type":"string",
            "description":"Name of the customer who currently owns or uses the asset. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Number",
            "type":"string",
            "description":"Number that uniquely identifies the customer who currently owns or uses the asset. You need a customer to create a customer asset. You can provide values for either CustomerId or CustomerNumber.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPartyType":{
            "title":"Customer Party Type",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the party type of the customer of the asset. The Customer can be of either Organization party or Person party.",
            "nullable":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "CustomerSiteId":{
            "title":"Customer Site ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. You can provide this attribute when the value for CurrentLocationContextCode is ORA_CUSTOMER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSiteName":{
            "title":"Customer Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the customer site where the asset currently resides. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "title":"Customer Site Number",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. This attribute is read-only.",
            "nullable":true,
            "default":"CustomerSiteNumberNU",
            "x-queryable":true
        },
        "CustomerSitePartyId":{
            "title":"Customer Site Party ID",
            "type":"integer",
            "description":"Value that uniquely identifies the customer site party where the asset is located.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSitePartyName":{
            "title":"Customer Site Party Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer party site where the asset is located. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSitePartyNumber":{
            "title":"Customer Site Party Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the customer site party where the asset is located. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Asset Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of an asset. You can use this attribute to describe the asset features, characteristics, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "DfltWoSubTypeCode":{
            "title":"Default Maintenance Work Order Subtype",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order subtype. A list of accepted values is defined in the lookup type ORA_MNT_WO_SUB_TYPE. The application uses this attribute to set the work order subtype when it creates a work order for the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "DfltWoSubTypeMeaning":{
            "title":"Default Work Order Subtype",
            "maxLength":255,
            "type":"string",
            "description":"Description of the work order subtype.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DfltWoTypeCode":{
            "title":"Default Maintenance Work Order Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. A list of accepted values is defined in the lookup type ORA_MNT_WO_TYPE. The application uses this attribute to set the work order type when it creates a work order for the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "DfltWoTypeMeaning":{
            "title":"Default Work Order Type",
            "maxLength":255,
            "type":"string",
            "description":"Description of the work order type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FulfillLineId":{
            "title":"Line",
            "type":"integer",
            "description":"Value that uniquely identifies the distributed order orchestration fulfillment line reference. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InServiceDate":{
            "title":"Date in Service",
            "type":"string",
            "description":"Date and time when the organization put the asset in service. The in-service date must occur after the installed date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InstalledDate":{
            "title":"Installed Date",
            "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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IotEnabledFlag":{
            "title":"IoT Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then synchronize the asset with the application that controls the lot. If false, then don't synchronize. The default value is true. The response payload translates Y to true and N to false.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCustomerSelfServiceFlag":{
            "title":"Item Enabled for Customer Self-Service",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is enabled for use on the customer self-service application. If false, then the item isn't enabled. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemLongDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"Long description of the item. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "type":"string",
            "description":"Number that uniquely identifies the item that the asset references. You need an item to create an asset when ItemRequiredCheckbox is true. You can provide values for either itemId or ItemNumber. For customer assets, the item associated with the asset must have the value of Enable Asset Tracking set to Customer Asset or Full Lifecycle. For enterprise assets, the item must have the value of Enable Asset Tracking set to Full Lifecycle.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemRequiredFlag":{
            "title":"Item Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item is required to create an asset. If false, then the item isn't required to create an asset. The default value is false.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ItemRevision":{
            "title":"Item Revision",
            "maxLength":18,
            "type":"string",
            "description":"Number that identifies the item revision that the asset references.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemServiceRequestEnabledCode":{
            "title":"Item Enabled for a Service Request",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates whether a service request can be created for the item. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the asset was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationOrganizationCode":{
            "title":"Location Organization Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization where the asset currently resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationOrganizationId":{
            "title":"Location Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the asset currently resides. You can provide the location organization if the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorId":{
            "title":"Locator ID",
            "type":"integer",
            "description":"Value that uniquely identifies the locator where the asset resides. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorName":{
            "title":"Locator",
            "maxLength":255,
            "type":"string",
            "description":"Name of the locator where the asset resides. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifying the lot that the asset references to control the item in inventory. This attribute is applicable when the item is lot controlled. If the lot number doesn't exist in the inventory, then the application creates a lot in the inventory application.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintainableFlag":{
            "title":"Allow maintenance programs",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then enable the asset for a maintenance activity such as a maintenance program or maintenance work order. If false, then don't enable. The default value is true for maintainable items.",
            "nullable":false,
            "x-queryable":true
        },
        "ManageAssetPrivilege":{
            "title":"Manage Asset Privilege",
            "type":"string",
            "description":"Contains one of the following values. C: Customer asset responsibility. M : Enterprise asset responsibility. MC: Superuser responsibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NewWoAllowedFlag":{
            "title":"Allow work orders",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the application to create a work order for the asset. If false, then don't allow. The default value is true for maintainable items.",
            "nullable":false,
            "x-queryable":true
        },
        "OperatingOrganizationCode":{
            "title":"Operating Organization",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization that creates or operates the asset. You need the organization code to create an enterprise asset for a customer asset. If the organization isn't provided, the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.",
            "nullable":true,
            "x-queryable":true
        },
        "OperatingOrganizationId":{
            "title":"Operating Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or operates the asset. You need the organization identifier to create an enterprise asset for a customer asset. If the organization isn't provided the application uses the item master organization. You can provide values for either OperatingOrganizationId or OperatingOrganizationCode.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperatingOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization that creates or operates the asset. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAssetId":{
            "title":"Parent Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the parent asset number to which the imported asset needs to be added.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentAssetNumber":{
            "title":"Parent Asset",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the relationship between the parent asset and its child asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PostalCode":{
            "title":"Postal Code",
            "type":"string",
            "description":"Abbreviation that identifies the postal area where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Value uniquely identifies the assigned project.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project",
            "maxLength":255,
            "type":"string",
            "description":"This value indicates the assigned project number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "type":"string",
            "description":"Province where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchaseDate":{
            "title":"Customer Purchase Date",
            "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
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for the item that the asset references. If the item is serial controlled, then the quantity can't exceed one. This attribute is required to create the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "RegistrationDate":{
            "title":"Registration Date",
            "type":"string",
            "description":"Date and time when the customer registered the asset.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnOrderFulfillLineId":{
            "type":"integer",
            "description":"Value that unique identify the Return Order Fulfill Line Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnOrderId":{
            "type":"integer",
            "description":"Value the unique identify the Return Order Identifier. This Attribute is read-only and it's a system generated number when return sales order is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnOrderLineId":{
            "type":"integer",
            "description":"Value that unique identify the Return Order Line Identifier. This attribute is read-only and it's a system generated number when return sales order is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReturnOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Reference the unique identifier the Number of the Return Sales Order Number. This attribute is read-only and it's a system generated number when return sales order is created.",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnSourceOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Reference the unique identifier the Number of the Return Source Sales Order Number. This is a read-only and it's a system generated number when return sales order is created.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderId":{
            "title":"Sales Order ID",
            "type":"integer",
            "description":"Value that uniquely identifies the sales order that's used to order the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "title":"Sales Order Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the line of the sales order that's used to order the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineNumber":{
            "title":"Sales Order Line Number",
            "maxLength":120,
            "type":"string",
            "description":"Number that uniquely identifies the line of the sales order that's used to order the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderNumber":{
            "title":"Sales Order Number",
            "maxLength":120,
            "type":"string",
            "description":"Number that identifies the sales order that's used to order the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderSourceSystem":{
            "title":"Sales Order Source System",
            "maxLength":30,
            "type":"string",
            "description":"Name of the source application where the sales order originated. If SalesOrderSourceSystemType is ORA_EXTERNAL, then SalesOrderSourceSystem contains the name of the source application that isn't an Oracle Fusion application. If SalesOrderSourceSystemType is ORA_INTERNAL, then SalesOrderSourceSystem identifies the Oracle Fusion application.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesOrderSourceSystemType":{
            "title":"Sales Order Source System Type",
            "maxLength":30,
            "type":"string",
            "description":"Description of the type of source application. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the unit of measure code for the secondary quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. This attribute is used when item is serial controlled. If the serial number doesn't exist in the inventory, then the application creates a serial in the inventory application.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentDate":{
            "title":"Shipment Date",
            "type":"string",
            "description":"Date when the asset is shipped to the customer. This attribute is optional. If you don't provide a value, the application uses the application date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SoldByBusinessUnitId":{
            "title":"Selling Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that sold the asset. This attribute is optional.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SoldByBusinessUnitName":{
            "title":"Selling Business Unit",
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit that sold the asset. This attribute is read-only.",
            "nullable":true,
            "x-queryable":true
        },
        "SplitFromAssetId":{
            "title":"Split from Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the split from asset reference. For nonserial assets, when assets are split during partial return, the new asset created with the remaining quantity will have this split from asset reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "type":"string",
            "description":"State where the asset is located. You can add the components of the address when the value of CurrentLocationContextCode is ORA_EXTERNAL_LOCATION.",
            "nullable":true,
            "x-queryable":true
        },
        "StructureActionCode":{
            "title":"Structure Action Code",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the import action to be performed on the asset relationship. Valid values are ORA_ADD or ORA_REMOVE. ORA_ADD: Add the imported asset to a parent asset. ORA_REMOVE: Remove the asset from its parent asset. A list of accepted values is defined in the lookup type ORA_CSE_ASSET_IMP_CONF_ACTION.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "title":"Subinventory",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the subinventory where the asset resides. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "SubinventoryName":{
            "title":"Subinventory Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the subinventory where the asset is stored.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"Value uniquely identifies the assigned project task.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task",
            "maxLength":255,
            "type":"string",
            "description":"This value indicates the assigned project task number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the unit of measure for the asset quantity. It must use the same unit of measure that the item uses as the primary unit of measure. If this attribute is empty, then the application sets the value to the item primary unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Meaning of the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "UpdateContractFlag":{
            "title":"Update Contract",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application interfaces the asset change to the enterprise contract application. If false, then the asset change isn't interfaced to enterprise contract application. The default value is true. This attribute is used when you import the asset and the contract through enterprise contract. Set this attribute to false only if you're certain that the application must handle each contract update separately, or if the update doesn't apply in the context.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkAreaName":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the work area where the asset resides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "title":"Work Center Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the work center where the asset resides. You can add the components of the address when the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center ID",
            "type":"integer",
            "description":"Value that uniquely identifies the work center where the asset currently resides. You can provide the work center when the value of CurrentLocationContextCode is ORA_WORK CENTER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkCenterName":{
            "title":"Work Center",
            "maxLength":120,
            "type":"string",
            "description":"Name of the work center where the asset currently resides. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "assetDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "assetImageAttachments":{
            "title":"Image Attachments",
            "type":"array",
            "description":"Attachment management capabilities: view, create, and update.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetImageAttachments-item-response"
            }
        },
        "assetQualifications":{
            "title":"Asset Qualifications",
            "type":"array",
            "description":"The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-item-response"
            }
        },
        "attachments":{
            "title":"Image Attachments",
            "type":"array",
            "description":"Attachment management capabilities: view, create, and update.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-attachments-item-response"
            }
        },
        "charges":{
            "title":"Charges",
            "type":"array",
            "description":"The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-charges-item-response"
            }
        },
        "fixedAssetAssociations":{
            "title":"Fixed Asset Associations",
            "type":"array",
            "description":"The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-fixedAssetAssociations-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "meters":{
            "title":"Meters",
            "type":"array",
            "description":"Details of the meters associated with an asset.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-meters-item-response"
            }
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The note objects resource is used to view the note objects.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-notes-item-response"
            }
        },
        "partsListComponents":{
            "title":"Parts",
            "type":"array",
            "description":"The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-partsListComponents-item-response"
            }
        },
        "relationships":{
            "title":"Relationships",
            "type":"array",
            "description":"The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-relationships-item-response"
            }
        }
    }
}

Nested Schema : assetDFF

Type: array

Show Source

• Array of: object installedBaseAssets-assetDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Image Attachments

Type: array

Title: Image Attachments

Attachment management capabilities: view, create, and update.

Show Source

• Array of: object installedBaseAssets-assetImageAttachments-item-response

{
    "title":"Image Attachments",
    "type":"array",
    "description":"Attachment management capabilities: view, create, and update.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetImageAttachments-item-response"
    }
}

Nested Schema : Asset Qualifications

Type: array

Title: Asset Qualifications

The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.

Show Source

• Array of: object installedBaseAssets-assetQualifications-item-response

{
    "title":"Asset Qualifications",
    "type":"array",
    "description":"The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-item-response"
    }
}

Nested Schema : Image Attachments

Type: array

Title: Image Attachments

Attachment management capabilities: view, create, and update.

Show Source

• Array of: object installedBaseAssets-attachments-item-response

{
    "title":"Image Attachments",
    "type":"array",
    "description":"Attachment management capabilities: view, create, and update.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-attachments-item-response"
    }
}

Nested Schema : Charges

Type: array

Title: Charges

The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.

Show Source

• Array of: object installedBaseAssets-charges-item-response

{
    "title":"Charges",
    "type":"array",
    "description":"The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-charges-item-response"
    }
}

Nested Schema : Fixed Asset Associations

Type: array

Title: Fixed Asset Associations

The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.

Show Source

• Array of: object installedBaseAssets-fixedAssetAssociations-item-response

{
    "title":"Fixed Asset Associations",
    "type":"array",
    "description":"The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-fixedAssetAssociations-item-response"
    }
}

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 : Meters

Type: array

Title: Meters

Details of the meters associated with an asset.

Show Source

• Array of: object installedBaseAssets-meters-item-response

{
    "title":"Meters",
    "type":"array",
    "description":"Details of the meters associated with an asset.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-meters-item-response"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note objects resource is used to view the note objects.

Show Source

• Array of: object installedBaseAssets-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The note objects resource is used to view the note objects.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-notes-item-response"
    }
}

Nested Schema : Parts

Type: array

Title: Parts

The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.

Show Source

• Array of: object installedBaseAssets-partsListComponents-item-response

{
    "title":"Parts",
    "type":"array",
    "description":"The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-partsListComponents-item-response"
    }
}

Nested Schema : Relationships

Type: array

Title: Relationships

The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.

Show Source

• Array of: object installedBaseAssets-relationships-item-response

{
    "title":"Relationships",
    "type":"array",
    "description":"The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-relationships-item-response"
    }
}

Nested Schema : installedBaseAssets-assetDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AssetId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-assetImageAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute used exclusively by Attachment UI components to assist with file uploads.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who added the asset image attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Indicates the source document ID for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Indicates the source folder path for the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the document used as the source for the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded representation of the file, rendered in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the asset image attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after the attachment is uploaded.
• PrimaryCategoryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Designates one of the attached images as the primary image, which will be displayed as the main visual.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute used exclusively by Attachment UI components to assist with file uploads.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who added the asset image attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the source document ID for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the source folder path for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document used as the source for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded representation of the file, rendered in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the asset image attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after the attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates one of the attached images as the primary image, which will be displayed as the main visual.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-assetQualifications-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies an asset. This attribute is read-only.
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies an asset. This attribute is read-only.
• AssetQualificationId: integer (int64)
  Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
• attachments: array Image Attachments
  Title: Image Attachments

  Attachment management capabilities: view, create, and update.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only.
• CreationDate: string (date-time)
  Read Only: true

  Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only.
• CurrentFlag: boolean
  Maximum Length: 1

  Default Value: false

  Value that identifies current asset qualification.
• DefaultIntervalUOMCode: string
  Read Only: true

  Maximum Length: 255

  Meaning of the UOM code of the default interval for qualification requirement.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the asset. You can use this attribute to describe the asset features, characteristics, and so on.
• DfltQualInterval: number
  Title: Default Interval

  Read Only: true

  Default interval for the qualification requirement.
• EqpQualRequirementDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the qualification requirement.
• InspectionEventDisposition: string
  Read Only: true

  Maximum Length: 255

  Meaning of the inspection event disposition code associated with the equipment qualification.
• InspectionEventDispositionCode: string
  Read Only: true

  Maximum Length: 255

  Code of the inspection event disposition code associated with the equipment qualification.
• InspectionPlanId: integer (int64)
  Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.
• InspectionPlanName: string
  Read Only: true

  Maximum Length: 255

  Name of the inspection plan that was associated while performing the asset qualification.
• InspectionStatus: string
  Read Only: true

  Maximum Length: 255

  Status of the inspection plan that's associated to the asset qualification.
• IntervalTypeCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 30

  Value of the qualification requirement interval type code.
• IpEventId: integer (int64)
  Unique identifier of the inspection event associated while performing the asset qualification.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation. This attribute is read-only.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Name of the maintenance program that was associated while performing the asset qualification.
• NextQualificationDate: string (date-time)
  Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.
• OperationName: string
  Read Only: true

  Maximum Length: 255

  Name of the work order operation for the work order that was associated while performing the asset qualification.
• OperationSequence: string
  Read Only: true

  Maximum Length: 255

  Work order operation sequence of the work order associated while performing the asset qualification.
• QualificationConfirmedFlag: boolean
  Read Only: true

  Status of confirmed qualification.
• QualificationProfile: string
  Read Only: true

  Maximum Length: 255

  Name of the qualification profile.
• QualificationProfileName: string
  Read Only: true

  Maximum Length: 255

  Display value of all the qualification profiles that are associated to the qualification requirement.
• QualificationRequirementCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.
• QualificationRequirementId: integer (int64)
  Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.
• QualificationRequirementName: string
  Maximum Length: 255

  Name of the qualification requirement. This is unique and required attribute to create an asset qualification.
• QualificationRequirementReference: string
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.
• QualificationRequirementType: string
  Read Only: true

  Maximum Length: 255

  Meaning of the qualification requirement type.
• QualifiedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the asset qualification. The application automatically sets this value during creation. This attribute is read-only.
• QualifiedByName: string
  Read Only: true

  Maximum Length: 255

  Name of the user performing the asset qualification.
• QualifiedDate: string (date-time)
  Date when the asset qualification is created. This date can be set to a required value during creation. Once created the value can't be updated. The default value is system date.
• RequirementTypeCode: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Value of the qualification requirement type code.
• ResourceId: integer
  Read Only: true

  Unique identifier of the equipment resource.
• ResourceInstance: string
  Read Only: true

  Maximum Length: 255

  Name of the resource instance.
• ResourceInstanceId: integer
  Read Only: true

  Unique identifier of the resource instance.
• ResourceName: string
  Read Only: true

  Maximum Length: 255

  Name of the equipment resource instance.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. This attribute is used when an item is serial controlled. If the serial number doesn't exist in the inventory, then the application creates a serial in the inventory application.
• WorkOrderId: integer (int64)
  Unique identifier of the work order associated while performing the asset qualification.
• WorkOrderNumber: string
  Read Only: true

  Maximum Length: 255

  Work order number of the work order associated while performing the asset qualification.
• WorkRequirementName: string
  Read Only: true

  Maximum Length: 255

  Name of the work requirement that was associated while performing the asset qualification.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies an asset. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies an asset. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetQualificationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the qualification requirement The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the qualification requirement is created. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that identifies current asset qualification.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DefaultIntervalUOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the UOM code of the default interval for qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the asset. You can use this attribute to describe the asset features, characteristics, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DfltQualInterval":{
            "title":"Default Interval",
            "type":"number",
            "description":"Default interval for the qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EqpQualRequirementDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionEventDisposition":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the inspection event disposition code associated with the equipment qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionEventDispositionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the inspection event disposition code associated with the equipment qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionPlanId":{
            "type":"integer",
            "description":"Value that Uniquely Identifies the inspection plan. Currently, this attribute isn't populated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InspectionPlanName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inspection plan that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the inspection plan that's associated to the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalTypeCode":{
            "title":"UOM",
            "maxLength":30,
            "type":"string",
            "description":"Value of the qualification requirement interval type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IpEventId":{
            "type":"integer",
            "description":"Unique identifier of the inspection event associated while performing the asset qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the qualification requirement. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the qualification requirement. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaintenanceProgramName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the maintenance program that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextQualificationDate":{
            "type":"string",
            "description":"Date when the asset qualification is next due. The value can be updated till the current value becomes past. The value is defaulted based on the default interval value in associated qualification requirement.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the work order operation for the work order that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequence":{
            "maxLength":255,
            "type":"string",
            "description":"Work order operation sequence of the work order associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationConfirmedFlag":{
            "type":"boolean",
            "description":"Status of confirmed qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationProfile":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualification profile.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationProfileName":{
            "maxLength":255,
            "type":"string",
            "description":"Display value of all the qualification profiles that are associated to the qualification requirement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationRequirementCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the qualification requirement . This attribute is required to create a qualification requirement.",
            "nullable":true,
            "x-queryable":true
        },
        "QualificationRequirementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the qualification requirement. The application creates this value when it creates the qualification requirement. This attribute is mandatory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QualificationRequirementName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the qualification requirement. This is unique and required attribute to create an asset qualification.",
            "nullable":true,
            "x-queryable":true
        },
        "QualificationRequirementReference":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the asset qualification. The application creates this value when it creates the asset qualification. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualificationRequirementType":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the qualification requirement type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifiedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the asset qualification. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifiedByName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualifiedDate":{
            "type":"string",
            "description":"Date when the asset qualification is created. This date can be set to a required value during creation. Once created the value can't be updated. The default value is system date.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "RequirementTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Value of the qualification requirement type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Unique identifier of the equipment resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstance":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceInstanceId":{
            "type":"integer",
            "description":"Unique identifier of the resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the equipment resource instance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. This attribute is used when an item is serial controlled. If the serial number doesn't exist in the inventory, then the application creates a serial in the inventory application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Unique identifier of the work order associated while performing the asset qualification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Work order number of the work order associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkRequirementName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the work requirement that was associated while performing the asset qualification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Image Attachments",
            "type":"array",
            "description":"Attachment management capabilities: view, create, and update.",
            "items":{
                "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Image Attachments

Type: array

Title: Image Attachments

Attachment management capabilities: view, create, and update.

Show Source

• Array of: object installedBaseAssets-assetQualifications-attachments-item-response

{
    "title":"Image Attachments",
    "type":"array",
    "description":"Attachment management capabilities: view, create, and update.",
    "items":{
        "$ref":"#/components/schemas/installedBaseAssets-assetQualifications-attachments-item-response"
    }
}

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 : installedBaseAssets-assetQualifications-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute used exclusively by Attachment UI components to assist with file uploads.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who added the asset image attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Indicates the source document ID for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Indicates the source folder path for the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the document used as the source for the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded representation of the file, rendered in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the asset image attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after the attachment is uploaded.
• PrimaryCategoryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Designates one of the attached images as the primary image, which will be displayed as the main visual.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute used exclusively by Attachment UI components to assist with file uploads.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who added the asset image attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the source document ID for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the source folder path for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document used as the source for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded representation of the file, rendered in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the asset image attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after the attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates one of the attached images as the primary image, which will be displayed as the main visual.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute used exclusively by Attachment UI components to assist with file uploads.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who added the asset image attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Indicates the source document ID for the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Indicates the source folder path for the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number of the document used as the source for the attachment.
• DocumentPreviewURL: string
  Read Only: true

  Maximum Length: 255

  Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded representation of the file, rendered in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the asset image attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after the attachment is uploaded.
• PrimaryCategoryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Designates one of the attached images as the primary image, which will be displayed as the main visual.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute used exclusively by Attachment UI components to assist with file uploads.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who added the asset image attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the source document ID for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Indicates the source folder path for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The version number of the document used as the source for the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentPreviewURL":{
            "maxLength":255,
            "type":"string",
            "description":"Document preview URL attribute on the attachments resource, which is part of the maintenance programs root resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded representation of the file, rendered in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the asset image attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after the attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PrimaryCategoryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates one of the attached images as the primary image, which will be displayed as the main visual.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-charges-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: true or false. If true, then the charge component represents the aggregated value of the rollup charge. If false, then the charge component doesn't represent this value. The default value is false.
• ChargeDefinitionCode: string
  Maximum Length: 30

  Abbreviation that identifies the definition for the pricing charge. This attribute is required to define the asset charge.
• ChargeDefinitionName: string
  Read Only: true

  Maximum Length: 80

  Value indicates the name of the price charges defined.
• ChargesRollupFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the pricing charge is a rollup charge. If false, then the pricing charge isn't a rollup charge. The default value is false.
• CurrencyCode: string
  Maximum Length: 15

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

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

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

  Abbreviation that identifies the pricing element of the pricing charge. This attribute is required to define the asset charge.
• PriceElementName: string
  Title: Element Name

  Read Only: true

  Maximum Length: 80

  Value indicates the name of the price element.
• PriceElementUsageCode: string
  Maximum Length: 30

  Abbreviation that indicates whether the unit price in the pricing element is the list price or the net price.
• PriceElementUsageName: string
  Read Only: true

  Maximum Length: 255

  Values indicates the usage name of the price element.
• PricePeriodicityCode: string
  Maximum Length: 30

  Abbreviation that identifies the recurring time frame that the application uses to price the charge such as month or year.
• PrimaryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the charge is a primary charge. If false, then the charge isn't a primary charge. The default value is false.
• TaxIncludedFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the asset price includes taxes. If false, then the asset price doesn't include taxes. The default value is false.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Values indicates the unit of measure of the price charges.
• UnitPrice: number
  Unit price of the asset. This is the current price of the asset or price that the organization used when it sold the asset.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "ChargeComponentsRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge component represents the aggregated value of the rollup charge. If false, then the charge component doesn't represent this value. The default value is false.",
            "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 asset charge.",
            "nullable":false,
            "x-queryable":true
        },
        "ChargeDefinitionName":{
            "maxLength":80,
            "type":"string",
            "description":"Value indicates the name of the price charges defined.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargesRollupFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the pricing charge is a rollup charge. If false, then the pricing charge isn't a rollup charge. The default value is false.",
            "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.",
            "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 asset charge.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementName":{
            "title":"Element Name",
            "maxLength":80,
            "type":"string",
            "description":"Value indicates the name of the price element.",
            "nullable":false,
            "readOnly":true,
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceElementUsageName":{
            "maxLength":255,
            "type":"string",
            "description":"Values indicates the usage name of the price element.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricePeriodicityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the recurring time frame that the application uses to price the charge such as month or year.",
            "nullable":true,
            "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.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the charge is a primary charge. If false, then the charge isn't a primary charge. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxIncludedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the asset price includes taxes. If false, then the asset price doesn't include taxes. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Values indicates the unit of measure of the price charges.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Unit price of the asset. This is the current price of the asset or price that the organization used when it sold the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-fixedAssetAssociations-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes inactive.
• ActiveStartDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes active.
• AttributeCategoryCode: string
  Read Only: true

  Maximum Length: 30
• AutoTerminationFlag: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association isn't inactivated automatically. This attribute value is set conditionally during the asset update.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 80
• ErrorMessage: string
  Maximum Length: 4000
• FaAssetType: string
  Read Only: true

  Maximum Length: 255
• FaAssociationId: integer (int64)
  Number that uniquely identifies the fixed asset association.
• FaBookTypeCode: string
  Maximum Length: 30
• FixedAssetId: integer (int64)
  Value that uniquely identifies the fixed asset.
• FixedAssetNumber: string
  Title: Fixed Asset Number

  Maximum Length: 255

  Number that uniquely identifies the fixed asset.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 35
• SynchronizationStatusCode: string
  Maximum Length: 30
• TagNumber: string
  Title: Tag Number

  Read Only: true

  Maximum Length: 15
• TerminationReasonCode: string
  Maximum Length: 30

  Contains a value when the autoTerminationCheckbox is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.
• Units: number
  Read Only: true
• ValidatedFlag: string
  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCategoryCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AutoTerminationFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association isn't inactivated automatically. This attribute value is set conditionally during the asset update.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FaAssetType":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FaAssociationId":{
            "type":"integer",
            "description":"Number that uniquely identifies the fixed asset association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FaBookTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FixedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fixed asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FixedAssetNumber":{
            "title":"Fixed Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the fixed asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":35,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SynchronizationStatusCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TagNumber":{
            "title":"Tag Number",
            "maxLength":15,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminationReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Contains a value when the autoTerminationCheckbox is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.",
            "nullable":true,
            "x-queryable":true
        },
        "Units":{
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-meters-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: End Date

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

  Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value of ActiveEndDate.
• AllowInMaintProgramFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter can't be used for scheduling a maintenance program. The default value is false.
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the asset for the meter. This attribute is read-only.
• CalculatedUtilizationRate: number
  Title: Calculated Utilization Rate per Day

  Read Only: true

  Value of the calculated utilization rate based on the number of active readings in history. This attribute is read-only.
• DailyUtilizationRate: number
  Title: Estimated Daily Utilization Rate

  Expected average daily total of readings that are to be entered for a meter.
• DisplayedReading: integer (int64)
  Title: Displayed Reading

  Read Only: true

  Value that's indicated on a meter. This value is the same as the Life-to-Date Reading value until a meter is reset or encounters a rollover event. For a change meter, this value is calculated by adding the current net change value to the previous displayed reading value. For an absolute meter, this value is always the same as the reading value. This attribute is read-only.
• InitialReadingValue: number
  The value of the initial meter reading.
• LastReadingComments: string
  Title: Comments

  Read Only: true

  Maximum Length: 255

  Comments of the last active meter reading in history. This attribute is read-only.
• LastReadingDate: string (date-time)
  Title: Last Reading Date

  Read Only: true

  Date of the last active meter reading in history. This attribute is read-only.
• LastReadingValue: integer (int64)
  Title: Last Reading Value

  Read Only: true

  Value of the last active meter reading in history. This attribute is read-only.
• LifeToDateReading: number
  Read Only: true

  Value that represents the cumulative reading value for an asset meter, irrespective of Reset or Rollover events, over time. It's incremented by recording new meter readings. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterCode: string
  Title: Meter Code

  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)
  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
  Title: Meter Description

  Read Only: true

  Maximum Length: 240

  Description of the meter template. This attribute provides a brief user-defined text providing information on the template characteristics.
• MeterId: integer (int64)
  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
  Title: Meter Name

  Read Only: true

  Maximum Length: 120

  Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of MeterName and MeterCode provide a unique value that identifies the meter template.
• MeterObjectId: integer (int64)
  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.
• MeterType: string
  Title: Meter Type

  Read Only: true

  Maximum Length: 80

  Meaning of the type of meter in the meter template. This attribute is read-only.
• MeterTypeCode: string
  Title: Meter Type Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for MeterCode are continuous, similar to an odometer or a gauge similar to a thermometer. A list of accepted values is defined in the lookup type ORA_CSE_METER_TYPE_CODE.
• MeterUsageCode: string
  Maximum Length: 30

  Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line. Valid values include ORA_ASSET or ORA_CONTRACT. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.
• ReadingDirection: string
  Title: Reading Direction

  Read Only: true

  Maximum Length: 30

  Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. This attribute specifies the direction to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. A list of accepted values is defined in the lookup type ORA_CSE_DIRECTION.
• ReadingDirectionMeaning: string
  Title: Reading Direction Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the reading direction in the meter template. This attribute is read-only.
• ReadingLockDate: string (date-time)
  The date indicating the meter lock date.
• ReadingType: string
  Title: Reading Type

  Read Only: true

  Maximum Length: 80

  Meaning of the reading type in the meter template. This attribute is read-only.
• ReadingTypeCode: string
  Title: Reading Type Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. This attribute specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.
• RecordAtWoComplCode: string
  Maximum Length: 30

  Abbreviation that identifies the option that's used to control the meter reading entry at work order completion.
• RecordAtWoComplMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning that identifies the option that's used to control the meter reading entry at work order completion. This attribute is read-only.
• ResetAllowedFlag: boolean
  Title: Reset allowed

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then don't allow. If true, then you must define Reset Value. The default value is false. Each meter that the application creates for the asset references this value. You can't define an indicator for a gauge meter.
• ResetValue: number
  Title: Reset Value

  Read Only: true

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

  Read Only: true

  Maximum Length: 1

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

  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 RolloverAllowedCheckbox is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value of RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.
• RolloverResetValue: number
  Title: Rollover Reset Value

  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 RolloverAllowedCheckbox is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value of RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Meaning of the unit of measure in the meter template. This attribute is read-only.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. This attribute provides a context that you can use to define, record, or view meter history. A list of accepted values is defined in the lookup type ORA_CSE_UOM_CODE.
• UtilizationRateComputedAt: integer
  Number of readings in history for which meter readings will be used to calculate a daily utilization rate.
• WoReadingRecordedFlag: boolean
  Read Only: true

  Value that identifies the recorded reading of the work order. This attribute is read-only.
• WorkOrderId: integer
  Read Only: true

  Unique identifier of the maintenance work order from which the meter reading was recorded. This attribute is read-only.
• WorkOrderNumber: string
  Title: Work Order

  Read Only: true

  Maximum Length: 255

  Name of the maintenance work order from which the meter reading was recorded. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"End Date",
            "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 of ActiveStartDate.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "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 of ActiveEndDate.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "AllowInMaintProgramFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter can't be used for scheduling a maintenance program. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the asset for the meter. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedUtilizationRate":{
            "title":"Calculated Utilization Rate per Day",
            "type":"number",
            "description":"Value of the calculated utilization rate based on the number of active readings in history. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DailyUtilizationRate":{
            "title":"Estimated Daily Utilization Rate",
            "type":"number",
            "description":"Expected average daily total of readings that are to be entered for a meter.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayedReading":{
            "title":"Displayed Reading",
            "type":"integer",
            "description":"Value that's indicated on a meter. This value is the same as the Life-to-Date Reading value until a meter is reset or encounters a rollover event. For a change meter, this value is calculated by adding the current net change value to the previous displayed reading value. For an absolute meter, this value is always the same as the reading value. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "InitialReadingValue":{
            "type":"number",
            "description":"The value of the initial meter reading.",
            "nullable":true,
            "x-queryable":true
        },
        "LastReadingComments":{
            "title":"Comments",
            "maxLength":255,
            "type":"string",
            "description":"Comments of the last active meter reading in history. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastReadingDate":{
            "title":"Last Reading Date",
            "type":"string",
            "description":"Date of the last active meter reading in history. This attribute is read-only.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastReadingValue":{
            "title":"Last Reading Value",
            "type":"integer",
            "description":"Value of the last active meter reading in history. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "LifeToDateReading":{
            "type":"number",
            "description":"Value that represents the cumulative reading value for an asset meter, irrespective of Reset or Rollover events, over time. It's incremented by recording new meter readings. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterCode":{
            "title":"Meter Code",
            "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
        },
        "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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeterDescription":{
            "title":"Meter Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the meter template. This attribute provides a brief user-defined text providing information on the template characteristics.",
            "nullable":true,
            "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,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MeterName":{
            "title":"Meter Name",
            "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 MeterName and MeterCode provide a unique value that identifies the meter template.",
            "nullable":false,
            "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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeterType":{
            "title":"Meter Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the type of meter in the meter template. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterTypeCode":{
            "title":"Meter Type Code",
            "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. A list of accepted values is defined in the lookup type ORA_CSE_METER_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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. Valid values include ORA_ASSET or ORA_CONTRACT. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.",
            "nullable":false,
            "x-queryable":true
        },
        "ReadingDirection":{
            "title":"Reading Direction",
            "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. This attribute specifies the direction to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. A list of accepted values is defined in the lookup type ORA_CSE_DIRECTION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingDirectionMeaning":{
            "title":"Reading Direction Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the reading direction in the meter template. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingLockDate":{
            "type":"string",
            "description":"The date indicating the meter lock date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReadingType":{
            "title":"Reading Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the reading type in the meter template. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingTypeCode":{
            "title":"Reading Type Code",
            "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. This attribute specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordAtWoComplCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the option that's used to control the meter reading entry at work order completion.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordAtWoComplMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning that identifies the option that's used to control the meter reading entry at work order completion. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResetAllowedFlag":{
            "title":"Reset allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then don't allow. If true, then you must define Reset Value. The default value is false. Each meter that the application creates for the asset references this value. You can't define an indicator for a gauge meter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResetValue":{
            "title":"Reset Value",
            "type":"number",
            "description":"Reset value for the meter in the meter template. The application uses this attribute as the reset value when it records the meter reading history. If you set ResetAllowedCheckbox to true, then you must specify a value for ResetValue. Each meter that the application creates for the asset references this attribute. This attribute must contain a value that's greater than zero, and that's equal to the lowest reading value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverAllowedFlag":{
            "title":"Rollover allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then don't allow rollover. If true, then you must specify values for RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedCheckbox is false. RolloverAllowedCheckbox is required. Each meter that the application creates for the asset references RolloverAllowedCheckbox. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverMaximumValue":{
            "title":"Rollover Maximum Value",
            "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 RolloverAllowedCheckbox is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value of RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverResetValue":{
            "title":"Rollover Reset Value",
            "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 RolloverAllowedCheckbox is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value of RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "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. This attribute provides a context that you can use to define, record, or view meter history. A list of accepted values is defined in the lookup type ORA_CSE_UOM_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Meaning of the unit of measure in the meter template. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "UtilizationRateComputedAt":{
            "type":"integer",
            "description":"Number of readings in history for which meter readings will be used to calculate a daily utilization rate.",
            "nullable":true,
            "x-queryable":true
        },
        "WoReadingRecordedFlag":{
            "type":"boolean",
            "description":"Value that identifies the recorded reading of the work order. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Unique identifier of the maintenance work order from which the meter reading was recorded. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":255,
            "type":"string",
            "description":"Name of the maintenance work order from which the meter reading was recorded. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code for extensibility.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for extensibility.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the note.
• EmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Read Only: true

  The phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The unique identifier of the note. This is the primary key of the notes table.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The column which stores the actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The note type code for categorization of note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the note. This is the primary key of the notes table.
• PartyId: integer (int64)
  Read Only: true

  The unique identifier of the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the parent source object associated to the note.
• SourceSystem: string
  Title: Source System

  Maximum Length: 30

  This is the source object code for the source object as defined in OBJECTS Metadata.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user can update the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Country",
                    "IdenAddrLocationId",
                    "PersonalAddressFlag"
                ]
            }
        },
        "FormattedPhoneNumber":{
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NoteNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The column which stores the actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The note type code for categorization of note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"This is the source object code for the source object as defined in OBJECTS Metadata.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-partsListComponents-item-response

Type: object

Show Source

• AssetExistsFlag: boolean
  Maximum Length: 1

  Asset exists indicator on the Parts List Components resource, which is part of the Installed Base Assets root resource.
• AssetId: integer
  Read Only: true

  Value that uniquely identifies the asset for each component. You can create only one relationship between each value that's specified by ListComponentId and AssetId.
• ComponentQuantity: number
  Title: Quantity

  Quantity of each part list component for the asset.
• Description: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Parts List Components resource, which is part of the Installed Base Assets root resource.
• ItemId: integer (int64)
  Value that uniquely identifies the item that's part of the part list for the asset. Asset Item can't be part of the part list for the same asset.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item that's part of the part list for the asset. An asset item can't be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListComponentId: integer (int64)
  Value that uniquely identifies the parts list item that the asset references.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 18

  Organization code on the Parts List Components resource, which is part of the Installed Base Assets root resource.
• PrimaryUOMCode: string
  Title: Primary UOM

  Read Only: true

  Maximum Length: 3

  Primary UOM Code on the Parts List Components resource, which is part of the Installed Base Assets root resource.
• SecondaryDefaultInd: string
  Title: Defaulting Control

  Read Only: true

  Maximum Length: 30

  Indicates the secondary default value in the parts list of the installed based assets.
• SecondaryQuantity: number
  Title: Secondary Quantity

  Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 3

  Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.
• SecondaryUOMName: string
  Maximum Length: 255

  Secondary UOM Name on the Parts List Components resource, which is part of the Installed Base Assets root resource.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of Measure on the Parts List Components resource, which is part of the Installed Base Assets root resource.

{
    "type":"object",
    "properties":{
        "AssetExistsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Asset exists indicator on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset for each component. You can create only one relationship between each value that's specified by ListComponentId and AssetId.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of each part list component for the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that's part of the part list for the asset. Asset Item can't be part of the part list for the same asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that's part of the part list for the asset. An asset item can't be part of the part list for the same asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization to which the part list item is assigned to. This is a required attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ListComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parts list item that the asset references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":18,
            "type":"string",
            "description":"Organization code on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "title":"Primary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Primary UOM Code on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryDefaultInd":{
            "title":"Defaulting Control",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the secondary default value in the parts list of the installed based assets.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Secondary quantity of product that the asset references. If item isn't defined as dual UOM item or if conversion for the secondary UOM is set to fix, this quantity isn't required. If dual UOM conversion is set to default, this quantity will override the defaulted quantity. If conversion is no default, this quantity is required. Secondary UOM is defaulted from setup.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the asset secondary quantity unit of measure. The secondary unit of measure isn't required to create an asset. If provided it must be the same than the asset item secondary unit of measure. If not provided the value is defaulted from the asset item secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Secondary UOM Name on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of Measure on the Parts List Components resource, which is part of the Installed Base Assets root resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : installedBaseAssets-relationships-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.
• AssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the child asset in the structure. This attribute is read-only.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item that the child asset references.
• links: array Links
  Title: Links

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

  Value that uniquely identifies the superlative relationship (As Sold Structure) to present the sales view of the customer assets. This attribute is read-only.
• RelationshipId: integer (int64)
  Value that uniquely identifies the asset relationship. The application creates this value when it creates the asset relationship. This attribute is read-only.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  Serial number of the asset. You must provide the serial number in combination with the item to identify the asset.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child asset in the structure. You must provide the value that identifies the child asset to create the relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the child asset in the structure. This attribute is read-only.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that uniquely identifies the item that the child asset references.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LogicalObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the superlative relationship (As Sold Structure) to present the sales view of the customer assets. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the asset. You must provide the serial number in combination with the item to identify the asset.",
            "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"
            }
        }
    }
}

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

assetDFF

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetDFF

Parameters:

• AssetId: $request.path.AssetId

assetImageAttachments

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetImageAttachments

Parameters:

• AssetId: $request.path.AssetId

Attachment management capabilities: view, create, and update.

assetQualifications

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/assetQualifications

Parameters:

• AssetId: $request.path.AssetId

The Asset Qualifications resource manages the association of qualification requirements to an asset. You can add, update, and view the qualifications recorded for an asset.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/attachments

Parameters:

• AssetId: $request.path.AssetId

Attachment management capabilities: view, create, and update.

charges

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/charges

Parameters:

• AssetId: $request.path.AssetId

The Charges resource manages the asset charges. The asset charge provides pricing details that are used for a flow such as billing or contract renewal.

fixedAssetAssociations

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/fixedAssetAssociations

Parameters:

• AssetId: $request.path.AssetId

The FixedAssetAssociations resource manages the relationships between installed base and fixed assets. You can add new relationships or end date the existing ones.

meters

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/meters

Parameters:

• AssetId: $request.path.AssetId

Details of the meters associated with an asset.

notes

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/notes

Parameters:

• AssetId: $request.path.AssetId

The note objects resource is used to view the note objects.

partsListComponents

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/partsListComponents

Parameters:

• AssetId: $request.path.AssetId

The Parts resource manages the asset parts list used for maintaining the asset. You can add, remove, and view the list of the asset part components.

relationships

Operation: /fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/relationships

Parameters:

• AssetId: $request.path.AssetId

The Relationships resource manages the asset structure relationships. You can add, remove, or get the assets of the structure.

Back to Top