Jump to

• Request
• Response

Update

patch

/fscmRestApi/resources/11.13.18.05/assetFailureEvents/{FailureEventId}/child/failureInstances/{FailureInstanceId}

Request

Path Parameters

• FailureEventId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• FailureInstanceId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root 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-patch-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-patch-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-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

rootCauses

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

Parameters:

• FailureEventId: $request.path.FailureEventId
• FailureInstanceId: $request.path.FailureInstanceId

Back to Top