Create asset failure events
/fscmRestApi/resources/11.13.18.05/assetFailureEvents
Request
-
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.
- application/json
object-
AssetDescription: string
Title:
Asset DescriptionNumber 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 DownMaximum Length:1Default Value:trueNumber 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(required): integer
(int64)
Title:
Asset IDNumber 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 NumberNumber 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 DateNumber 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 DateNumber 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. -
DaysBetweenFailure: number
Title:
TBF DaysNumber 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 DateNumber 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. -
failureInstances: array
Failure Instances
Title:
Failure InstancesFailure instances. -
FailureSetId(required): integer
(int64)
Title:
Failure Set IDNumber 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. -
ItemDescription: string
Title:
Item DescriptionNumber 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. -
ItemId: integer
Title:
Item IDNumber 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 DescriptionNumber 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 NumberNumber 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 UnitsNumber 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. -
OrganizationCode: string
Title:
Organization CodeNumber 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. -
OrganizationId: integer
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.
-
RepairCost: number
Title:
Repair CostNumber 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. -
SourceDocumentId: string
Title:
Source Document IDMaximum Length:36Number 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 CodeMaximum Length:30Number 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. -
SourceSystem: string
Title:
Source Application TypeNumber 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 IDNumber 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. -
SourceSystemTypeCode(required): string
Title:
Source Application TypeMaximum Length:30Number 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. -
TrackingObjectType: string
Title:
Tracking Object TypeMaximum Length:30Number 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. -
TrackingObjectTypeCode: string
Title:
Tracking Object TypeMaximum Length:255Number 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. -
UOMCode: string
Title:
TBF Meter Units UOM CodeMaximum Length:3Number that identifies the unit of measure. -
WorkOrderDescription: string
Title:
Work Order DescriptionNumber 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
Title:
Work Order IDNumber 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 NumberMaximum Length:255Number 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.
arrayFailure Instancesobject-
AssetCriticalityName: string
Title:
Asset Criticality NameMaximum Length:255Number 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 CodeNumber 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 IDNumber 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 IDNumber 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 NumberNumber 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 IDItemId that uniquely identifies the failed component. -
FailedComponentItemNumber: string
Title:
Failed Item NumberNumber 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 NumberMaximum Length:80Number 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 CodeNumber 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 IDNumber 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 CommentsMaximum Length:2000Number 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 IDNumber 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 CodeMaximum Length:30Number 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 NameMaximum Length:255Number 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 CodeMaximum Length:30Number 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 NameMaximum Length:255Number 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 SequenceNumber 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 CodeNumber 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 IDNumber 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 CausesFailure root cause. -
WoOperationId: integer
(int64)
Value that uniquely identifies the work order operation associated with the failure instance.
arrayFailure Root Causesobject-
CauseCodeId: integer
(int64)
Title:
Cause Code IDNumber 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 IDNumber 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 CodeNumber 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:
CommentsMaximum Length:2000Number 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
- application/json
Default Response
-
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.
object-
AssetDescription: string
Title:
Asset DescriptionNumber 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 DownMaximum Length:1Default Value:trueNumber 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 IDNumber 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 NumberNumber 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 DateNumber 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 DateNumber 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:
trueMaximum Length:64User who created the failure event. The application automatically sets this value during creation. This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
trueDate when the failure event is created. The application automatically sets this value during creation. This attribute is read-only. -
DaysBetweenFailure: number
Title:
TBF DaysNumber 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 DateNumber 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 IDRead Only:trueNumber 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. -
failureInstances: array
Failure Instances
Title:
Failure InstancesFailure instances. -
FailureSetCode: string
Title:
Failure Set CodeRead Only:trueMaximum Length:30Number 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. -
FailureSetDescription: string
Title:
Failure Set DescriptionRead Only:trueMaximum Length:540Number 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. -
FailureSetId: integer
(int64)
Title:
Failure Set IDNumber 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. -
FailureSetName: string
Title:
Failure Set NameRead Only:trueMaximum Length:240Number 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. -
ItemDescription: string
Title:
Item DescriptionNumber 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. -
ItemId: integer
Title:
Item IDNumber 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 DescriptionNumber 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 NumberNumber 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:
trueDate when the user most recently updated the failure event. The application automatically sets this value during creation. This attribute is read-only. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the failure event. The application assigns a value to this attribute during creation. This attribute is read-only. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login that the user used when updating the failure event. The application assigns a value to this attribute during creation. This attribute is read-only. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MeterUnitsBetweenFailure: number
Title:
TBF Meter UnitsNumber 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. -
OrganizationCode: string
Title:
Organization CodeNumber 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. -
OrganizationId: integer
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.
-
RepairCost: number
Title:
Repair CostNumber 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. -
SourceDocumentId: string
Title:
Source Document IDMaximum Length:36Number 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 CodeMaximum Length:30Number 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. -
SourceDocumentTypeName: string
Read Only:
trueMaximum Length:320Name that identifies the work order. This name is meaning value from the look up based on the lookup type. -
SourceSystem: string
Title:
Source Application TypeNumber 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 IDNumber 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. -
SourceSystemTypeCode: string
Title:
Source Application TypeMaximum Length:30Number 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. -
SourceSystemTypeName: string
Read Only:
trueMaximum Length:80Name that identifies the work order. This name is meaning value from the look up based on the lookup type. -
TrackingObjectType: string
Title:
Tracking Object TypeMaximum Length:30Number 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. -
TrackingObjectTypeCode: string
Title:
Tracking Object TypeMaximum Length:255Number 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. -
UnitOfMeasure: string
Read Only:
trueMaximum Length:25Number that identifies the unit of measure. -
UOMCode: string
Title:
TBF Meter Units UOM CodeMaximum Length:3Number that identifies the unit of measure. -
WorkOrderDescription: string
Title:
Work Order DescriptionNumber 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
Title:
Work Order IDNumber 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 NumberMaximum Length:255Number 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.
arrayFailure InstancesarrayLinksobject-
AssetCriticalityCode: string
Title:
Asset Criticality CodeRead Only:trueMaximum Length:30Number 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 NameMaximum Length:255Number 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 DescriptionRead Only:trueMaximum Length:240Number 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 DownRead Only:trueMaximum Length:1Number 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 IDRead Only:trueNumber 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 NumberRead Only:trueMaximum Length:80Number 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 DateRead Only:trueNumber 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 CodeRead Only:trueMaximum Length:30Number 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 NameRead Only:trueNumber 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 CodeNumber 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 IDNumber 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 DescriptionRead Only:trueMaximum Length:540Number 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 NameRead Only:trueMaximum Length:240Number 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 DateRead Only:trueNumber 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:
trueMaximum Length:64User who created the failure instance. The application automatically sets this value during creation. This attribute is read-only. -
CreationDate: string
(date-time)
Read Only:
trueDate when the failure instance is created. The application automatically sets this value during creation. This attribute is read-only. -
DaysBetweenFailure: number
Title:
TBF DaysRead Only:trueNumber 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 IDNumber 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 DescriptionRead Only:trueMaximum Length:240Number 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 NumberNumber 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 DescriptionRead Only:trueMaximum Length:240Number 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 IDItemId that uniquely identifies the failed component. -
FailedComponentItemLongDescription: string
Title:
Failed Item Long DescriptionRead Only:trueMaximum Length:4000Number 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 NumberNumber 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 NumberMaximum Length:80Number 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 CodeRead Only:trueMaximum Length:30Number 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 NameRead Only:trueNumber 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 CodeNumber 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 IDNumber 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 CommentsMaximum Length:2000Number 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 DateRead Only:trueNumber 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 DescriptionRead Only:trueMaximum Length:540Number 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 IDNumber 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 IDRead Only:trueNumber 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 NameRead Only:trueMaximum Length:240Number 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 CodeMaximum Length:30Number 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 NameMaximum Length:255Number 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 CodeMaximum Length:30Number 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 NameMaximum Length:255Number 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 NumberRead Only:trueNumber 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:
trueMaximum Length:255Abbreviation 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:
trueValue 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:
trueMaximum Length:255Name 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 DescriptionRead Only:trueMaximum Length:240Number 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 DescriptionRead Only:trueMaximum Length:4000Number 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 NumberRead Only:trueMaximum Length:300Number 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:
trueMaximum Length:18Number 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:
OrganizationRead Only:trueNumber 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:
trueDate 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:
trueMaximum Length:64User 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:
trueMaximum Length:32Login 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:
LinksThe link relations associated with the resource instance. -
MeterUnitOfMeasure: string
Title:
TBF Meter Units UOM CodeRead Only:trueMaximum Length:3Number 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 UnitsRead Only:trueNumber 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. -
OperationName: string
Title:
NameRead Only:trueMaximum Length:120Name that identifies the operation within a work order. -
OperationSequenceNumber: number
Title:
Operation SequenceNumber 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 CostRead Only:trueNumber 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 CodeRead Only:trueMaximum Length:30Number 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 NameRead Only:trueNumber 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 CodeNumber 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 IDNumber 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 DescriptionRead Only:trueMaximum Length:540Number 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 NameRead Only:trueMaximum Length:240Number 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 CausesFailure root cause. -
SourceDocumentId: string
Title:
Source Document IDRead Only:trueMaximum Length:36Number 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 CodeRead Only:trueMaximum Length:30Number 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 IDRead Only:trueNumber 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 TypeRead Only:trueMaximum Length:30Number 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 DescriptionRead Only:trueMaximum Length:240Number 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 IDRead Only:trueNumber 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 NumberRead Only:trueMaximum Length:120Number 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.
arrayLinksarrayFailure Root Causesobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
CauseCodeId: integer
(int64)
Title:
Cause Code IDNumber 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:
trueMaximum Length:64User 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:
trueDate 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 IDNumber 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:
trueDate 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:
trueMaximum Length:64User 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:
trueMaximum Length:32Login 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:
LinksThe link relations associated with the resource instance. -
RootCauseCategoryCode: string
Title:
Cause Category CodeRead Only:trueMaximum Length:30Number 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 NameRead Only:trueMaximum Length:255Number 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 CodeNumber 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:
CommentsMaximum Length:2000Number 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 DescriptionRead Only:trueMaximum Length:540Number 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 IDRead Only:trueNumber 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 NameRead Only:trueMaximum Length:240Number 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.
arrayLinks- failureInstances
-
Operation: /fscmRestApi/resources/11.13.18.05/assetFailureEvents/{FailureEventId}/child/failureInstancesParameters:
- FailureEventId:
$request.path.FailureEventId
Failure instances. - FailureEventId:
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
"{
"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
"{
"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
"{
"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
}
]
}
]
}"