Create a Failure Set

You can use REST API to create a failure set. Failure sets define the business rules around capturing failure events and failure instances. A failure set indicates whether or not specific failure-cause-resolution combinations are enforced for a given asset when failure data is captured. The failure-cause-resolution combination is referred to as a failure chain and the attribute that indicates whether only specifically defined chains are allowed is called the FailureChainsEnforcedFlag.

A failure set also indicates whether a failure-cause-resolution combination must be captured for a given asset before a technician can complete a work order in Oracle Fusion Cloud Maintenance on the Maintenance Dispatch List page. This is indicated by the CaptureRequiredCode attribute and applies only when using the Maintenance Dispatch List page, and not when completing work orders using REST APIs.

Associations define the set of assets to which a given failure set applies. Any and every asset must be uniquely associated to one and only one failure set. When a failure event is created, the associated failure set is determined based on the asset on the work order. Associations can be defined at the asset, item, or item category level, and these associations are unique across failure sets. The attribute ObjectTypeCode indicates whether the association is at the asset, item, or item category level.

There must also be one and only one failure set with an ObjectTypeCode of type ORA_ALL, which is the default failure set with which any asset is associated if an association is not otherwise explicitly defined. This allows a business to define a single default failure set that can apply to all assets. For businesses that don't want to enforce failure chains or mandate failure capture differently for different assets, having a single failure set with ObjectTypeCode of ORA_ALL is sufficient setup. For businesses that want to enforce failures chains differently for different assets, but don't want to wait to start capturing failure data until all the different failure chains are defined for each asset, creating a default failure set with ObjectTypeCode of ORA_ALL enables capturing failures while iteratively defining and refining other, more specific, failure sets. This allows continuous improvement of data governance and is often done in conjunction with a Failure Modes and Effects Analysis (FMEA) process.

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

  1. You create a default failure set for which specific failure-cause-resolution combinations aren't enforced when capturing failure data.
  2. You create a failure set in which specific failure-cause-resolution combinations are enforced when capturing failure data for a specific asset, item, and item category.
  3. You may choose to add another failure association.
  4. You may choose to add another failure chain.
  5. You may choose to update an existing failure set.
  6. You may choose to disable an existing failure association.
  7. You may choose to disable an existing failure chain.
  8. You may choose to disable an existing failure set.

Create a Default Failure Set

In this scenario, you create a failure set for which specific failure-cause-resolution combinations aren't enforced when capturing failure data. This is indicated by passing the value FALSE for the attribute FailureChainsEnforcedFlag. To indicate that the failure set applies to any asset that isn't otherwise explicitly associated with another failure set, the value ORA_ALL is passed for the attribute ObjectTypeCode. This setup is the default failure set in most organizations, and is also the one and only failure set defined for businesses that don't require asset-specific failure chains.

Example URL

Use this resource URL format.

POST

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

Example Request

This table shows the typical attributes to create a default failure set:

Table -

Value Description
FailureSetCode Alphanumeric code that uniquely identifies a failure set. It's mandatory when creating a failure set.
FailureSetName Name of the failure set. It's mandatory when creating a failure set. It corresponds to one and only one FailureSetCode.
FailureSetDescription Free-text description of a failure set. Optional.
FailureChainsEnforcedFlag Boolean value that indicates whether or not specific failure-cause-resolution combinations are enforced for a given asset when failure data is captured. The attribute value is either true or false. When no value is passed, the default value is false.
ObjectTypeCode An indicator of whether a failure set is associated with any of these:
  • A specific asset (ORA_ASSET)
  • All assets for a given type of item (ORA_ITEM)
  • All assets that belong to a given item category (ORA_CATEGORY)
  • Any asset not otherwise specifically associated with a failure set (ORA_ALL)

These associations are unique across failure sets, and any and every asset must be uniquely associated to one and only one failure set. There must always be one and only one failure set with a failure association where ObjectTypeCode is ORA_ALL.

Here's an example of the request body in JSON format.
{
    "FailureSetCode": "FS001",
    "FailureSetName": "FS001",
    "FailureChainsEnforcedFlag": false,
    "FailureSetDescription": "FS001",
    "failureAssociations": [
        {
            "ObjectTypeCode": "ORA_ALL",
            "CaptureRequiredCode": "N"
        }
    ]
}

Example Response

Here's an example of the response body in JSON format.

