1. REST API for Oracle Fusion Cloud SCMREST API for Oracle Fusion Cloud SCM
  2. Use Cases
  3. Maintenance
  4. Get a Failure Event Instance

Get a Failure Event Instance

This use case shows how to query and get one or more failure event instances. Getting failure set instances is useful in cases where failure data needs to be retrieved and analyzed across individual failures, particularly when searching for failure instances with specific attributes; for example, when querying all failures caused by a specific failed component.

You can use REST API to get one or more failure event instances based on specific attributes of the asset or failure.

Here's a typical application processing flow for the scenarios:

  1. You get all failure event instances.
  2. You may choose to get all failure event instances with a specific failure code.
  3. You may choose to get all failure event instances with a specific cause code.
  4. You may choose to get all failure event instances with a specific resolution code.
  5. You may choose to get all failure event instances with a specific failed component item number.
  6. You may choose to get all failure event instances with a specific failed component asset number.
  7. You may choose to get all failure event instances with a specific root cause.

Get all Failure Event Instances

In this scenario, you get all failure event instances. This type of scenario might occur when retrieving all failure instances for a report or analysis.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances"

Example Response

Here's an example of the response body in JSON format.
{
    "items": [
        {
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-11T13:28:40.108+00:00",
            "FailedComponentAssetNumber": null,
            "AssetNumber": "F0554-01",
            "FailedComponentItemNumber": null,
            "FailedComponentItemId": null,
            "FailedComponentSerialNumber": null,
            "FailureComments": "Visible external scorching.",
            "FailureEventId": 300100552615491,
            "FailureInstanceId": 300100552615492,
            "LastUpdateDate": "2022-01-11T13:28:40.108+00:00",
            "LastUpdateLogin": "D53C39E3D5BC4F6AE053D45AF00A3DF1",
            "LastUpdatedBy": "MNT_QA",
            "FailureSeverityCode": null,
            "FailureStatusCode": null,
            "AssetId": 300100114563189,
            "FailureName": "Failure Code 10",
            "FailureDescription": "Failure Code 10",
            "CauseDescription": null,
            "CauseName": null,
            "ResolutionDescription": null,
            "ResolutionName": null,
            "AssetDescription": "Fervi Combined Bench Grinder",
            "FailureCodeId": 300100552614657,
            "FailureCode": "FC10",
            "CauseCodeId": null,
            "CauseCode": null,
            "ResolutionCodeId": null,
            "ResolutionCode": null,
            "AssetDownFlag": true,
            "AvailableDate": null,
            "FailureDate": "2020-09-08T19:00:28+00:00",
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceSystemId": null,
            "SourceSystemType": "ORA_INTERNAL",
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "MeterUnitOfMeasure": null,
            "CompletionDate": null,
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "ItemDescription": "Professional combined Bench Grinder Fervi\n",
            "ItemNumber": "F/0554",
            "ItemLongDescription": null,
            "FailedComponentItemDescription": null,
            "InventoryItemId": 300100114215977,
            "ItemOrganizationId": 300100113363336,
            "FailedComponentItemLongDescription": null,
            "WorkOrderId": 300100209286627,
            "WorkOrderNumber": "2004_MNTWO2",
            "WorkOrderDescription": null,
            "FailedComponentAssetDescription": null,
            "FailureSeverityName": null,
            "FailureStatusName": null,
            "AssetCriticalityName": null,
            "AssetCriticalityCode": null,
            "ItemOrganizationCode": "MNTALM",
            "ItemCategoryId": null,
            "ItemCategoryName": null,
            "ItemCategoryCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552615492",
                    "name": "assetFailureEventInstances",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552615492",
                    "name": "assetFailureEventInstances",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552615492/child/rootCauses",
                    "name": "rootCauses",
                    "kind": "collection"
                }
            ]
        },
        {
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-11T13:28:40.111+00:00",
            "FailedComponentAssetNumber": null,
            "AssetNumber": "F0554-01",
            "FailedComponentItemNumber": "ZS5-4 Storage Appliance",
            "FailedComponentItemId": 300100170554049,
            "FailedComponentSerialNumber": null,
            "FailureComments": null,
            "FailureEventId": 300100552615491,
            "FailureInstanceId": 300100552615493,
            "LastUpdateDate": "2022-01-11T13:28:40.111+00:00",
            "LastUpdateLogin": "D53C39E3D5BC4F6AE053D45AF00A3DF1",
            "LastUpdatedBy": "MNT_QA",
            "FailureSeverityCode": null,
            "FailureStatusCode": null,
            "AssetId": 300100114563189,
            "FailureName": "Failure Code 10",
            "FailureDescription": "Failure Code 10",
            "CauseDescription": null,
            "CauseName": null,
            "ResolutionDescription": null,
            "ResolutionName": null,
            "AssetDescription": "Fervi Combined Bench Grinder",
            "FailureCodeId": 300100552614657,
            "FailureCode": "FC10",
            "CauseCodeId": null,
            "CauseCode": null,
            "ResolutionCodeId": null,
            "ResolutionCode": null,
            "AssetDownFlag": true,
            "AvailableDate": null,
            "FailureDate": "2020-09-08T19:00:28+00:00",
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceSystemId": null,
            "SourceSystemType": "ORA_INTERNAL",
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "MeterUnitOfMeasure": null,
            "CompletionDate": null,
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "ItemDescription": "Professional combined Bench Grinder Fervi\n",
            "ItemNumber": "F/0554",
            "ItemLongDescription": null,
            "FailedComponentItemDescription": "ZS5-4 Storage Appliance",
            "InventoryItemId": 300100114215977,
            "ItemOrganizationId": 300100113363336,
            "FailedComponentItemLongDescription": null,
            "WorkOrderId": 300100209286627,
            "WorkOrderNumber": "2004_MNTWO2",
            "WorkOrderDescription": null,
            "FailedComponentAssetDescription": null,
            "FailureSeverityName": null,
            "FailureStatusName": null,
            "AssetCriticalityName": null,
            "AssetCriticalityCode": null,
            "ItemOrganizationCode": "MNTALM",
            "ItemCategoryId": null,
            "ItemCategoryName": null,
            "ItemCategoryCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552615493",
                    "name": "assetFailureEventInstances",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                
        {
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-11T13:26:49.374+00:00",
            "FailedComponentAssetNumber": null,
            "AssetNumber": "Forklift Asset 01",
            "FailedComponentItemNumber": "ZS5-4 Storage Appliance",
            "FailedComponentItemId": 300100170554049,
            "FailedComponentSerialNumber": null,
            "FailureComments": null,
            "FailureEventId": 300100552614957,
            "FailureInstanceId": 300100552614960,
            "LastUpdateDate": "2022-01-11T13:26:49.375+00:00",
            "LastUpdateLogin": "D53C3992371E4F54E053D45AF00A0E78",
            "LastUpdatedBy": "MNT_QA",
            "FailureSeverityCode": null,
            "FailureStatusCode": null,
            "AssetId": 300100541412510,
            "FailureName": "Failure Code 10",
            "FailureDescription": "Failure Code 10",
            "CauseDescription": null,
            "CauseName": null,
            "ResolutionDescription": null,
            "ResolutionName": null,
            "AssetDescription": "Forklift Asset 01",
            "FailureCodeId": 300100552614657,
            "FailureCode": "FC10",
            "CauseCodeId": null,
            "CauseCode": null,
            "ResolutionCodeId": null,
            "ResolutionCode": null,
            "AssetDownFlag": true,
            "AvailableDate": null,
            "FailureDate": "2020-09-08T19:00:28+00:00",
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceSystemId": null,
            "SourceSystemType": "ORA_INTERNAL",
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "MeterUnitOfMeasure": null,
            "CompletionDate": null,
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "ItemDescription": "Warehouse Forklift",
            "ItemNumber": "SAPS-WRH-Forklift",
            "ItemLongDescription": null,
            "FailedComponentItemDescription": "ZS5-4 Storage Appliance",
            "InventoryItemId": 300100541389067,
            "ItemOrganizationId": 300100113363336,
            "FailedComponentItemLongDescription": null,
            "WorkOrderId": 300100542135663,
            "WorkOrderNumber": "OSP 102",
            "WorkOrderDescription": "Forklift OSP WD1",
            "FailedComponentAssetDescription": null,
            "FailureSeverityName": null,
            "FailureStatusName": null,
            "AssetCriticalityName": null,
            "AssetCriticalityCode": null,
            "ItemOrganizationCode": "MNTALM",
            "ItemCategoryId": null,
            "ItemCategoryName": null,
            "ItemCategoryCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552614960",
                    "name": "assetFailureEventInstances",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552614960",
                    "name": "assetFailureEventInstances",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances/300100552614960/child/rootCauses",
                    "name": "rootCauses",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEventInstances",
            "name": "assetFailureEventInstances",
            "kind": "collection"
        }
    ]
}

