Jump to

• Request
• Response
• Examples

Create assets

post

/fscmRestApi/resources/11.13.18.05/maintenanceAssets

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.
• Address1: string
  First line of the customer address where the asset is located.
• Address2: string
  Second line of the customer address where the asset is located.
• Address3: string
  Third line of the customer address where the asset is located.
• Address4: string
  Fourth line of the customer address where the asset is located.
• AssetId: 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.
• AssetMeter: array Meters
  Title: Meters

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

  Maximum Length: 80

  Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.
• BOMExplosionFlag: boolean
  Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.
• City: string
  City where the asset is located.
• Country: string
  Country where the asset is located.
• County: string
  County where the asset is located.
• CurrentLocationContext: string
  Maximum Length: 80

  Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute, where the customization level is System. This attribute is required when you create the asset. You can update this attrbute. You cannot use location context ORA_INVENTORY as the context when creating or updating the maintenance asset. An inventory transaction can modify ORA_INVENTORY.
• CurrentLocationId: integer (int64)
  Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN. You can update the value that identifies the current location.
• CustomerSiteId: integer (int64)
  Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
• Description: string
  Title: Description

  Maximum Length: 240

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

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

  Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.
• IotEnabledFlag: boolean
  Title: Enable IoT

  Maximum Length: 1

  Default Value: true

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

  Value that uniquely identifies the item that the asset references. This attribute is required to create an asset. You cannot update this attribute. Enable asset tracking for the item must use full lifecycle, and Allow Maintenance asset must equal YES.
• ItemOrganizationId(required): integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
• LocationCode: string
  Abbreviation that identifies the current location of the asset.
• LocationOrganizationId: integer (int64)
  Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update ORA_INVENTORY, then LocationOrganizationId is required.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

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

  Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable. The default value is true. The application examines attribute Allow Maintenance Asset to determine how to set attribute MaintainableFlag.
• MaintenanceAssetDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.
• NewWoAllowedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.
• OperatingOrganizationId: integer
  Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
• PartsListComponent: array Parts
  Title: Parts

  The Parts Lists resource manages parts lists for the components that the maintenance asset requires.
• PostalCode: string
  Abbreviation that identifies the postal area where the asset resides.
• Province: string
  Province where the asset resides.
• Quantity: number
  Default Value: 1

  Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.
• State: string
  State of the customer address where the asset is located.
• WorkCenterId: integer (int64)
  Title: Work Center

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

{
    "required":[
        "AssetNumber",
        "ItemId",
        "ItemOrganizationId"
    ],
    "type":"object",
    "properties":{
        "IotEnabledFlag":{
            "title":"Enable IoT",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false.",
            "nullable":true,
            "default":true
        },
        "CurrentLocationContext":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute, where the customization level is System. This attribute is required when you create the asset. You can update this attrbute. You cannot use location context ORA_INVENTORY as the context when creating or updating the maintenance asset. An inventory transaction can modify ORA_INVENTORY.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "MaintenanceAssetDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.",
            "items":{
                "$ref":"#/components/schemas/maintenanceAssets-MaintenanceAssetDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "PostalCode":{
            "type":"string",
            "description":"Abbreviation that identifies the postal area where the asset resides.",
            "nullable":true
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the asset references. This attribute is required to create an asset. You cannot update this attribute. Enable asset tracking for the item must use full lifecycle, and Allow Maintenance asset must equal YES.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.",
            "nullable":false
        },
        "DfltWoSubType":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true
        },
        "County":{
            "type":"string",
            "description":"County where the asset is located.",
            "nullable":true
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrentLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN. You can update the value that identifies the current location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "Address4":{
            "type":"string",
            "description":"Fourth line of the customer address where the asset is located.",
            "nullable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.",
            "format":"date-time",
            "nullable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update ORA_INVENTORY, then LocationOrganizationId is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute.",
            "nullable":true
        },
        "BOMExplosionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.",
            "nullable":true,
            "x-queryable":false
        },
        "PartsListComponent":{
            "title":"Parts",
            "type":"array",
            "description":"The Parts Lists resource manages parts lists for the components that the maintenance asset requires.",
            "items":{
                "$ref":"#/components/schemas/maintenanceAssets-PartsListComponent-item-post-request"
            }
        },
        "NewWoAllowedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.",
            "nullable":false
        },
        "OperatingOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.",
            "nullable":true
        },
        "AssetMeter":{
            "title":"Meters",
            "type":"array",
            "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
            "items":{
                "$ref":"#/components/schemas/maintenanceAssets-AssetMeter-item-post-request"
            }
        },
        "Address2":{
            "type":"string",
            "description":"Second line of the customer address where the asset is located.",
            "nullable":true
        },
        "LocationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the current location of the asset.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Address3":{
            "type":"string",
            "description":"Third line of the customer address where the asset is located.",
            "nullable":true
        },
        "Address1":{
            "type":"string",
            "description":"First line of the customer address where the asset is located.",
            "nullable":true
        },
        "City":{
            "type":"string",
            "description":"City where the asset is located.",
            "nullable":true
        },
        "DfltWoType":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true
        },
        "Province":{
            "type":"string",
            "description":"Province where the asset resides.",
            "nullable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.",
            "nullable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "State":{
            "type":"string",
            "description":"State of the customer address where the asset is located.",
            "nullable":true
        },
        "MaintainableFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable. The default value is true. The application examines attribute Allow Maintenance Asset to determine how to set attribute MaintainableFlag.",
            "nullable":false
        },
        "Country":{
            "type":"string",
            "description":"Country where the asset is located.",
            "nullable":true
        },
        "AssetId":{
            "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"
            }
        }
    }
}

