Create asset failure instances
post
/fscmRestApi/resources/11.13.18.05/assetFailureEvents/{FailureEventId}/child/failureInstances
Request
Path Parameters
-
FailureEventId(required): integer(int64)
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
Header Parameters
-
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
AssetCriticalityName: string
Title:
Asset Criticality Name
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseCode: string
Title:
Cause Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseCodeId: integer
(int64)
Title:
Cause Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedAssetId: integer
(int64)
Title:
Failed Asset ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentAssetNumber: string
Title:
Failed Asset Number
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentItemId: integer
(int64)
Title:
Failed Item ID
ItemId that uniquely identifies the failed component. -
FailedComponentItemNumber: string
Title:
Failed Item Number
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentSerialNumber: string
Title:
Failed Serial Number
Maximum Length:80
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureCode: string
Title:
Failure Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureCodeId: integer
(int64)
Title:
Failure Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureComments: string
Title:
Failure Comments
Maximum Length:2000
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureEventId(required): integer
(int64)
Title:
Failure Event ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureSeverityCode: string
Title:
Severity Code
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureSeverityName: string
Title:
Severity Name
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureStatusCode: string
Title:
Status Code
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureStatusName: string
Title:
Status Name
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
OperationSequenceNumber: number
Title:
Operation Sequence
Number that identifies the sequence of the operation within a work order. The operation sequence is required attribute for a work order operation. It must be a positive integer and unique within a work order. -
ResolutionCode: string
Title:
Resolution Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionCodeId: number
Title:
Resolution Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
rootCauses: array
Failure Root Causes
Title:
Failure Root Causes
Failure root cause. -
WoOperationId: integer
(int64)
Value that uniquely identifies the work order operation associated with the failure instance.
Nested Schema : Failure Root Causes
Type:
array
Title:
Failure Root Causes
Failure root cause.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CauseCodeId: integer
(int64)
Title:
Cause Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureInstanceId: integer
(int64)
Title:
Failure Instance ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseCode: string
Title:
Cause Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseComments: string
Title:
Comments
Maximum Length:2000
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
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.
Root Schema : assetFailureEvents-failureInstances-item-response
Type:
Show Source
object
-
AssetCriticalityCode: string
Title:
Asset Criticality Code
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
AssetCriticalityName: string
Title:
Asset Criticality Name
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
AssetDescription: string
Title:
Asset Description
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
AssetDownFlag: boolean
Title:
Asset Down
Read Only:true
Maximum Length:1
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
AssetId: integer
(int64)
Title:
Asset ID
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
AssetNumber: string
Title:
Asset Number
Read Only:true
Maximum Length:80
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
AvailableDate: string
(date-time)
Title:
Available Date
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseCategoryCode: string
Title:
Cause Category Code
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseCategoryName: string
Title:
Cause Category Name
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseCode: string
Title:
Cause Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseCodeId: integer
(int64)
Title:
Cause Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseDescription: string
Title:
Cause Description
Read Only:true
Maximum Length:540
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CauseName: string
Title:
Cause Name
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CompletionDate: string
(date-time)
Title:
WO Completion Date
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the failure instance. The application automatically sets this value during creation. This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
true
Date when the failure instance is created. The application automatically sets this value during creation. This attribute is read-only. -
DaysBetweenFailure: number
Title:
TBF Days
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedAssetId: integer
(int64)
Title:
Failed Asset ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentAssetDescription: string
Title:
Failed Asset Description
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentAssetNumber: string
Title:
Failed Asset Number
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentItemDescription: string
Title:
Failed Item Description
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentItemId: integer
(int64)
Title:
Failed Item ID
ItemId that uniquely identifies the failed component. -
FailedComponentItemLongDescription: string
Title:
Failed Item Long Description
Read Only:true
Maximum Length:4000
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentItemNumber: string
Title:
Failed Item Number
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailedComponentSerialNumber: string
Title:
Failed Serial Number
Maximum Length:80
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureCategoryCode: string
Title:
Failure Category Code
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureCategoryName: string
Title:
Failure Category Name
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureCode: string
Title:
Failure Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureCodeId: integer
(int64)
Title:
Failure Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureComments: string
Title:
Failure Comments
Maximum Length:2000
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureDate: string
(date-time)
Title:
Failure Date
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureDescription: string
Title:
Failure Description
Read Only:true
Maximum Length:540
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureEventId: integer
(int64)
Title:
Failure Event ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureInstanceId: integer
(int64)
Title:
Failure Instance ID
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureName: string
Title:
Failure Name
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureSeverityCode: string
Title:
Severity Code
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureSeverityName: string
Title:
Severity Name
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureStatusCode: string
Title:
Status Code
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
FailureStatusName: string
Title:
Status Name
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
InventoryItemId: integer
(int64)
Title:
Item Number
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ItemCategoryCode: string
Read Only:
true
Maximum Length:255
Abbreviation that uniquely identifies the item category to which the failed component is assigned. The code must be alphanumeric and must validate against the catalog assigned to the profile option " ORA_CSE_ITEM_CATALOG". -
ItemCategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item category to which the failed component is assigned. The value is system generated and read-only. -
ItemCategoryName: string
Read Only:
true
Maximum Length:255
Name of the item category to which the failed component is assigned. The item category name is optional but if defined must be unique. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ItemLongDescription: string
Title:
Item Long Description
Read Only:true
Maximum Length:4000
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ItemOrganizationCode: string
Read Only:
true
Maximum Length:18
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ItemOrganizationId: integer
(int64)
Title:
Organization
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the failure instance. The application automatically sets this value during creation. This attribute is read-only. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the failure instance. The application assigns a value to this attribute during creation. This attribute is read-only. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the failure instance. The application assigns a value to this attribute during creation. This attribute is read-only. -
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
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
MeterUnitsBetweenFailure: number
Title:
TBF Meter Units
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
OperationSequenceNumber: number
Title:
Operation Sequence
Number that identifies the sequence of the operation within a work order. The operation sequence is required attribute for a work order operation. It must be a positive integer and unique within a work order. -
RepairCost: number
Title:
Repair Cost
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionCategoryCode: string
Title:
Resolution Category Code
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionCategoryName: string
Title:
Resolution Category Name
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionCode: string
Title:
Resolution Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionCodeId: number
Title:
Resolution Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionDescription: string
Title:
Resolution Description
Read Only:true
Maximum Length:540
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
ResolutionName: string
Title:
Resolution Name
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
rootCauses: array
Failure Root Causes
Title:
Failure Root Causes
Failure root cause. -
SourceDocumentId: string
Title:
Source Document ID
Read Only:true
Maximum Length:36
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
SourceDocumentTypeCode: string
Title:
Source Doc Type Code
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
SourceSystemId: integer
(int64)
Title:
Source Application ID
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
SourceSystemType: string
Title:
Source Application Type
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
WoOperationId: integer
(int64)
Value that uniquely identifies the work order operation associated with the failure instance.
-
WorkOrderDescription: string
Title:
Work Order Description
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
WorkOrderId: integer
(int64)
Title:
Work Order ID
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
WorkOrderNumber: string
Title:
Work Order Number
Read Only:true
Maximum Length:120
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Failure Root Causes
Type:
array
Title:
Failure Root Causes
Failure root cause.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : assetFailureEvents-failureInstances-rootCauses-item-response
Type:
Show Source
object
-
CauseCodeId: integer
(int64)
Title:
Cause Code ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the failure root cause. The application automatically sets this value during creation. This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
true
Date when the failure root cause is created. The application automatically sets this value during creation. This attribute is read-only. -
FailureInstanceId: integer
(int64)
Title:
Failure Instance ID
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the failure root cause. The application automatically sets this value during creation. This attribute is read-only. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the failure root cause. The application assigns a value to this attribute during creation. This attribute is read-only. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the failure root cause. The application assigns a value to this attribute during creation. This attribute is read-only. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RootCauseCategoryCode: string
Title:
Cause Category Code
Read Only:true
Maximum Length:30
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseCategoryName: string
Title:
Cause Category Name
Read Only:true
Maximum Length:255
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseCode: string
Title:
Cause Code
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseComments: string
Title:
Comments
Maximum Length:2000
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseDescription: string
Title:
Cause Description
Read Only:true
Maximum Length:540
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseId: integer
(int64)
Title:
Root Cause ID
Read Only:true
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number. -
RootCauseName: string
Title:
Cause Name
Read Only:true
Maximum Length:240
Number that identifies the work order. This number is unique in the organization. The user can manually assign the number when creating the work order, or allow the application to create a unique number from the numbering scheme that the following Plant parameters define: Work Order Prefix or Work Order Starting Number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- rootCauses
-
Parameters:
- FailureEventId:
$request.path.FailureEventId
- FailureInstanceId:
$request.path.FailureInstanceId
Failure root cause. - FailureEventId:
Examples
This example describes how to create asset failure instances.
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/FailureEventId/child/failureInstances"
Example 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.
"{ "FailureCode": "FC3", "CauseCode": "CC3", "ResolutionCode": "RC3", "FailureComments": "FailureComments", "rootCauses": [ { "RootCauseCode": "CC2", "RootCauseComments": "Root Cause Comments" }, { "RootCauseCode": "CC4", "RootCauseComments": "Root Cause Comments" } ] }"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ "CreatedBy": "MNT_QA", "CreationDate": "2021-11-22T12:38:35.257+00:00", "FailedComponentAssetNumber": null, "AssetNumber": null, "FailedComponentItemNumber": null, "FailedComponentItemId": null, "FailedComponentSerialNumber": null, "FailureComments": "FailureComments", "FailureEventId": 300100555268986, "FailureInstanceId": 300100555290333, "LastUpdateDate": "2021-11-22T12:38:35.257+00:00", "LastUpdateLogin": "D14D59213ED9612CE053A9B1F20A71D6", "LastUpdatedBy": "MNT_QA", "FailureSeverityCode": null, "FailureStatusCode": null, "AssetId": null, "FailureName": "Failure Code 3", "FailureDescription": "Failure Code 3", "CauseDescription": "Cause Code 3", "CauseName": "Cause Code 3", "ResolutionDescription": "RC3", "ResolutionName": "RC3", "AssetDescription": null, "FailureCodeId": 300100555257871, "FailureCode": "FC3", "CauseCodeId": 300100555258027, "CauseCode": "CC3", "ResolutionCodeId": 300100555258164, "ResolutionCode": "RC3", "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": 300100555257966, "RootCauseComments": "Root Cause Comments", "CreatedBy": "MNT_QA", "CreationDate": "2021-11-22T12:38:35.260+00:00", "FailureInstanceId": 300100555290333, "LastUpdateDate": "2021-11-22T12:38:35.260+00:00", "LastUpdateLogin": "D14D59213ED9612CE053A9B1F20A71D6", "LastUpdatedBy": "MNT_QA", "RootCauseId": 300100555290334, "RootCauseCode": "CC2", "RootCauseName": "Cause Code 2", "RootCauseDescription": "Cause Code 2", "RootCauseCategoryCode": null, "RootCauseCategoryName": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333/child/rootCauses/300100555290334", "name": "rootCauses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333/child/rootCauses/300100555290334", "name": "rootCauses", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333", "name": "failureInstances", "kind": "item" } ] }, { "CauseCodeId": 300100555258053, "RootCauseComments": "Root Cause Comments", "CreatedBy": "MNT_QA", "CreationDate": "2021-11-22T12:38:35.261+00:00", "FailureInstanceId": 300100555290333, "LastUpdateDate": "2021-11-22T12:38:35.261+00:00", "LastUpdateLogin": "D14D59213ED9612CE053A9B1F20A71D6", "LastUpdatedBy": "MNT_QA", "RootCauseId": 300100555290335, "RootCauseCode": "CC4", "RootCauseName": "Cause Code 4", "RootCauseDescription": "Cause Code 4", "RootCauseCategoryCode": null, "RootCauseCategoryName": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333/child/rootCauses/300100555290335", "name": "rootCauses", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333/child/rootCauses/300100555290335", "name": "rootCauses", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333", "name": "failureInstances", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333", "name": "failureInstances", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333", "name": "failureInstances", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986", "name": "assetFailureEvents", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/assetFailureEvents/300100555268986/child/failureInstances/300100555290333/child/rootCauses", "name": "rootCauses", "kind": "collection" } ] }"