{
    "FailureSetId": 300100552631042,
    "FailureSetCode": "FS001",
    "FailureSetName": "FS001",
    "ActiveEndDate": null,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-11T14:30:56+00:00",
    "FailureChainsEnforcedFlag": false,
    "FailureSetDescription": "FS001",
    "LastUpdateDate": "2022-01-11T14:30:56.374+00:00",
    "LastUpdateLogin": "D53C398B038B4F56E053D45AF00A023C",
    "LastUpdatedBy": "MNT_QA",
    "FailureSetDisableFlag": null,
    "failureAssociations": [
        {
            "ActiveEndDate": null,
            "CaptureRequiredCode": "N",
            "CaptureRequiredName": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-11T14:30:56.277+00:00",
            "FailureSetId": 300100552631042,
            "LastUpdateDate": "2022-01-11T14:30:56.375+00:00",
            "LastUpdateLogin": "D53C398B038B4F56E053D45AF00A023C",
            "LastUpdatedBy": "MNT_QA",
            "ObjectTypeCode": "ORA_ALL",
            "SetAssociationId": 300100552631043,
            "AssetId": null,
            "ItemNumber": null,
            "AssetNumber": null,
            "OrganizationCode": null,
            "FailureAssociationDisableFlag": null,
            "ItemCategoryCode": null,
            "ItemCategoryName": null,
            "AssetDescription": null,
            "ItemCategoryId": null,
            "ItemId": null,
            "ItemOrganizationCode": null,
            "ItemOrganizationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042/child/failureAssociations/300100552631043",
                    "name": "failureAssociations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042/child/failureAssociations/300100552631043",
                    "name": "failureAssociations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042",
                    "name": "assetFailureSets",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042",
            "name": "assetFailureSets",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042",
            "name": "assetFailureSets",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042/child/failureAssociations",
            "name": "failureAssociations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552631042/child/failureChains",
            "name": "failureChains",
            "kind": "collection"
        }
    ]
}

Create a Failure Set to Enforce Specific Failure-Cause-Resolution Combinations

In this scenario, you create a failure set in which specific failure-cause-resolution combinations are enforced when capturing failure data for a specific asset, item, and item category. This is often required for compliance in regulated industries, to ensure conformance with a Failure Modes and Effects Analysis (FMEA) process, or just for good data governance.

Example URL

Use this resource URL format.

POST

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

Example Request

This table shows the typical attributes to create a failure set with specific failure-cause-resolution combinations:

Table -

Value Description
FailureSetCode Alphanumeric code that uniquely identifies a failure set. It's mandatory when creating a failure set.
FailureSetName Name of the failure set. It's mandatory when creating a failure set. It corresponds to one and only one FailureSetCode.
FailureSetDescription Free-text description of a failure set. Optional.
FailureChainsEnforcedFlag Boolean value that indicates whether or not specific failure-cause-resolution combinations are enforced for a given asset when failure data is captured. Attribute value is either true or false. When no value is passed, the default value is false.
ObjectTypeCode An indicator of whether a failure set is associated with either of these:
  • A specific asset (ORA_ASSET)
  • All assets for a given type of item (ORA_ITEM)
  • All assets that belong to a given item category (ORA_CATEGORY)
  • Any asset not otherwise specifically associated with a failure set (ORA_ALL)

These associations are unique across failure sets, and any and every asset must be uniquely associated with one and only one failure set. There must always be one and only one failure set with a failure association where ObjectTypeCode is ORA_ALL.

AssetId A system generated, non-updatable value that uniquely identifies an asset. When ObjectTypeCode is ORA_ASSET, either AssetId or AssetNumber must be passed. If both AssetId and AssetNumber are passed, only AssetId is used.
AssetNumber A value that uniquely identifies an asset. When ObjectTypeCode is ORA_ASSET, either AssetId or AssetNumber must be passed. If both AssetId and AssetNumber are passed, only AssetId is used.
ItemNumber A value that uniquely identifies an item. When ObjectTypeCode is ORA_ ITEM, ItemNumber must be passed along with the OrganizationCode.

Note:

OrganizationCode is passed for data validation, but the association is created for any ItemNumber in any organization.
OrganizationCode A value that uniquely identifies an inventory organization. When ObjectTypeCode is ORA_ ITEM, OrganizationCode must be passed along with ItemNumber.
ItemCategoryCode A value that uniquely identifies an item category within the item catalog identified by the profile option ORA_CSE_ITEM_CATALOG. This profile indicates that the item catalog is used for categorizing maintainable assets. When ObjectTypeCode is ORA_ CATEGORY, ItemCategoryCode must be passed.
CaptureRequiredCode An indicator of whether a failure-cause-resolution combination must be captured for a given asset before a technician can complete a work order in Oracle Fusion Cloud Maintenance on the Maintenance Dispatch List page. Valid values are Y or N. The default value is N if no value is passed. Note that this attribute is not used or validated when completing work orders using REST APIs.
FailureCode Abbreviation that uniquely identifies a mode of failure. The failure code is not required, but if entered it must be a valid code. A failure code is a condition event with a ConditionEventTypeCode of FAILURE.
CauseCode Abbreviation that uniquely identifies the failure mechanism or apparent cause of failure. The cause code is not required, but if entered it must be a valid code. A cause code is a condition event with a ConditionEventTypeCode of CAUSE.
ResolutionCode Abbreviation that uniquely identifies how a failure was resolved. The resolution code is not required, but if entered it must be a valid code. A resolution code is a condition event with a ConditionEventTypeCode of RESOLUTION.

Here's an example of the request body in JSON format.

{
    "FailureSetCode": "FS02",
    "FailureSetName": "FS02",
    "FailureChainsEnforcedFlag": true,
    "FailureSetDescription": "FS02",
    "failureAssociations": [
        {
            "ObjectTypeCode": "ORA_ASSET",
            "AssetNumber": "Exadata Database Server"
        },
        {
            "ObjectTypeCode": "ORA_ITEM",
            "ItemNumber": "MNTSCMALMCDRMITEM",
            "OrganizationCode": "MNTALM"
        },
        {
            "ObjectTypeCode": "ORA_CATEGORY",
            "ItemCategoryCode": "ASSEMBLY.MISC"
        }
    ],
    "failureChains": [
        {
            "FailureCode": "FC1",
            "CauseCode": "CC1",
            "ResolutionCode": "RC1"
        },
        {
            "FailureCode": "FC1",
            "CauseCode": "CC1",
            "ResolutionCode": "RC2"
        }
    ]
}

Example Response

Here's an example of the response body in JSON format.

