1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Maintainable Assets (Deprecated)

Get all assets

get

/fscmRestApi/resources/11.13.18.05/maintenanceAssets

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find maintenance assets according to the asset Id.
      Finder Variables:
      • AssetId; integer; Value that uniquely identifies the asset.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActiveEndDate; string; 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; Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
    • AssetNumber; string; 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.
    • 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; 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; 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; 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; 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; 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; 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; 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; Description of the item that the asset references. This attribute is read-only.
    • ItemId; integer; 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; 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; 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; 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; 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; 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.
    • NewWoAllowedFlag; boolean; 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; 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.
    • PostalCode; string; Abbreviation that identifies the postal area where the asset resides.
    • Province; string; Province where the asset resides.
    • Quantity; number; Quantity for the item that the asset references. If the item is serial controlled, then the quantity cannot exceed one. This attribute is required to create the asset.
    • SerialNumber; string; 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; 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; Name of the work center that the asset references. The application uses attribute WorkCenterId to determine the value for attribute WorkCenterName.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : maintenanceAssets-item-response
Type: object
Show Source
  • 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.
  • First line of the customer address where the asset is located.
  • Second line of the customer address where the asset is located.
  • Third line of the customer address where the asset is located.
  • Fourth line of the customer address where the asset is located.
  • Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
  • Meters
    Title: Meters
    The Asset Meters resource gets the meters associated with the maintenance assets.
  • 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.
  • 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 where the asset is located.
  • Country where the asset is located.
  • County where the asset is located.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item that the asset references. This attribute is read-only.
  • 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.
  • 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.
  • Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
  • Links
  • Abbreviation that identifies the current location of the asset.
  • 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.
  • 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.
  • 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.
  • Flexfields
    Title: Flexfields
    The Flexfields for Maintenance Assets resource manages descriptive flexfields that contain details about the maintenance assets.
  • 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.
  • Value that uniquely identifies the organization that creates or uses the asset. This attribute is required. You can update this attribute.
  • 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.
  • Parts
    Title: Parts
    The Parts Lists resource manages parts lists for the components that the maintenance asset requires.
  • Abbreviation that identifies the postal area where the asset resides.
  • Province where the asset resides.
  • 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.
  • 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 of the customer address where the asset is located.
  • 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.
  • 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.
Nested Schema : Meters
Type: array
Title: Meters
The Asset Meters resource gets the meters associated with the maintenance assets.
Show Source
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
Nested Schema : Parts
Type: array
Title: Parts
The Parts Lists resource manages parts lists for the components that the maintenance asset requires.
Show Source
Nested Schema : maintenanceAssets-AssetMeter-item-response
Type: object
Show Source
  • 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.
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. UOMCode provides a context that you can use to define, record, or view meter history. You can use the ORA_CSE_UOM_CODE lookup to examine the values that this attribute uses.
Nested Schema : maintenanceAssets-MaintenanceAssetDFF-item-response
Type: object
Show Source
Nested Schema : maintenanceAssets-PartsListComponent-item-response
Type: object
Show Source
  • 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.
  • Title: Quantity
    Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.
  • 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.
  • 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
  • Value that uniquely identifies the parts list item that the asset references.
Back to Top

Examples

This example describes how to get all maintenance assets.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenanceAssets"

Example Response Body

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

    "items": [
        {
            "CurrentLocationContext": "ORA_INVENTORY",
            "NewWoAllowedFlag": false,
            "ItemOrganizationId": 207,
            "ItemId": 663914,
            "AssetNumber": "100100053525029",
            "LocationOrganizationId": 207,
            "MaintainableFlag": false,
            "SerialNumber": null,
            "DfltWoType": null,
            "ActiveEndDate": null,
            "DfltWoSubType": null,
            "AssetId": 100100053525029,
            "Description": null,
            "WorkCenterId": null,
            "ItemNumber": "INV-101",
            "ItemDescription": "Lot Item",
            "WorkCenterName": null,
            "OrganizationCode": "M1",
        },
        {
            "CurrentLocationContext": "ORA_UNKNOWN",
            "NewWoAllowedFlag": false,
            "ItemOrganizationId": 207,
            "ItemId": 663915,
            "AssetNumber": "100100053525035",
            "LocationOrganizationId": 207,
            "MaintainableFlag": false,
            "SerialNumber": "ADS-01",
            "DfltWoType": null,
            "ActiveEndDate": null,
            "DfltWoSubType": null,
            "AssetId": 100100053525035,
            "Description": null,
            "WorkCenterId": null,
            "ItemNumber": "INV-102",
            "ItemDescription": "Serial @ Receipt Item",
            "WorkCenterName": null,
            "OrganizationCode": "M1",
        }
 ]
}
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/maintenanceAssets",
    "name" : "maintenanceAssets",
    "kind" : "collection"
  } ]
}
Back to Top