1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Failure Instances

Get one asset failure event instance

get

/fscmRestApi/resources/11.13.18.05/assetFailureEventInstances/{FailureInstanceId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : assetFailureEventInstances-item-response
Type: object
Show Source
  • Title: Asset Criticality Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the asset criticality. The code is not required but if entered must be a valid code. The code must use uppercase letters and be alphanumeric.
  • Title: Asset Criticality Name
    Maximum Length: 255
    Name that uniquely identifies the criticality of the asset. The name is optional but if defined must be unique.
  • Title: Asset Description
    Read Only: true
    Maximum Length: 240
    Description of the asset. This optional attribute provides a brief user-defined text providing information on the asset's use and characteristics.
  • Title: Asset Down
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the asset is deemed non-functional and downtime is accrued for that asset. If false, then the asset is still considered functional and no downtime is accrued for that asset; for example, an asset may have redundant systems that allow it to remain functional despite a failure. The default value is true. The response payload translates Y to true and N to false.
  • Title: Asset ID
    Read Only: true
    Value that uniquely identifies the asset that failed. This is generally the asset on the work order. The value is system generated and read-only. This attribute is optional.
  • Title: Asset Number
    Read Only: true
    Maximum Length: 80
    Name that uniquely identifies the asset-tracked component that failed. This attribute is optional.
  • Title: Available Date
    Read Only: true
    Date and time when a failed asset is determined to be available to use again after failure. The available date must occur after the failure date. This attribute is optional. If you do not provide a value, the application uses the work order completion date.
  • Title: Cause Category Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the category of failure cause. The code must use uppercase letters and it can be alphanumeric.
  • Title: Cause Category Name
    Read Only: true
    Name of the failure cause category. The name is optional but if defined must be unique.
  • Title: Cause Code
    Abbreviation that uniquely identifies the cause of failure. The cause code is not required but if entered must be a valid code. The code must use uppercase letters and be alphanumeric.
  • Title: Cause Code ID
    Unique identifier for the cause Code.
  • Title: Cause Description
    Read Only: true
    Maximum Length: 540
    Description of the cause code. This optional attribute provides a brief user-defined text providing information on the code's use and characteristics.
  • Title: Cause Name
    Read Only: true
    Maximum Length: 240
    Name of the cause code. The cause code name is optional but if defined must be unique.
  • Title: WO Completion Date
    Read Only: true
    Date and time when the work order for resolving the failure was completed. The work order completion date must occur after the failure date. This attribute is populated only in cases where failure records are imported from an external system, and in such cases is mandatory.
  • Read Only: true
    Maximum Length: 64
    User who created the asset failure event instance. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the asset failure event instance is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: TBF Days
    Read Only: true
    The number of calendar days between the current failure date and the prior available date. If there was no prior failure, then the number of calendar days between the current failure date and the asset in-service date. This attribute is populated only in cases where failure records are imported from an external system, and in such cases is mandatory.
  • Title: Failed Asset ID
    Value that uniquely identifies the asset that failed. This is generally the asset on the work order. The value is system generated and read-only. This attribute is optional.
  • Title: Failed Asset Description
    Read Only: true
    Maximum Length: 240
    Description of the asset-tracked component item that failed. This optional attribute provides a brief user-defined text providing information on the item's use and characteristics.
  • Title: Failed Asset Number
    Description of the asset-tracked component item that failed. This optional attribute provides a brief user-defined text providing information on the item's use and characteristics.
  • Title: Failed Item Description
    Read Only: true
    Maximum Length: 240
    Description of the component item that failed. This optional attribute provides a brief user-defined text providing information on the item's use and characteristics.
  • Title: Failed Item ID
    Unique identifier for the item that failed. This is generally the item on the work order. This attribute is optional.
  • Title: Failed Item Long Description
    Read Only: true
    Maximum Length: 4000
    Long description of the component item that failed. This optional attribute provides a more detailed user-defined text providing information on the item's use and characteristics.
  • Title: Failed Item Number
    Name that uniquely identifies the component that failed. This attribute is optional.
  • Title: Failed Serial Number
    Maximum Length: 80
    Serial number that uniquely identifies the component that failed. This attribute is optional. This attribute is only valid if the FailedItemId is a serial controlled item.
  • Title: Failure Category Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the category of failure. The code must use uppercase letters and it can be alphanumeric.
  • Title: Failure Category Name
    Read Only: true
    Name of the failure category. The name is optional but if defined must be unique.
  • Title: Failure Code
    Abbreviation that uniquely identifies the failure mode. The failure code is not required but if entered must be a valid code. The code must use uppercase letters and it can be alphanumeric.
  • Title: Failure Code ID
    Unique identifier for the failure Code.
  • Title: Failure Comments
    Maximum Length: 2000
    Notes captured with free-text details about the causes and root cause of failure, or any other relevant data. This value is optional.
  • Title: Failure Date
    Read Only: true
    Date and time when an asset failed. The failed date must occur before the failure date. This attribute is mandatory.
  • Title: Failure Description
    Read Only: true
    Maximum Length: 540
    Description of the failure code. This optional attribute provides a brief user-defined text providing information on the code's use and characteristics.
  • Title: Failure Event ID
    Value that uniquely identifies the failure event. The value is system generated and read-only.
  • Title: Failure Instance ID
    Read Only: true
    Value that uniquely identifies the failure instance. The value is system generated and read-only.
  • Title: Failure Name
    Read Only: true
    Maximum Length: 240
    Name of the failure code. The failure code name is optional but if defined must be unique.
  • Title: Severity Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the severity of failure. The severity code is not required but if entered must be a valid code. The code must be alphanumeric.
  • Title: Severity Name
    Maximum Length: 255
    Name that uniquely identifies the severity of the failure. The name is optional but if defined must be unique.
  • Title: Status Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the status of the failure. The status code is not required but if entered must be a valid code. The code must be alphanumeric.
  • Title: Status Name
    Maximum Length: 255
    Name that uniquely identifies the status of the failure. The name is optional but if defined must be unique.
  • Title: Item Number
    Read Only: true
    Unique identifier for the item that failed. This is generally the item on the work order. This attribute is optional.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that uniquely identifies the item category to which the failed component is assigned. The code must be alphanumeric and must validate against the catalog assigned to the profile option " ORA_CSE_ITEM_CATALOG".
  • Read Only: true
    Value that uniquely identifies the item category to which the failed component is assigned. The value is system generated and read-only.
  • Read Only: true
    Maximum Length: 255
    Name of the item category to which the failed component is assigned. The item category name is optional but if defined must be unique.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description of the item. This optional attribute provides a brief user-defined text providing information on the item's use and characteristics.
  • Title: Item Long Description
    Read Only: true
    Maximum Length: 4000
    Long description of the item. This optional attribute provides a more detailed user-defined text providing information on the item's use and characteristics.
  • Title: Item Number
    Read Only: true
    Maximum Length: 300
    Name that uniquely identifies the item that failed. This is generally the item on the work order. This attribute is optional.
  • Read Only: true
    Maximum Length: 18
    Value that uniquely identifies the item Organization. This is generally the item on the work order.
  • Title: Organization
    Read Only: true
    Unique identifier for the item Organization. This is generally the item on the work order.
  • Read Only: true
    Date when the user most recently updated the asset failure event instance. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the asset failure event instance. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the asset failure event instance. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Title: TBF Meter Units UOM Code
    Read Only: true
    Maximum Length: 3
    MeterUnitOfMeasure must be a valid Meter UOM Code lookup. This attribute is populated only in cases where failure records are imported from an external system, an in such cases is optional.
  • Title: TBF Meter Units
    Read Only: true
    The number of meter units between the current failure date and the prior available date. If there was no prior failure, then the number of meter units between the current failure date and the asset in-service date. The unit of measure for the meter units is defined by the attribute MeterUnitOfMeasure. This attribute is populated only in cases where failure records are imported from an external system, and in such cases is optional.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name that identifies the operation within a work order.
  • Title: Operation Sequence
    Number that identifies the sequence of the operation within a work order. The operation sequence is required attribute for a work order operation. It must be a positive integer and unique within a work order.
  • Title: Repair Cost
    Read Only: true
    The total cost to repair the asset. This attribute is populated only in cases where failure records are imported from an external system, and in such cases is mandatory.
  • Title: Resolution Category Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the category of resolution. The code must use uppercase letters and it can be alphanumeric.
  • Title: Resolution Category Name
    Read Only: true
    Name of the resolution category. The name is optional but if defined must be unique.
  • Title: Resolution Code
    Abbreviation that uniquely identifies the resolution of the failure. The resolution code is not required but if entered must be a valid code. The code must use uppercase letters and it can be alphanumeric.
  • Title: Resolution Code ID
    Unique identifier for the resolution of the failure.
  • Title: Resolution Description
    Read Only: true
    Maximum Length: 540
    Description of the resolution code. This optional attribute provides a brief user-defined text providing information on the code's use and characteristics.
  • Title: Resolution Name
    Read Only: true
    Maximum Length: 240
    Name of the resolution code. The resolution code name is optional but if defined must be unique.
  • Failure Root Causes
    Title: Failure Root Causes
    The Failure Root Causes resource manages the failure root causes. A failure root cause defines the underlying, originating causal factors that led to the occurrence of an asset failure event. Root causes represent the core causal factors, such as process, training, environment or design that are determined through a root cause analysis; in contrast, a cause code represents a technician-observed failure mechanism, such as rust, leak, rupture or shearing. More than one failure root cause may underly a single failure instance.
  • Title: Source Document ID
    Read Only: true
    Maximum Length: 36
    Value that uniquely identifies the source document. The value is system generated and read-only.
  • Title: Source Doc Type Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the source document type. The source document type code is required only for failure records imported from an external system. The code must be alphanumeric and must validate against fnd_lookup "ORA_CSE_DOCUMENT_TYPE".
  • Title: Source Application ID
    Read Only: true
    Value that uniquely identifies the source system. The value is system generated and read-only.
  • Title: Source Application Type
    Read Only: true
    Maximum Length: 30
    Contains one of the following values: ORA_INTERNAL (failure records generated from the Failure Capture UI) or ORA_EXTERNAL (failure records from another system, often historical failure records). If ORA_INTERNAL, then either workOrderNumber or workOrderId is mandatory and values passed for assetId will be ignored (Asset ID will be queried from the workOrderId). If ORA_EXTERNAL, then assetId, sourceSystemType, sourceDocTypeCode, and sourceDocId are mandatory. sourceSystemId must validate against hz_orig_systems_vl.ORIG_SYSTEM_ID. sourceDocTypeCode must validate against fnd_lookup "ORA_CSE_DOCUMENT_TYPE". Values passed for trackingObjectCode, workOrderNumber, and workOrderId will be ignored. The default value is ORA_EXTERNAL.
  • Value that uniquely identifies the work order operation associated with the failure instance.
  • Title: Work Order Description
    Read Only: true
    Maximum Length: 240
    Description of the work order. This optional attribute provides a brief user-defined text providing information on the work order's use and characteristics.
  • Title: Work Order ID
    Read Only: true
    Value that uniquely identifies the work order. The value is system generated and read-only.
  • Title: Work Order Number
    Read Only: true
    Maximum Length: 120
    Number the uniquely identifies the work order within an organization.
Nested Schema : Failure Root Causes
Type: array
Title: Failure Root Causes
The Failure Root Causes resource manages the failure root causes. A failure root cause defines the underlying, originating causal factors that led to the occurrence of an asset failure event. Root causes represent the core causal factors, such as process, training, environment or design that are determined through a root cause analysis; in contrast, a cause code represents a technician-observed failure mechanism, such as rust, leak, rupture or shearing. More than one failure root cause may underly a single failure instance.
Show Source
Nested Schema : assetFailureEventInstances-rootCauses-item-response
Type: object
Show Source
  • Title: Cause Code ID
    Value that uniquely identifies the root cause code. The value is system generated and read-only.
  • Read Only: true
    Maximum Length: 64
    User who created the failure root cause. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the failure root cause is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Failure Instance ID
    Value that uniquely identifies the failure instance. The value is system generated and read-only.
  • Read Only: true
    Date when the user most recently updated the failure root cause. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the failure root cause. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    Login that the user used when updating the failure root cause. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Title: Cause Category Code
    Read Only: true
    Maximum Length: 30
    Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
  • Title: Cause Category Name
    Read Only: true
    Maximum Length: 255
    Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
  • Title: Cause Code
    Abbreviation that uniquely identifies the root cause of failure. The root cause code is required and if entered must be a valid code. The code must use uppercase letters and alphanumeric.
  • Title: Comments
    Maximum Length: 2000
    Notes captured with free-text details about the causes and root cause of failure, or any other relevant data. This value is optional.
  • Title: Cause Description
    Read Only: true
    Maximum Length: 540
    Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
  • Title: Root Cause ID
    Read Only: true
    Value that uniquely identifies the root cause. The value is system generated and read-only.
  • Title: Cause Name
    Read Only: true
    Maximum Length: 240
    Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
Links
rootCauses
Parameters:
  • FailureInstanceId: $request.path.FailureInstanceId
The Failure Root Causes resource manages the failure root causes. A failure root cause defines the underlying, originating causal factors that led to the occurrence of an asset failure event. Root causes represent the core causal factors, such as process, training, environment or design that are determined through a root cause analysis; in contrast, a cause code represents a technician-observed failure mechanism, such as rust, leak, rupture or shearing. More than one failure root cause may underly a single failure instance.
Back to Top

Examples

This example describes how to get one asset failure event instance.

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/assetFailureEventInstances/FailureInstanceId"

Example Response Body

The following shows an example of the response body in JSON format.
"{
    "CreatedBy": "MNT_QA",
    "CreationDate": "2021-11-22T05:07:33.372+00:00",
    "FailedComponentAssetNumber": "100100053526099",
    "AssetNumber": "F0554-MA04",
    "FailedComponentItemNumber": null,
    "FailedComponentItemId": null,
    "FailedComponentSerialNumber": null,
    "FailureComments": "Failed1",
    "FailureEventId": 300100554850954,
    "FailureInstanceId": 300100554850974,
    "LastUpdateDate": "2021-11-22T05:07:33.373+00:00",
    "LastUpdateLogin": "D14D17F09795611CE053A9B1F20AEF34",
    "LastUpdatedBy": "MNT_QA",
    "FailureSeverityCode": null,
    "FailureStatusCode": null,
    "AssetId": 300100137341407,
    "FailureName": "FAIL_CODE_01",
    "FailureDescription": "FAIL_CODE_01",
    "CauseDescription": "CAUSE_CODE_01",
    "CauseName": "CAUSE_CODE_01",
    "ResolutionDescription": "RESOLUTION_CODE_01",
    "ResolutionName": "RESOLUTION_CODE_01",
    "AssetDescription": "Fervi Combined Bench Grinder - To be used for Material Availability Demo",
    "FailureCodeId": 300100551758551,
    "FailureCode": "FAIL_CODE_01",
    "CauseCodeId": 300100551758732,
    "CauseCode": "CAUSE_CODE_01",
    "ResolutionCodeId": 300100551758849,
    "ResolutionCode": "RESOLUTION_CODE_01",
    "AssetDownFlag": false,
    "AvailableDate": "2020-09-09T02:00:28+00:00",
    "FailureDate": null,
    "RepairCost": 111,
    "SourceDocumentId": "source",
    "SourceDocumentTypeCode": "ORA_WORK_ORDER",
    "SourceSystemId": 300100029025576,
    "SourceSystemType": "ORA_EXTERNAL",
    "DaysBetweenFailure": null,
    "MeterUnitsBetweenFailure": null,
    "MeterUnitOfMeasure": null,
    "CompletionDate": null,
    "FailureCategoryCode": "DEMO_CAT_CODE",
    "FailureCategoryName": "Category code meaning 101",
    "CauseCategoryCode": "DEMO_CAT_CODE",
    "CauseCategoryName": "Category code meaning 101",
    "ResolutionCategoryCode": "DEMO_CAT_CODE",
    "ResolutionCategoryName": "Category code meaning 101",
    "ItemDescription": "Professional combined Bench Grinder Fervi\n",
    "ItemNumber": "F/0554",
    "ItemLongDescription": null,
    "FailedComponentItemDescription": null,
    "InventoryItemId": 300100114215977,
    "ItemOrganizationId": 300100113363336,
    "FailedComponentItemLongDescription": null,
    "WorkOrderId": null,
    "WorkOrderNumber": null,
    "WorkOrderDescription": null,
    "FailedComponentAssetDescription": null,
    "FailureSeverityName": null,
    "FailureStatusName": null,
    "AssetCriticalityName": null,
    "AssetCriticalityCode": null,
    "ItemOrganizationCode": "MNTALM",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100554850974",
            "name": "assetFailureEventInstances",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100554850974",
            "name": "assetFailureEventInstances",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100554850974/child/rootCauses",
            "name": "rootCauses",
            "kind": "collection"
        }
    ]
}"
Back to Top