{
    "FailureSetId": 300100552987036,
    "FailureSetCode": "FS02",
    "FailureSetName": "FS02",
    "ActiveEndDate": null,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-12T13:17:38+00:00",
    "FailureChainsEnforcedFlag": true,
    "FailureSetDescription": "FS02",
    "LastUpdateDate": "2022-01-12T13:17:38.090+00:00",
    "LastUpdateLogin": "D53C398FBEC54F60E053D45AF00A0AC4",
    "LastUpdatedBy": "MNT_QA",
    "FailureSetDisableFlag": null,
    "failureAssociations": [
        {
            "ActiveEndDate": null,
            "CaptureRequiredCode": "N",
            "CaptureRequiredName": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-12T13:17:38.010+00:00",
            "FailureSetId": 300100552987036,
            "LastUpdateDate": "2022-01-12T13:17:38.090+00:00",
            "LastUpdateLogin": "D53C398FBEC54F60E053D45AF00A0AC4",
            "LastUpdatedBy": "MNT_QA",
            "ObjectTypeCode": "ORA_ASSET",
            "SetAssociationId": 300100552987037,
            "AssetId": 300100181567774,
            "ItemNumber": null,
            "AssetNumber": "Exadata Database Server",
            "OrganizationCode": null,
            "FailureAssociationDisableFlag": null,
            "ItemCategoryCode": null,
            "ItemCategoryName": null,
            "AssetDescription": "Exadata Database Server",
            "ItemCategoryId": null,
            "ItemId": null,
            "ItemOrganizationCode": null,
            "ItemOrganizationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987037",
                    "name": "failureAssociations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987037",
                    "name": "failureAssociations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
                    "name": "assetFailureSets",
                    "kind": "item"
                }
            ]
        },
        {
            "ActiveEndDate": null,
            "CaptureRequiredCode": "N",
            "CaptureRequiredName": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-12T13:17:38.020+00:00",
            "FailureSetId": 300100552987036,
            "LastUpdateDate": "2022-01-12T13:17:38.090+00:00",
            "LastUpdateLogin": "D53C398FBEC54F60E053D45AF00A0AC4",
            "LastUpdatedBy": "MNT_QA",
            "ObjectTypeCode": "ORA_ITEM",
            "SetAssociationId": 300100552987038,
            "AssetId": null,
            "ItemNumber": "MNTSCMALMCDRMITEM",
            "AssetNumber": null,
            "OrganizationCode": "MNTALM",
            "FailureAssociationDisableFlag": null,
            "ItemCategoryCode": null,
            "ItemCategoryName": null,
            "AssetDescription": null,
            "ItemCategoryId": null,
            "ItemId": null,
            "ItemOrganizationCode": null,
            "ItemOrganizationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987038",
                    "name": "failureAssociations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987038",
                    "name": "failureAssociations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
                    "name": "assetFailureSets",
                    "kind": "item"
                }
            ]
        },
        {
            "ActiveEndDate": null,
            "CaptureRequiredCode": "N",
            "CaptureRequiredName": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-12T13:17:38.030+00:00",
            "FailureSetId": 300100552987036,
            "LastUpdateDate": "2022-01-12T13:17:38.090+00:00",
            "LastUpdateLogin": "D53C398FBEC54F60E053D45AF00A0AC4",
            "LastUpdatedBy": "MNT_QA",
            "ObjectTypeCode": "ORA_CATEGORY",
            "SetAssociationId": 300100552987039,
            "AssetId": null,
            "ItemNumber": null,
            "AssetNumber": null,
            "OrganizationCode": null,
            "FailureAssociationDisableFlag": null,
            "ItemCategoryCode": "ASSEMBLY.MISC",
            "ItemCategoryName": null,
            "AssetDescription": null,
            "ItemCategoryId": 83,
            "ItemId": null,
            "ItemOrganizationCode": null,
            "ItemOrganizationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987039",
                    "name": "failureAssociations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987039",
                    "name": "failureAssociations",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
                    "name": "assetFailureSets",
                    "kind": "item"
                }
            ]
        }
    ],
    "failureChains": [
        {
            "ActiveEndDate": null,
            "CauseCodeId": 300100552656731,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-12T13:17:38.051+00:00",
            "FailureChainId": 300100552987040,
            "FailureCodeId": 300100552651344,
            "FailureSetId": 300100552987036,
            "LastUpdateDate": "2022-01-12T13:17:38.090+00:00",
            "LastUpdateLogin": "D53C398FBEC54F60E053D45AF00A0AC4",
            "LastUpdatedBy": "MNT_QA",
            "ResolutionCodeId": 300100552656762,
            "FailureCode": "FC1",
            "CauseCode": "CC1",
            "ResolutionCode": "RC1",
            "FailureChainDisableFlag": null,
            "FailureName": "Failure Code 1",
            "FailureDescription": "Failure Code 1",
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseName": "CC1",
            "CauseDescription": "CC1",
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionName": "RC1",
            "ResolutionDescription": "RC1",
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987040",
                    "name": "failureChains",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987040",
                    "name": "failureChains",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
                    "name": "assetFailureSets",
                    "kind": "item"
                }
            ]
        },
        {
            "ActiveEndDate": null,
            "CauseCodeId": 300100552656731,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2022-01-12T13:17:38.070+00:00",
            "FailureChainId": 300100552987041,
            "FailureCodeId": 300100552651344,
            "FailureSetId": 300100552987036,
            "LastUpdateDate": "2022-01-12T13:17:38.091+00:00",
            "LastUpdateLogin": "D53C398FBEC54F60E053D45AF00A0AC4",
            "LastUpdatedBy": "MNT_QA",
            "ResolutionCodeId": 300100552656849,
            "FailureCode": "FC1",
            "CauseCode": "CC1",
            "ResolutionCode": "RC2",
            "FailureChainDisableFlag": null,
            "FailureName": "Failure Code 1",
            "FailureDescription": "Failure Code 1",
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseName": "CC1",
            "CauseDescription": "CC1",
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionName": "RC2",
            "ResolutionDescription": "RC2",
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987041",
                    "name": "failureChains",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987041",
                    "name": "failureChains",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
                    "name": "assetFailureSets",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
            "name": "assetFailureSets",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
            "name": "assetFailureSets",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations",
            "name": "failureAssociations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains",
            "name": "failureChains",
            "kind": "collection"
        }
    ]
}

Create a New Failure Association for an Existing Failure Set

In this scenario, you create a new failure association for an existing failure set.

Example URL

Use this resource URL format.

POST

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/latest/assetFailureSets/FailureSetId/child/failureAssociations"

Example Request

Here's an example of the request body in JSON format.

{
    "ObjectTypeCode": "ORA_ASSET",
    "AssetNumber": "RCL_AS54888_A1"
}

Example Response

Here's an example of the response body in JSON format.