Nested Schema : Meters

Type: array

Title: Meters

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

Show Source

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

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

Nested Schema : Flexfields

Type: array

Title: Flexfields

The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.

Show Source

• Array of: object maintenanceAssets-MaintenanceAssetDFF-item-post-request

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

Nested Schema : Parts

Type: array

Title: Parts

The Parts Lists resource manages parts lists for the components that the maintenance asset requires.

Show Source

• Array of: object schema

{
    "title":"Parts",
    "type":"array",
    "description":"The Parts Lists resource manages parts lists for the components that the maintenance asset requires.",
    "items":{
        "$ref":"#/components/schemas/maintenanceAssets-PartsListComponent-item-post-request"
    }
}

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

Type: object

Show Source

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

Nested Schema : maintenanceAssets-MaintenanceAssetDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

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

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

Nested Schema : schema

Type: object

Show Source

• AssetId: integer
  Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.
• ComponentQuantity: number
  Title: Quantity

  Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.
• ItemId: integer (int64)
  Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.
• ListComponentId: integer (int64)
  Value that uniquely identifies the parts list item that the asset references.

{
    "type":"object",
    "properties":{
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.",
            "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"
            }
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.",
            "nullable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.",
            "nullable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : maintenanceAssets-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.
• Address1: string
  First line of the customer address where the asset is located.
• Address2: string
  Second line of the customer address where the asset is located.
• Address3: string
  Third line of the customer address where the asset is located.
• Address4: string
  Fourth line of the customer address where the asset is located.
• AssetId: 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.
• AssetMeter: array Meters
  Title: Meters

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

  Maximum Length: 80

  Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.
• BOMExplosionFlag: boolean
  Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.
• City: string
  City where the asset is located.
• Country: string
  Country where the asset is located.
• County: string
  County where the asset is located.
• CurrentLocationContext: string
  Maximum Length: 80

  Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute, where the customization level is System. This attribute is required when you create the asset. You can update this attrbute. You cannot use location context ORA_INVENTORY as the context when creating or updating the maintenance asset. An inventory transaction can modify ORA_INVENTORY.
• CurrentLocationId: integer (int64)
  Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN. You can update the value that identifies the current location.
• CustomerSiteId: integer (int64)
  Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.
• Description: string
  Title: Description

  Maximum Length: 240

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

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

  Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.
• IotEnabledFlag: boolean
  Title: Enable IoT

  Maximum Length: 1

  Default Value: true

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

  Read Only: true

  Maximum Length: 240

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

  Value that uniquely identifies the item that the asset references. This attribute is required to create an asset. You cannot update this attribute. Enable asset tracking for the item must use full lifecycle, and Allow Maintenance asset must equal YES.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

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

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

  Maximum Length: 80

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

  Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable. The default value is true. The application examines attribute Allow Maintenance Asset to determine how to set attribute MaintainableFlag.
• MaintenanceAssetDFF: array Flexfields
  Title: Flexfields

  The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.
• NewWoAllowedFlag: boolean
  Maximum Length: 1

  Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.
• OperatingOrganizationId: integer
  Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the organization that creates or uses the asset. The application determines this value from the organization Id. This attribute is read-only.
• PartsListComponent: array Parts
  Title: Parts

  The Parts Lists resource manages parts lists for the components that the maintenance asset requires.
• PostalCode: string
  Abbreviation that identifies the postal area where the asset resides.
• Province: string
  Province where the asset resides.
• Quantity: number
  Default Value: 1

  Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.
• State: string
  State of the customer address where the asset is located.
• WorkCenterId: integer (int64)
  Title: Work Center

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

  Read Only: true

  Maximum Length: 120

  Name of the work center that the asset references. The application uses attribute WorkCenterId to determine the value for attribute WorkCenterName.

{
    "type":"object",
    "properties":{
        "IotEnabledFlag":{
            "title":"Enable IoT",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: synchronize the asset with the application that controls the lot. N: do not synchronize. The default value is Y. The response payload translates Y to true and N to false.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CurrentLocationContext":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the location context where the asset currently resides. The ORA_CSE_CURRENT_LOC_CONTEXT lookup defines the values that you can use with this attribute, where the customization level is System. This attribute is required when you create the asset. You can update this attrbute. You cannot use location context ORA_INVENTORY as the context when creating or updating the maintenance asset. An inventory transaction can modify ORA_INVENTORY.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset that the user defines. It can describe the features, characteristics, and so on of the asset. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "title":"Work Center",
            "type":"integer",
            "description":"Value that uniquely identifies the work center where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update this context, then the application can specify a value for the work center. If the location context is not ORA_WORK_CENTER, or if you cannot update this context, then the application sets the location context to ORA_UNKNOWN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MaintenanceAssetDFF":{
            "title":"Flexfields",
            "type":"array",
            "description":"The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.",
            "items":{
                "$ref":"#/components/schemas/maintenanceAssets-MaintenanceAssetDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "PostalCode":{
            "type":"string",
            "description":"Abbreviation that identifies the postal area where the asset resides.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item that the asset references. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item that the asset references. This attribute is required to create an asset. You cannot update this attribute. Enable asset tracking for the item must use full lifecycle, and Allow Maintenance asset must equal YES.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the asset. This attribute is optional. If you do not provide a value, then the application uses the value that identifies the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "DfltWoSubType":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_SUB_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order subtype when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "type":"string",
            "description":"County where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrentLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the asset currently resides. If the location context is ORA_INTERNAL_LOCATION or ORA_EXTERNAL_LOCATION, then you can specify a value for this attribute. If the location context is ORA_CUSTOMER, then the application gets the value for this attribute from the customer site. If you do not provide a value for this attribute, then the application sets the location context to ORA_UNKNOWN. You can update the value that identifies the current location.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item that the asset references. The application determines this value from the attribute that identifies the item. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "type":"string",
            "description":"Fourth line of the customer address where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization that creates or uses the asset. The application determines this value from the organization Id. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the asset becomes inactive. This attribute is optional. This date must have already occurred and it must occur later or on the same date as the end date for the customer asset. If the end date for the active asset contains a value, then you cannot update other attributes.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LocationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the asset currently resides. If the location context is ORA_WORK_CENTER, and if you can update ORA_INVENTORY, then LocationOrganizationId is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifying the lot that that the asset references to control the item in inventory. Applies when the item is lot controlled. If the lot number does not exist in inventory, then the application creates a lot in inventory. This attribute is optional. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BOMExplosionFlag":{
            "type":"boolean",
            "description":"Contains one of the following values. Y: create component assets. Expand the primary bill of materials for the item, and then use the bill of materials for the components to create child items for the asset. N: do not create child assets from the primary bill of material. The default value is N. The response payload translates Y to true and N to false.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkCenterName":{
            "title":"Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center that the asset references. The application uses attribute WorkCenterId to determine the value for attribute WorkCenterName.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartsListComponent":{
            "title":"Parts",
            "type":"array",
            "description":"The Parts Lists resource manages parts lists for the components that the maintenance asset requires.",
            "items":{
                "$ref":"#/components/schemas/maintenanceAssets-PartsListComponent-item-response"
            }
        },
        "NewWoAllowedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: allow the application to create a work order for the asset. N: do not allow. The default value is Y.",
            "nullable":false,
            "x-queryable":true
        },
        "OperatingOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetMeter":{
            "title":"Meters",
            "type":"array",
            "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
            "items":{
                "$ref":"#/components/schemas/maintenanceAssets-AssetMeter-item-response"
            }
        },
        "Address2":{
            "type":"string",
            "description":"Second line of the customer address where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the current location of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Address3":{
            "type":"string",
            "description":"Third line of the customer address where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "type":"string",
            "description":"First line of the customer address where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "type":"string",
            "description":"City where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "DfltWoType":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order type. The ORA_MNT_WO_TYPE lookup defines the values that you can use with this attribute. The application uses this attribute to set the work order type when it creates a work order for the asset. This attribute is optional to create the asset. You can update this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "type":"string",
            "description":"Province where the asset resides.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the serial that the asset references. Applies when item is serial controlled. If the serial number already exists in inventory, then it must be at the Out of Storage status and, no other asset can reference it. This attribute is optional. You can update this attribute. If the lot number does not exist in inventory, then the application creates a serial in inventory with status Out of Storage.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer site where the asset currently resides. If the location context is ORA_CUSTOMER, then this attribute is required. You can update this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "type":"string",
            "description":"State of the customer address where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintainableFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. Y: enable the asset for a maintenance activity, such as a maintenance program or maintenance work order. N: do not enable. The default value is true. The application examines attribute Allow Maintenance Asset to determine how to set attribute MaintainableFlag.",
            "nullable":false,
            "x-queryable":true
        },
        "Country":{
            "type":"string",
            "description":"Country where the asset is located.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "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
        }
    }
}

Nested Schema : Meters

Type: array

Title: Meters

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

Show Source

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

{
    "title":"Meters",
    "type":"array",
    "description":"The Asset Meters resource gets the meters associated with the maintenance assets.",
    "items":{
        "$ref":"#/components/schemas/maintenanceAssets-AssetMeter-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 : Flexfields

Type: array

Title: Flexfields

The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.

Show Source

• Array of: object maintenanceAssets-MaintenanceAssetDFF-item-response

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

Nested Schema : Parts

Type: array

Title: Parts

The Parts Lists resource manages parts lists for the components that the maintenance asset requires.

Show Source

• Array of: object maintenanceAssets-PartsListComponent-item-response

{
    "title":"Parts",
    "type":"array",
    "description":"The Parts Lists resource manages parts lists for the components that the maintenance asset requires.",
    "items":{
        "$ref":"#/components/schemas/maintenanceAssets-PartsListComponent-item-response"
    }
}

Nested Schema : maintenanceAssets-AssetMeter-item-response

Type: object

Show Source

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

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

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

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

  Maximum Length: 30

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

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

  Maximum Length: 240

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

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

  Maximum Length: 120

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

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 1

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

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

  Maximum Length: 1

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

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

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

  Maximum Length: 3

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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 : maintenanceAssets-MaintenanceAssetDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

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

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

  The link relations associated with the resource instance.

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

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 : maintenanceAssets-PartsListComponent-item-response

Type: object

Show Source

• AssetId: integer
  Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.
• ComponentQuantity: number
  Title: Quantity

  Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.
• ItemId: integer (int64)
  Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.
• 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.

{
    "type":"object",
    "properties":{
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.",
            "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 attribute ListComponentId specifies and that AssetId specifies.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

AssetMeter

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

Parameters:

• AssetId: $request.path.AssetId

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

MaintenanceAssetDFF

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceAssets/{AssetId}/child/MaintenanceAssetDFF

Parameters:

• AssetId: $request.path.AssetId

The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.

PartsListComponent

Operation: /fscmRestApi/resources/11.13.18.05/maintenanceAssets/{AssetId}/child/PartsListComponent

Parameters:

• AssetId: $request.path.AssetId

The Parts Lists resource manages parts lists for the components that the maintenance asset requires.

Back to Top

Examples

This example describes how to create one maintenance asset.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

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

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
    "AssetNumber": "Fork Lift Asset 01",
    "ItemOrganizationId": 207,
    "ItemId": 300100013645864,
    "SerialNumber": "ADS-02",
    "Description": "Fork Lift Asset 01"
}

Example Response Body

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

{
    "CurrentLocationContext": "ORA_UNKNOWN",
    "NewWoAllowedFlag": false,
    "ItemOrganizationId": 207,
    "ItemId": 300100013645864,
    "AssetNumber": "Fork Lift Asset 01",
    "LocationOrganizationId": 207,
    "MaintainableFlag": false,
    "SerialNumber": null,
    "DfltWoType": null,
    "ActiveEndDate": null,
    "DfltWoSubType": null,
    "AssetId": 100100053525029,
    "Description": "Fork Lift Asset 01",
    "WorkCenterId": null,
    "ItemNumber": "alm-lot-srl-001",
    "ItemDescription": "Lot and Serialized Asset Item",
    "WorkCenterName": null,
    "OrganizationCode": "M1",
}

Back to Top