Jump to

• Request
• Response
• Examples

POST

post

/fscmRestApi/resources/11.13.18.05/assetFailureEvents

Request

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetDescription: string
  Title: Asset Description
• AssetDownFlag: boolean
  Title: Asset Down

  Maximum Length: 1

  Default Value: true
• AssetId(required): integer (int64)
  Title: Asset ID
• AssetNumber: string
  Title: Asset Number
• AvailableDate: string (date-time)
  Title: Available Date
• CompletionDate: string (date-time)
  Title: WO Completion Date
• DaysBetweenFailure: number
  Title: TBF Days
• FailureDate: string (date-time)
  Title: Failure Date
• failureInstances: array Failure Instances
  Title: Failure Instances
• FailureSetId(required): integer (int64)
  Title: Failure Set ID
• ItemDescription: string
  Title: Item Description
• ItemId: integer
  Title: Item ID
• ItemLongDescription: string
  Title: Item Long Description
• ItemNumber: string
  Title: Item Number
• MeterUnitsBetweenFailure: number
  Title: TBF Meter Units
• OrganizationCode: string
  Title: Organization Code
• OrganizationId: integer
• RepairCost: number
  Title: Repair Cost
• SourceDocumentId: string
  Title: Source Document ID

  Maximum Length: 36
• SourceDocumentTypeCode: string
  Title: Source Doc Type Code

  Maximum Length: 30
• SourceSystem: string
  Title: Source Application Type
• SourceSystemId: integer (int64)
  Title: Source Application ID
• SourceSystemTypeCode(required): string
  Title: Source Application Type

  Maximum Length: 30
• TrackingObjectType: string
  Title: Tracking Object Type

  Maximum Length: 30
• TrackingObjectTypeCode: string
  Title: Tracking Object Type

  Maximum Length: 255
• UOMCode: string
  Title: TBF Meter Units UOM Code

  Maximum Length: 3
• WorkOrderDescription: string
  Title: Work Order Description
• WorkOrderId: integer
  Title: Work Order ID
• WorkOrderNumber: string
  Title: Work Order Number

  Maximum Length: 255