{
    "ActiveEndDate": null,
    "CaptureRequiredCode": "N",
    "CaptureRequiredName": null,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-12T13:23:22+00:00",
    "FailureSetId": 300100552987036,
    "LastUpdateDate": "2022-01-12T13:23:22.033+00:00",
    "LastUpdateLogin": "D53C3A160E674F72E053D45AF00A885A",
    "LastUpdatedBy": "MNT_QA",
    "ObjectTypeCode": "ORA_ASSET",
    "SetAssociationId": 300100552987044,
    "AssetId": 300100206454694,
    "ItemNumber": null,
    "AssetNumber": "RCL_AS54888_A1",
    "OrganizationCode": null,
    "FailureAssociationDisableFlag": null,
    "ItemCategoryCode": null,
    "ItemCategoryName": null,
    "AssetDescription": "RCL_AS54888_Desc",
    "ItemCategoryId": null,
    "ItemId": null,
    "ItemOrganizationCode": null,
    "ItemOrganizationId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987044",
            "name": "failureAssociations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987044",
            "name": "failureAssociations",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
            "name": "assetFailureSets",
            "kind": "item"
        }
    ]
}

Create a New Failure Chain for an Existing Failure Set

In this scenario, you create a new failure chain for an existing failure set.

Example URL

Use this resource URL format.

POST

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/latest/assetFailureSets/FailureSetId/child/failureChains"

Example Request

Here's an example of the request body in JSON format.

{
    "FailureCode": "FC1",
    "CauseCode": "CC2",
    "ResolutionCode": "RC1"
}

Example Response

Here's an example of the response body in JSON format.

{
    "ActiveEndDate": null,
    "CauseCodeId": 300100552987045,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-12T13:28:18+00:00",
    "FailureChainId": 300100552987046,
    "FailureCodeId": 300100552651344,
    "FailureSetId": 300100552987036,
    "LastUpdateDate": "2022-01-12T13:28:18.026+00:00",
    "LastUpdateLogin": "D53C398AEBD94F44E053D45AF00A037C",
    "LastUpdatedBy": "MNT_QA",
    "ResolutionCodeId": 300100552656762,
    "FailureCode": "FC1",
    "CauseCode": "CC2",
    "ResolutionCode": "RC1",
    "FailureChainDisableFlag": null,
    "FailureName": "Failure Code 1",
    "FailureDescription": "Failure Code 1",
    "FailureCategoryCode": null,
    "FailureCategoryName": null,
    "CauseName": "CC2",
    "CauseDescription": "CC2",
    "CauseCategoryCode": null,
    "CauseCategoryName": null,
    "ResolutionName": "RC1",
    "ResolutionDescription": "RC1",
    "ResolutionCategoryCode": null,
    "ResolutionCategoryName": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987046",
            "name": "failureChains",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987046",
            "name": "failureChains",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
            "name": "assetFailureSets",
            "kind": "item"
        }
    ]
}

Update an Existing Failure Set

In this scenario, you update an existing failure set by changing FailureSetDescription and setting FailureChainsEnforcedFlag to FALSE. This means the system will not enforce any specific failure-cause-resolution combinations when entering failure data for assets to which the failure set applies.

Example URL

Use this resource URL format.

PATCH

curl -u username:password -X PATCH -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/latest/assetFailureSets/FailureSetId"

Example Request

Here's an example of the request body in JSON format.

{
    "FailureChainsEnforcedFlag": false,
    "FailureSetDescription": "FS005 - Failure Chains Not Enforced"
}

Example Response

Here's an example of the response body in JSON format.

{
    "FailureSetId": 300100552657088,
    "FailureSetCode": "FS005",
    "FailureSetName": "FS005",
    "ActiveEndDate": null,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-11T16:17:56+00:00",
    "FailureChainsEnforcedFlag": false,
    "FailureSetDescription": "FS005 - Failure Chains Not Enforced",
    "LastUpdateDate": "2022-01-12T12:11:33+00:00",
    "LastUpdateLogin": "D53C3A160AF94F72E053D45AF00A885A",
    "LastUpdatedBy": "MNT_QA",
    "FailureSetDisableFlag": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088",
            "name": "assetFailureSets",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088",
            "name": "assetFailureSets",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088/child/failureAssociations",
            "name": "failureAssociations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088/child/failureChains",
            "name": "failureChains",
            "kind": "collection"
        }
    ]
}

Disable an Existing Failure Association

In this scenario, you disable an existing failure association. Note that the failure association of type ORA_ALL cannot be disabled, as there must always be one and only one failure set with the ORA_ALL association.

Example URL

Use this resource URL format.

PATCH