Get All Failure Event Instances with a Specific Failure Code

In this scenario, you you may choose to get all failure event instances with a specific failure code.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances/?finder=FailureCodeFinder;BindFailureCode=FC2"

Get All Failure Event Instances with a Specific Cause Code

In this scenario, you may choose to get all failure event instances with a specific cause code.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances/?finder=CauseCodeFinder;BindCauseCode=CC2"

Get All Failure Event Instances with a Specific Resolution Code

In this scenario, you may choose to get all failure event instances with a specific resolution code.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances/?finder=ResolutionCodeFinder;BindResolutionCode=RC1"

Get All Failure Event Instances with a Specific Failed Component Item Number

In this scenario, you may choose to get all failure event instances with a specific failed component item number.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances/?finder=FailedComponentItemNumberFinder;BindFailedComponentItemNumber=ZS5-4 Storage Appliance"

Get All Failure Event Instances with a Specific Failed Component Asset Number

In this scenario, you may choose to get all failure event instances with a specific failed component asset number.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances/?finder=FailedComponentAssetNumberFinder;BindFailedComponentAssetNumber=100100053526099"

Get All Failure Event Instances with a Specific Root Cause

In this scenario, you may choose to get all failure event instances with a specific root cause.

Example URL

Use this resource URL format.

GET

curl -u username:password -X GET -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d "https://servername/fscmRestApi/resources/latest/assetFailureEventInstances/?finder=RootCauseCodeFinder;BindRootCause=CC3"