{
    "required":[
        "AssetId",
        "FailureSetId",
        "SourceSystemTypeCode"
    ],
    "type":"object",
    "properties":{
        "AssetDescription":{
            "title":"Asset Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "AssetDownFlag":{
            "title":"Asset Down",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetNumber":{
            "title":"Asset Number",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "AssetNum"
                ]
            }
        },
        "AvailableDate":{
            "title":"Available Date",
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "CompletionDate":{
            "title":"WO Completion Date",
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "DaysBetweenFailure":{
            "title":"TBF Days",
            "type":"number",
            "nullable":true
        },
        "FailureDate":{
            "title":"Failure Date",
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "FailureSetId":{
            "title":"Failure Set ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ItemLongDescription":{
            "title":"Item Long Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ItemNumber":{
            "title":"Item Number",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "MeterUnitsBetweenFailure":{
            "title":"TBF Meter Units",
            "type":"number",
            "nullable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "type":"string",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "nullable":true
        },
        "RepairCost":{
            "title":"Repair Cost",
            "type":"number",
            "nullable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "maxLength":36,
            "type":"string",
            "nullable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Doc Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SourceSystem":{
            "title":"Source Application Type",
            "type":"string",
            "nullable":true
        },
        "SourceSystemId":{
            "title":"Source Application ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceSystemTypeCode":{
            "title":"Source Application Type",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "TrackingObjectType":{
            "title":"Tracking Object Type",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "TrackingObjectTypeCode":{
            "title":"Tracking Object Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "UOMCode":{
            "title":"TBF Meter Units UOM Code",
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "WorkOrderDescription":{
            "title":"Work Order Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "WorkOrderNumber":{
            "title":"Work Order Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "WorkOrderNum"
                ]
            }
        },
        "failureInstances":{
            "title":"Failure Instances",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/assetFailureEvents-failureInstances-item-post-request"
            }
        }
    }
}

Nested Schema : Failure Instances

Type: array

Title: Failure Instances

Show Source

• Array of: object schema

{
    "title":"Failure Instances",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/assetFailureEvents-failureInstances-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AssetCriticalityName: string
  Title: Asset Criticality Name

  Maximum Length: 255
• CauseCode: string
  Title: Cause Code
• CauseCodeId: integer (int64)
  Title: Cause Code ID
• FailedAssetId: integer (int64)
  Title: Failed Asset ID
• FailedComponentAssetNumber: string
  Title: Failed Asset Number
• FailedComponentItemId: integer (int64)
  Title: Failed Item ID
• FailedComponentItemNumber: string
  Title: Failed Item Number
• FailedComponentSerialNumber: string
  Title: Failed Serial Number

  Maximum Length: 80
• FailureCode: string
  Title: Failure Code
• FailureCodeId: integer (int64)
  Title: Failure Code ID
• FailureComments: string
  Title: Failure Comments

  Maximum Length: 2000
• FailureEventId(required): integer (int64)
  Title: Failure Event ID
• FailureSeverityCode: string
  Title: Severity Code

  Maximum Length: 30
• FailureSeverityName: string
  Title: Severity Name

  Maximum Length: 255
• FailureStatusCode: string
  Title: Status Code

  Maximum Length: 30
• FailureStatusName: string
  Title: Status Name

  Maximum Length: 255
• OperationSequenceNumber: number
  Title: Operation Sequence
• ResolutionCode: string
  Title: Resolution Code
• ResolutionCodeId: number
  Title: Resolution Code ID
• rootCauses: array Failure Root Causes
  Title: Failure Root Causes
• WoOperationId: integer (int64)

{
    "required":[
        "FailureEventId"
    ],
    "type":"object",
    "properties":{
        "AssetCriticalityName":{
            "title":"Asset Criticality Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "CauseCode":{
            "title":"Cause Code",
            "type":"string",
            "nullable":true
        },
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "FailedAssetId":{
            "title":"Failed Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FailedComponentAssetNumber":{
            "title":"Failed Asset Number",
            "type":"string",
            "nullable":true
        },
        "FailedComponentItemId":{
            "title":"Failed Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FailedComponentItemNumber":{
            "title":"Failed Item Number",
            "type":"string",
            "nullable":true
        },
        "FailedComponentSerialNumber":{
            "title":"Failed Serial Number",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "FailureCode":{
            "title":"Failure Code",
            "type":"string",
            "nullable":false
        },
        "FailureCodeId":{
            "title":"Failure Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "FailureComments":{
            "title":"Failure Comments",
            "maxLength":2000,
            "type":"string",
            "nullable":true
        },
        "FailureEventId":{
            "title":"Failure Event ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FailureSeverityCode":{
            "title":"Severity Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "FailureSeverityName":{
            "title":"Severity Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "FailureStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "FailureStatusName":{
            "title":"Status Name",
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "nullable":true
        },
        "ResolutionCode":{
            "title":"Resolution Code",
            "type":"string",
            "nullable":true
        },
        "ResolutionCodeId":{
            "title":"Resolution Code ID",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "WoOperationId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "rootCauses":{
            "title":"Failure Root Causes",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/assetFailureEvents-failureInstances-rootCauses-item-post-request"
            }
        }
    }
}

Nested Schema : Failure Root Causes

Type: array

Title: Failure Root Causes

Show Source

• Array of: object schema

{
    "title":"Failure Root Causes",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/assetFailureEvents-failureInstances-rootCauses-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CauseCodeId: integer (int64)
  Title: Cause Code ID
• FailureInstanceId: integer (int64)
  Title: Failure Instance ID
• RootCauseCode: string
  Title: Cause Code
• RootCauseComments: string
  Title: Comments

  Maximum Length: 2000

{
    "type":"object",
    "properties":{
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FailureInstanceId":{
            "title":"Failure Instance ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RootCauseCode":{
            "title":"Cause Code",
            "type":"string",
            "nullable":true
        },
        "RootCauseComments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : assetFailureEvents-item-response

Type: object

Show Source

• AssetDescription: string
  Title: Asset Description
• AssetDownFlag: boolean
  Title: Asset Down

  Maximum Length: 1

  Default Value: true
• AssetId: integer (int64)
  Title: Asset ID
• AssetNumber: string
  Title: Asset Number
• AvailableDate: string (date-time)
  Title: Available Date
• CompletionDate: string (date-time)
  Title: WO Completion Date
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• DaysBetweenFailure: number
  Title: TBF Days
• FailureDate: string (date-time)
  Title: Failure Date
• FailureEventId: integer (int64)
  Title: Failure Event ID

  Read Only: true
• failureInstances: array Failure Instances
  Title: Failure Instances
• FailureSetCode: string
  Title: Failure Set Code

  Read Only: true

  Maximum Length: 30
• FailureSetDescription: string
  Title: Failure Set Description

  Read Only: true

  Maximum Length: 540
• FailureSetId: integer (int64)
  Title: Failure Set ID
• FailureSetName: string
  Title: Failure Set Name

  Read Only: true

  Maximum Length: 240
• ItemDescription: string
  Title: Item Description
• ItemId: integer
  Title: Item ID
• ItemLongDescription: string
  Title: Item Long Description
• ItemNumber: string
  Title: Item Number
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterUnitsBetweenFailure: number
  Title: TBF Meter Units
• OrganizationCode: string
  Title: Organization Code
• OrganizationId: integer
• RepairCost: number
  Title: Repair Cost
• SourceDocumentId: string
  Title: Source Document ID

  Maximum Length: 36
• SourceDocumentTypeCode: string
  Title: Source Doc Type Code

  Maximum Length: 30
• SourceDocumentTypeName: string
  Read Only: true

  Maximum Length: 320
• SourceSystem: string
  Title: Source Application Type
• SourceSystemId: integer (int64)
  Title: Source Application ID
• SourceSystemTypeCode: string
  Title: Source Application Type

  Maximum Length: 30
• SourceSystemTypeName: string
  Read Only: true

  Maximum Length: 80
• TrackingObjectType: string
  Title: Tracking Object Type

  Maximum Length: 30
• TrackingObjectTypeCode: string
  Title: Tracking Object Type

  Maximum Length: 255
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25
• UOMCode: string
  Title: TBF Meter Units UOM Code

  Maximum Length: 3
• WorkOrderDescription: string
  Title: Work Order Description
• WorkOrderId: integer
  Title: Work Order ID
• WorkOrderNumber: string
  Title: Work Order Number

  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "AssetDescription":{
            "title":"Asset Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssetDownFlag":{
            "title":"Asset Down",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "AssetNum"
                ]
            },
            "x-queryable":true
        },
        "AvailableDate":{
            "title":"Available Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"WO Completion Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysBetweenFailure":{
            "title":"TBF Days",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "FailureDate":{
            "title":"Failure Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FailureEventId":{
            "title":"Failure Event ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FailureSetCode":{
            "title":"Failure Set Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureSetDescription":{
            "title":"Failure Set Description",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureSetId":{
            "title":"Failure Set ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FailureSetName":{
            "title":"Failure Set Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemLongDescription":{
            "title":"Item Long Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterUnitsBetweenFailure":{
            "title":"TBF Meter Units",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "RepairCost":{
            "title":"Repair Cost",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "maxLength":36,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Doc Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentTypeName":{
            "maxLength":320,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source Application Type",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "title":"Source Application ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystemTypeCode":{
            "title":"Source Application Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSystemTypeName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackingObjectType":{
            "title":"Tracking Object Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TrackingObjectTypeCode":{
            "title":"Tracking Object Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"TBF Meter Units UOM Code",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderDescription":{
            "title":"Work Order Description",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "WorkOrderNum"
                ]
            },
            "x-queryable":true
        },
        "failureInstances":{
            "title":"Failure Instances",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/assetFailureEvents-failureInstances-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Failure Instances

Type: array

Title: Failure Instances

Show Source

• Array of: object assetFailureEvents-failureInstances-item-response

{
    "title":"Failure Instances",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/assetFailureEvents-failureInstances-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : assetFailureEvents-failureInstances-item-response

Type: object

Show Source

• AssetCriticalityCode: string
  Title: Asset Criticality Code

  Read Only: true

  Maximum Length: 30
• AssetCriticalityName: string
  Title: Asset Criticality Name

  Maximum Length: 255
• AssetDescription: string
  Title: Asset Description

  Read Only: true

  Maximum Length: 240
• AssetDownFlag: boolean
  Title: Asset Down

  Read Only: true

  Maximum Length: 1
• AssetId: integer (int64)
  Title: Asset ID

  Read Only: true
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 80
• AvailableDate: string (date-time)
  Title: Available Date

  Read Only: true
• CauseCategoryCode: string
  Title: Cause Category Code

  Read Only: true

  Maximum Length: 30
• CauseCategoryName: string
  Title: Cause Category Name

  Read Only: true
• CauseCode: string
  Title: Cause Code
• CauseCodeId: integer (int64)
  Title: Cause Code ID
• CauseDescription: string
  Title: Cause Description

  Read Only: true

  Maximum Length: 540
• CauseName: string
  Title: Cause Name

  Read Only: true

  Maximum Length: 240
• CompletionDate: string (date-time)
  Title: WO Completion Date

  Read Only: true
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• DaysBetweenFailure: number
  Title: TBF Days

  Read Only: true
• FailedAssetId: integer (int64)
  Title: Failed Asset ID
• FailedComponentAssetDescription: string
  Title: Failed Asset Description

  Read Only: true

  Maximum Length: 240
• FailedComponentAssetNumber: string
  Title: Failed Asset Number
• FailedComponentItemDescription: string
  Title: Failed Item Description

  Read Only: true

  Maximum Length: 240
• FailedComponentItemId: integer (int64)
  Title: Failed Item ID
• FailedComponentItemLongDescription: string
  Title: Failed Item Long Description

  Read Only: true

  Maximum Length: 4000
• FailedComponentItemNumber: string
  Title: Failed Item Number
• FailedComponentSerialNumber: string
  Title: Failed Serial Number

  Maximum Length: 80
• FailureCategoryCode: string
  Title: Failure Category Code

  Read Only: true

  Maximum Length: 30
• FailureCategoryName: string
  Title: Failure Category Name

  Read Only: true
• FailureCode: string
  Title: Failure Code
• FailureCodeId: integer (int64)
  Title: Failure Code ID
• FailureComments: string
  Title: Failure Comments

  Maximum Length: 2000
• FailureDate: string (date-time)
  Title: Failure Date

  Read Only: true
• FailureDescription: string
  Title: Failure Description

  Read Only: true

  Maximum Length: 540
• FailureEventId: integer (int64)
  Title: Failure Event ID
• FailureInstanceId: integer (int64)
  Title: Failure Instance ID

  Read Only: true
• FailureName: string
  Title: Failure Name

  Read Only: true

  Maximum Length: 240
• FailureSeverityCode: string
  Title: Severity Code

  Maximum Length: 30
• FailureSeverityName: string
  Title: Severity Name

  Maximum Length: 255
• FailureStatusCode: string
  Title: Status Code

  Maximum Length: 30
• FailureStatusName: string
  Title: Status Name

  Maximum Length: 255
• InventoryItemId: integer (int64)
  Title: Item Number

  Read Only: true
• ItemCategoryCode: string
  Read Only: true

  Maximum Length: 255
• ItemCategoryId: integer (int64)
  Read Only: true
• ItemCategoryName: string
  Read Only: true

  Maximum Length: 255
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240
• ItemLongDescription: string
  Title: Item Long Description

  Read Only: true

  Maximum Length: 4000
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300
• ItemOrganizationCode: string
  Read Only: true

  Maximum Length: 18
• ItemOrganizationId: integer (int64)
  Title: Organization

  Read Only: true
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterUnitOfMeasure: string
  Title: TBF Meter Units UOM Code

  Read Only: true

  Maximum Length: 3
• MeterUnitsBetweenFailure: number
  Title: TBF Meter Units

  Read Only: true
• OperationName: string
  Title: Name

  Read Only: true

  Maximum Length: 120
• OperationSequenceNumber: number
  Title: Operation Sequence
• RepairCost: number
  Title: Repair Cost

  Read Only: true
• ResolutionCategoryCode: string
  Title: Resolution Category Code

  Read Only: true

  Maximum Length: 30
• ResolutionCategoryName: string
  Title: Resolution Category Name

  Read Only: true
• ResolutionCode: string
  Title: Resolution Code
• ResolutionCodeId: number
  Title: Resolution Code ID
• ResolutionDescription: string
  Title: Resolution Description

  Read Only: true

  Maximum Length: 540
• ResolutionName: string
  Title: Resolution Name

  Read Only: true

  Maximum Length: 240
• rootCauses: array Failure Root Causes
  Title: Failure Root Causes
• SourceDocumentId: string
  Title: Source Document ID

  Read Only: true

  Maximum Length: 36
• SourceDocumentTypeCode: string
  Title: Source Doc Type Code

  Read Only: true

  Maximum Length: 30
• SourceSystemId: integer (int64)
  Title: Source Application ID

  Read Only: true
• SourceSystemType: string
  Title: Source Application Type

  Read Only: true

  Maximum Length: 30
• WoOperationId: integer (int64)
• WorkOrderDescription: string
  Title: Work Order Description

  Read Only: true

  Maximum Length: 240
• WorkOrderId: integer (int64)
  Title: Work Order ID

  Read Only: true
• WorkOrderNumber: string
  Title: Work Order Number

  Read Only: true

  Maximum Length: 120

{
    "type":"object",
    "properties":{
        "AssetCriticalityCode":{
            "title":"Asset Criticality Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetCriticalityName":{
            "title":"Asset Criticality Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetDownFlag":{
            "title":"Asset Down",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AvailableDate":{
            "title":"Available Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCategoryCode":{
            "title":"Cause Category Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCategoryName":{
            "title":"Cause Category Name",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCode":{
            "title":"Cause Code",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CauseDescription":{
            "title":"Cause Description",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseName":{
            "title":"Cause Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletionDate":{
            "title":"WO Completion Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysBetweenFailure":{
            "title":"TBF Days",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailedAssetId":{
            "title":"Failed Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FailedComponentAssetDescription":{
            "title":"Failed Asset Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailedComponentAssetNumber":{
            "title":"Failed Asset Number",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailedComponentItemDescription":{
            "title":"Failed Item Description",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FailedComponentItemId":{
            "title":"Failed Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FailedComponentItemLongDescription":{
            "title":"Failed Item Long Description",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailedComponentItemNumber":{
            "title":"Failed Item Number",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailedComponentSerialNumber":{
            "title":"Failed Serial Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailureCategoryCode":{
            "title":"Failure Category Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureCategoryName":{
            "title":"Failure Category Name",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureCode":{
            "title":"Failure Code",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "FailureCodeId":{
            "title":"Failure Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FailureComments":{
            "title":"Failure Comments",
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailureDate":{
            "title":"Failure Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureDescription":{
            "title":"Failure Description",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureEventId":{
            "title":"Failure Event ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FailureInstanceId":{
            "title":"Failure Instance ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FailureName":{
            "title":"Failure Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureSeverityCode":{
            "title":"Severity Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailureSeverityName":{
            "title":"Severity Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailureStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailureStatusName":{
            "title":"Status Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item Number",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCategoryCode":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategoryId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "ItemCategoryName":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLongDescription":{
            "title":"Item Long Description",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "title":"Organization",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterUnitOfMeasure":{
            "title":"TBF Meter Units UOM Code",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterUnitsBetweenFailure":{
            "title":"TBF Meter Units",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "RepairCost":{
            "title":"Repair Cost",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCategoryCode":{
            "title":"Resolution Category Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCategoryName":{
            "title":"Resolution Category Name",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCode":{
            "title":"Resolution Code",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCodeId":{
            "title":"Resolution Code ID",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResolutionDescription":{
            "title":"Resolution Description",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionName":{
            "title":"Resolution Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "maxLength":36,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Doc Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "title":"Source Application ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceSystemType":{
            "title":"Source Application Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderDescription":{
            "title":"Work Order Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order Number",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "rootCauses":{
            "title":"Failure Root Causes",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/assetFailureEvents-failureInstances-rootCauses-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Failure Root Causes

Type: array

Title: Failure Root Causes

Show Source

• Array of: object assetFailureEvents-failureInstances-rootCauses-item-response

{
    "title":"Failure Root Causes",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/assetFailureEvents-failureInstances-rootCauses-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : assetFailureEvents-failureInstances-rootCauses-item-response

Type: object

Show Source

• CauseCodeId: integer (int64)
  Title: Cause Code ID
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• FailureInstanceId: integer (int64)
  Title: Failure Instance ID
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RootCauseCategoryCode: string
  Title: Cause Category Code

  Read Only: true

  Maximum Length: 30
• RootCauseCategoryName: string
  Title: Cause Category Name

  Read Only: true

  Maximum Length: 255
• RootCauseCode: string
  Title: Cause Code
• RootCauseComments: string
  Title: Comments

  Maximum Length: 2000
• RootCauseDescription: string
  Title: Cause Description

  Read Only: true

  Maximum Length: 540
• RootCauseId: integer (int64)
  Title: Root Cause ID

  Read Only: true
• RootCauseName: string
  Title: Cause Name

  Read Only: true

  Maximum Length: 240

{
    "type":"object",
    "properties":{
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureInstanceId":{
            "title":"Failure Instance ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseCategoryCode":{
            "title":"Cause Category Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseCategoryName":{
            "title":"Cause Category Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseCode":{
            "title":"Cause Code",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RootCauseComments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RootCauseDescription":{
            "title":"Cause Description",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseId":{
            "title":"Root Cause ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RootCauseName":{
            "title":"Cause Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

failureInstances

Operation: /fscmRestApi/resources/11.13.18.05/assetFailureEvents/{FailureEventId}/child/failureInstances

Parameters:

• FailureEventId: $request.path.FailureEventId

Back to Top

Examples

Example cURL Command

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

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

Example 1

This example describes how to create an asset failure event.

Example 1 Request Body

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

{
        "SourceSystemType": "ORA_INTERNAL",
        "TrackingObjectCode": "ORA_WORK_ORDER",
        "WorkOrderId": 300100118458338,
        "FailureDate": "2020-09-08T19:00:28+00:00"
}

Example 1 Response Body

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

{
    "FailureEventId": 300100555216217,
    "TrackingObjectCode": "ORA_WORK_ORDER",
    "WorkOrderNumber": "0554 250717 1815",
    "WorkOrderId": 300100118458338,
    "WorkOrderDescription": null,
    "OrganizationCode": null,
    "OrganizationId": null,
    "FailureDate": "2020-09-08T19:00:28+00:00",
    "AvailableDate": null,
    "AssetDownIndicator": "Y",
    "AssetNumber": "F0554-03",
    "AssetId": 300100117993672,
    "AssetDescription": "Fervi Combined Bench Grinder",
    "ItemNumber": null,
    "ItemDescription": null,
    "ItemLongDescription": null,
    "FailureSetId": 300100554866737,
    "FailureSetCode": "Failure_SetCode_9999",
    "FailureSetDescription": "Failure Set Description 9999",
    "FailureSetName": null,
    "RepairCost": null,
    "SourceDocumentId": null,
    "SourceDocumentTypeCode": null,
    "SourceSystemId": null,
    "SourceSystemType": "ORA_INTERNAL",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2021-11-22T10:57:33+00:00",
    "LastUpdateDate": "2021-11-22T10:57:35.306+00:00",
    "LastUpdateLogin": "D14D1AD258FD60ECE053A9B1F20AF235",
    "LastUpdatedBy": "MNT_QA",
    "DaysBetweenFailure": null,
    "MeterUnitsBetweenFailure": null,
    "MeterUnitOfMeasure": null,
    "TrackingObjectType": "ORA_WORK_ORDER",
    "CompletionDate": null,
    "SourceSystem": null
}

Example 2

This example describes how to create a failure event and multiple failure instances.

Example 2 Request Body

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

{
    "SourceSystemType": "ORA_INTERNAL",
    "TrackingObjectCode": "ORA_WORK_ORDER",
    "WorkOrderId": 300100203687681,
    "FailureDate": "2020-09-08T19:00:28+00:00",
    "failureInstances": [
        {
            "FailureCode": "FC1",
            "CauseCode": "CC1",
            "ResolutionCode": "RC1",
            "FailureComments": "FailureComments"
        },
        {
            "FailureCode": "FC2",
            "CauseCode": "CC2",
            "ResolutionCode": "RC2",
            "FailureComments": "FailureComments"
        }
    ]
}

Example 2 Response Body

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

{
    "FailureEventId": 300100555291864,
    "TrackingObjectCode": "ORA_WORK_ORDER",
    "WorkOrderNumber": "SR0000046020.1",
    "WorkOrderId": 300100203687681,
    "WorkOrderDescription": null,
    "OrganizationCode": null,
    "OrganizationId": null,
    "FailureDate": "2020-09-08T19:00:28+00:00",
    "AvailableDate": null,
    "AssetDownIndicator": "Y",
    "AssetNumber": "RCL_AS54888_01",
    "AssetId": 300100203456720,
    "AssetDescription": "RCL_AS54888_01_Desc",
    "ItemNumber": null,
    "ItemDescription": null,
    "ItemLongDescription": null,
    "FailureSetId": 300100555253428,
    "FailureSetCode": "AB_FAILURE_SET_CODE05",
    "FailureSetDescription": null,
    "FailureSetName": "AB_Failure_Set_Name_05",
    "RepairCost": null,
    "SourceDocumentId": null,
    "SourceDocumentTypeCode": null,
    "SourceSystemId": null,
    "SourceSystemType": "ORA_INTERNAL",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2021-11-22T12:42:50+00:00",
    "LastUpdateDate": "2021-11-22T12:42:50.459+00:00",
    "LastUpdateLogin": "D14D1754B42B60F6E053A9B1F20A73C7",
    "LastUpdatedBy": "MNT_QA",
    "DaysBetweenFailure": null,
    "MeterUnitsBetweenFailure": null,
    "MeterUnitOfMeasure": null,
    "TrackingObjectType": "ORA_WORK_ORDER",
    "CompletionDate": null,
    "SourceSystem": null,
    "failureInstances": [
        {
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-22T12:42:50.460+00:00",
            "FailedComponentAssetNumber": null,
            "AssetNumber": null,
            "FailedComponentItemNumber": null,
            "FailedComponentItemId": null,
            "FailedComponentSerialNumber": null,
            "FailureComments": "FailureComments",
            "FailureEventId": 300100555291864,
            "FailureInstanceId": 300100555291865,
            "LastUpdateDate": "2021-11-22T12:42:50.460+00:00",
            "LastUpdateLogin": "D14D1754B42B60F6E053A9B1F20A73C7",
            "LastUpdatedBy": "MNT_QA",
            "FailureSeverityCode": null,
            "FailureStatusCode": null,
            "AssetId": null,
            "FailureName": "Failure Code 1",
            "FailureDescription": "Failure Code 1",
            "CauseDescription": "Cause Code 1",
            "CauseName": "Cause Code 1",
            "ResolutionDescription": "RC1",
            "ResolutionName": "RC1",
            "AssetDescription": null,
            "FailureCodeId": 300100555257834,
            "FailureCode": "FC1",
            "CauseCodeId": 300100555257950,
            "CauseCode": "CC1",
            "ResolutionCodeId": 300100555258073,
            "ResolutionCode": "RC1",
            "AssetDownFlag": null,
            "AvailableDate": null,
            "FailureDate": null,
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceSystemId": null,
            "SourceSystemType": null,
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "MeterUnitOfMeasure": null,
            "CompletionDate": null,
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "ItemDescription": null,
            "ItemNumber": null,
            "ItemLongDescription": null,
            "FailedComponentItemDescription": null,
            "InventoryItemId": null,
            "ItemOrganizationId": null,
            "FailedComponentItemLongDescription": null,
            "WorkOrderId": null,
            "WorkOrderNumber": null,
            "WorkOrderDescription": null,
            "FailedComponentAssetDescription": null,
            "FailureSeverityName": null,
            "FailureStatusName": null,
            "AssetCriticalityName": null,
            "AssetCriticalityCode": null,
            "ItemOrganizationCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances/300100555291865",
                    "name": "failureInstances",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances/300100555291865",
                    "name": "failureInstances",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864",
                    "name": "assetFailureEvents",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances/300100555291865/child/rootCauses",
                    "name": "rootCauses",
                    "kind": "collection"
                }
            ]
        },
        {
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-22T12:42:50.473+00:00",
            "FailedComponentAssetNumber": null,
            "AssetNumber": null,
            "FailedComponentItemNumber": null,
            "FailedComponentItemId": null,
            "FailedComponentSerialNumber": null,
            "FailureComments": "FailureComments",
            "FailureEventId": 300100555291864,
            "FailureInstanceId": 300100555291866,
            "LastUpdateDate": "2021-11-22T12:42:50.473+00:00",
            "LastUpdateLogin": "D14D1754B42B60F6E053A9B1F20A73C7",
            "LastUpdatedBy": "MNT_QA",
            "FailureSeverityCode": null,
            "FailureStatusCode": null,
            "AssetId": null,
            "FailureName": "Failure Code 2",
            "FailureDescription": "Failure Code 2",
            "CauseDescription": "Cause Code 2",
            "CauseName": "Cause Code 2",
            "ResolutionDescription": "RC2",
            "ResolutionName": "RC2",
            "AssetDescription": null,
            "FailureCodeId": 300100555257838,
            "FailureCode": "FC2",
            "CauseCodeId": 300100555257966,
            "CauseCode": "CC2",
            "ResolutionCodeId": 300100555258158,
            "ResolutionCode": "RC2",
            "AssetDownFlag": null,
            "AvailableDate": null,
            "FailureDate": null,
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceSystemId": null,
            "SourceSystemType": null,
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "MeterUnitOfMeasure": null,
            "CompletionDate": null,
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "ItemDescription": null,
            "ItemNumber": null,
            "ItemLongDescription": null,
            "FailedComponentItemDescription": null,
            "InventoryItemId": null,
            "ItemOrganizationId": null,
            "FailedComponentItemLongDescription": null,
            "WorkOrderId": null,
            "WorkOrderNumber": null,
            "WorkOrderDescription": null,
            "FailedComponentAssetDescription": null,
            "FailureSeverityName": null,
            "FailureStatusName": null,
            "AssetCriticalityName": null,
            "AssetCriticalityCode": null,
            "ItemOrganizationCode": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances/300100555291866",
                    "name": "failureInstances",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances/300100555291866",
                    "name": "failureInstances",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864",
                    "name": "assetFailureEvents",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances/300100555291866/child/rootCauses",
                    "name": "rootCauses",
                    "kind": "collection"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864",
            "name": "assetFailureEvents",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864",
            "name": "assetFailureEvents",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555291864/child/failureInstances",
            "name": "failureInstances",
            "kind": "collection"
        }
    ]
}

Example 3

This example describes how to create a failure event, a failure instance, and a root cause event.

Example 3 Request Body

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

{
        "SourceSystemType": "ORA_INTERNAL",
        "TrackingObjectCode": "ORA_WORK_ORDER",
        "WorkOrderId": 300100137341473,
        "FailureDate": "2020-09-08T19:00:28+00:00",
        "failureInstances":[
    {
        "FailureCode":"FC1",
        "CauseCode":"CC1", 
        "ResolutionCode":"RC1",
        "FailureComments":"FailureComments",   
        "rootCauses":[
            {
                "RootCauseCode":"CC1",
                "RootCauseComments":"Root Cause Comments"
            }
        ]
    }
]
}

Example 3 Response Body

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

{
    "FailureEventId": 300100555262352,
    "TrackingObjectCode": "ORA_WORK_ORDER",
    "WorkOrderNumber": "MA01 WO F0554-MA01",
    "WorkOrderId": 300100137341473,
    "WorkOrderDescription": "WO for Material Availability (MA) Demo",
    "OrganizationCode": null,
    "OrganizationId": null,
    "FailureDate": "2020-09-08T19:00:28+00:00",
    "AvailableDate": null,
    "AssetDownIndicator": "Y",
    "AssetNumber": "F0554-MA01",
    "AssetId": 300100137341331,
    "AssetDescription": "Fervi Combined Bench Grinder - To be used for Material Availability Demo",
    "ItemNumber": null,
    "ItemDescription": null,
    "ItemLongDescription": null,
    "FailureSetId": 300100555253428,
    "FailureSetCode": "AB_FAILURE_SET_CODE05",
    "FailureSetDescription": null,
    "FailureSetName": "AB_Failure_Set_Name_05",
    "RepairCost": null,
    "SourceDocumentId": null,
    "SourceDocumentTypeCode": null,
    "SourceSystemId": null,
    "SourceSystemType": "ORA_INTERNAL",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2021-11-22T12:04:10+00:00",
    "LastUpdateDate": "2021-11-22T12:04:17.128+00:00",
    "LastUpdateLogin": "D15D5EFD8D3D47B1E053A9B1F20A51B4",
    "LastUpdatedBy": "MNT_QA",
    "DaysBetweenFailure": null,
    "MeterUnitsBetweenFailure": null,
    "MeterUnitOfMeasure": null,
    "TrackingObjectType": "ORA_WORK_ORDER",
    "CompletionDate": null,
    "SourceSystem": null,
    "failureInstances": [
        {
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-22T12:04:17.129+00:00",
            "FailedComponentAssetNumber": null,
            "AssetNumber": null,
            "FailedComponentItemNumber": null,
            "FailedComponentItemId": null,
            "FailedComponentSerialNumber": null,
            "FailureComments": "FailureComments",
            "FailureEventId": 300100555262352,
            "FailureInstanceId": 300100555262355,
            "LastUpdateDate": "2021-11-22T12:04:17.129+00:00",
            "LastUpdateLogin": "D15D5EFD8D3D47B1E053A9B1F20A51B4",
            "LastUpdatedBy": "MNT_QA",
            "FailureSeverityCode": null,
            "FailureStatusCode": null,
            "AssetId": null,
            "FailureName": "Failure Code 1",
            "FailureDescription": "Failure Code 1",
            "CauseDescription": "Cause Code 1",
            "CauseName": "Cause Code 1",
            "ResolutionDescription": "RC1",
            "ResolutionName": "RC1",
            "AssetDescription": null,
            "FailureCodeId": 300100555257834,
            "FailureCode": "FC1",
            "CauseCodeId": 300100555257950,
            "CauseCode": "CC1",
            "ResolutionCodeId": 300100555258073,
            "ResolutionCode": "RC1",
            "AssetDownFlag": null,
            "AvailableDate": null,
            "FailureDate": null,
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceSystemId": null,
            "SourceSystemType": null,
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "MeterUnitOfMeasure": null,
            "CompletionDate": null,
            "FailureCategoryCode": null,
            "FailureCategoryName": null,
            "CauseCategoryCode": null,
            "CauseCategoryName": null,
            "ResolutionCategoryCode": null,
            "ResolutionCategoryName": null,
            "ItemDescription": null,
            "ItemNumber": null,
            "ItemLongDescription": null,
            "FailedComponentItemDescription": null,
            "InventoryItemId": null,
            "ItemOrganizationId": null,
            "FailedComponentItemLongDescription": null,
            "WorkOrderId": null,
            "WorkOrderNumber": null,
            "WorkOrderDescription": null,
            "FailedComponentAssetDescription": null,
            "FailureSeverityName": null,
            "FailureStatusName": null,
            "AssetCriticalityName": null,
            "AssetCriticalityCode": null,
            "ItemOrganizationCode": null,
            "rootCauses": [
                {
                    "CauseCodeId": 300100555257950,
                    "RootCauseComments": "Root Cause Comments",
                    "CreatedBy": "MNT_QA",
                    "CreationDate": "2021-11-22T12:04:17.144+00:00",
                    "FailureInstanceId": 300100555262355,
                    "LastUpdateDate": "2021-11-22T12:04:17.144+00:00",
                    "LastUpdateLogin": "D15D5EFD8D3D47B1E053A9B1F20A51B4",
                    "LastUpdatedBy": "MNT_QA",
                    "RootCauseId": 300100555262373,
                    "RootCauseCode": "CC1",
                    "RootCauseName": "Cause Code 1",
                    "RootCauseDescription": "Cause Code 1",
                    "RootCauseCategoryCode": null,
                    "RootCauseCategoryName": null
               }
           ]
       }
    ]
}

Back to Top