curl -u username:password -X PATCH -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/latest/assetFailureSets/300100552987036/child/failureAssociations/SetAssociationId"

Example Request

Here's an example of the request body in JSON format.

{
    "FailureAssociationDisableFlag": true
}

Example Response

Here's an example of the response body in JSON format.

{
    "ActiveEndDate": "2022-01-12T13:43:51.914+00:00",
    "CaptureRequiredCode": "N",
    "CaptureRequiredName": "No",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-12T13:17:38.010+00:00",
    "FailureSetId": 300100552987036,
    "LastUpdateDate": "2022-01-12T13:43:51+00:00",
    "LastUpdateLogin": "D53C3992B3184F66E053D45AF00A6B57",
    "LastUpdatedBy": "MNT_QA",
    "ObjectTypeCode": "ORA_ASSET",
    "SetAssociationId": 300100552987037,
    "AssetId": 300100181567774,
    "ItemNumber": null,
    "AssetNumber": "Exadata Database Server",
    "OrganizationCode": null,
    "FailureAssociationDisableFlag": true,
    "ItemCategoryCode": null,
    "ItemCategoryName": null,
    "AssetDescription": "Exadata Database Server",
    "ItemCategoryId": null,
    "ItemId": null,
    "ItemOrganizationCode": null,
    "ItemOrganizationId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987037",
            "name": "failureAssociations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureAssociations/300100552987037",
            "name": "failureAssociations",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
            "name": "assetFailureSets",
            "kind": "item"
        }
    ]
}

Disable an Existing Failure Chain

In this scenario, you disable an existing failure chain.

Example URL

Use this resource URL format.

PATCH

curl -u username:password -X PATCH -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/latest/assetFailureSets/300100552987036/child/failureChains/FailureChainId"

Example Request

Here's an example of the request body in JSON format.

{
    "FailureChainDisableFlag": true
}

Example Response

Here's an example of the response body in JSON format.

{
    "ActiveEndDate": "2022-01-12T13:48:09+00:00",
    "CauseCodeId": 300100552656731,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-12T13:17:38.051+00:00",
    "FailureChainId": 300100552987040,
    "FailureCodeId": 300100552651344,
    "FailureSetId": 300100552987036,
    "LastUpdateDate": "2022-01-12T13:48:09+00:00",
    "LastUpdateLogin": "D53C39925BAC4F64E053D45AF00A4E34",
    "LastUpdatedBy": "MNT_QA",
    "ResolutionCodeId": 300100552656762,
    "FailureCode": "FC1",
    "CauseCode": "CC1",
    "ResolutionCode": "RC1",
    "FailureChainDisableFlag": true,
    "FailureName": "Failure Code 1",
    "FailureDescription": "Failure Code 1",
    "FailureCategoryCode": null,
    "FailureCategoryName": null,
    "CauseName": "CC1",
    "CauseDescription": "CC1",
    "CauseCategoryCode": null,
    "CauseCategoryName": null,
    "ResolutionName": "RC1",
    "ResolutionDescription": "RC1",
    "ResolutionCategoryCode": null,
    "ResolutionCategoryName": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987040",
            "name": "failureChains",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036/child/failureChains/300100552987040",
            "name": "failureChains",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552987036",
            "name": "assetFailureSets",
            "kind": "item"
        }
    ]
}

Disable an Existing Failure Set

In this scenario, you disable an existing failure set.

Example URL

Use this resource URL format.

PATCH

curl -u username:password -X PATCH -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/latest/assetFailureSets/FailureSetId"

Example Request

Here's an example of the request body in JSON format.

{
    "FailureSetDisableFlag": true
}

Example Response

Here's an example of the response body in JSON format.

{
    "FailureSetId": 300100552657088,
    "FailureSetCode": "FS005",
    "FailureSetName": "FS005",
    "ActiveEndDate": "2022-01-12T13:48:09+00:00",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2022-01-11T16:17:56+00:00",
    "FailureChainsEnforcedFlag": false,
    "FailureSetDescription": "FS005 - Failure Chains Not Enforced",
    "LastUpdateDate": "2022-01-12T12:11:33+00:00",
    "LastUpdateLogin": "D53C3A160AF94F72E053D45AF00A885A",
    "LastUpdatedBy": "MNT_QA",
    "FailureSetDisableFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088",
            "name": "assetFailureSets",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088",
            "name": "assetFailureSets",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088/child/failureAssociations",
            "name": "failureAssociations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureSets/300100552657088/child/failureChains",
            "name": "failureChains",
            "kind": "collection"
        }
    ]
}