Get all asset failure events

get

/fscmRestApi/resources/11.13.18.05/assetFailureEvents

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • FailureEventsByAssetNumberFinder: Finds resources according to the asset.
      Finder Variables:
      • BindAssetNumber; string; Finds resources according to the asset.
    • FailureEventsByConditionEventFinder: Value that uniquely identifies the asset.
      Finder Variables:
      • BindCauseCode; string; Finds resources according to the asset.
      • BindCauseId; integer; Finds resources according to the asset.
      • BindFailureCode; string; Finds resources according to the asset.
      • BindFailureId; integer; Finds resources according to the asset.
      • BindResolutionCode; string; Finds resources according to the asset.
      • BindResolutionId; integer; Finds resources according to the asset.
    • FailureEventsByFailedComponentAssetFinder: Finds resources according to the asset.
      Finder Variables:
      • BindFailedComponentAsset; string; Value that uniquely identifies the asset.
      • BindFailedComponentAssetid; integer; Finds resources according to the asset.
    • FailureEventsByFailedComponentItemFinder: Finds resources according to the asset.
      Finder Variables:
      • BindFailedComponent; string; Finds resources according to the asset.
      • BindFailedItemId; integer; Finds resources according to the asset.
    • FailureEventsByRootCauseCodeFinder: Finds resources according to the asset.
      Finder Variables:
      • BindRootCause; string; Value that uniquely identifies the asset.
      • BindRootCauseId; integer; Finds resources according to the asset.
    • FailureEventsByWorkOrderNumberFinder: Finds resources according to the asset.
      Finder Variables:
      • BindWorkOrderNumber; string; Finds resources according to the asset.
    • PrimaryKey: Finds resources according to the asset.
      Finder Variables:
      • FailureEventId; integer; Finds resources according to the asset.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssetDescription; string; 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; 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; 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; 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; 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; 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.
    • CreationDate; string; Date when the failure event is created. The application automatically sets this value during creation. This attribute is read-only.
    • DaysBetweenFailure; 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.
    • FailureDate; string; 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; 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.
    • FailureSetCode; string; 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.
    • FailureSetDescription; string; 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.
    • FailureSetId; 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.
    • FailureSetName; string; 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.
    • ItemDescription; string; 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.
    • ItemId; 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.
    • ItemLongDescription; string; 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; 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 when the user most recently updated the failure event. The application automatically sets this value during creation. This attribute is read-only.
    • LastUpdateLogin; string; Login that the user used when updating the failure event. The application assigns a value to this attribute during creation. This attribute is read-only.
    • LastUpdatedBy; string; User who most recently updated the failure event. The application assigns a value to this attribute during creation. This attribute is read-only.
    • MeterUnitsBetweenFailure; 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.
    • OrganizationCode; string; 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.
    • 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; 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.
    • SourceDocumentId; string; 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; 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.
    • SourceDocumentTypeName; string; Name that identifies the work order. This name is meaning value from the look up based on the lookup type.
    • SourceSystem; string; 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; 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.
    • SourceSystemTypeCode; string; 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.
    • SourceSystemTypeName; string; Name that identifies the work order. This name is meaning value from the look up based on the lookup type.
    • TrackingObjectType; string; 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.
    • TrackingObjectTypeCode; string; 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.
    • UOMCode; string; Number that identifies the unit of measure.
    • UnitOfMeasure; string; Number that identifies the unit of measure.
    • WorkOrderDescription; string; 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; 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; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : assetFailureEvents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assetFailureEvents-item-response
Type: object
Show Source
  • Title: Asset Description
    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.
  • Title: Asset Down
    Maximum Length: 1
    Default Value: 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.
  • Title: 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.
  • Title: 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.
  • Title: Available Date
    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.
  • Title: WO Completion Date
    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.
  • Read Only: true
    Maximum Length: 64
    User who created the failure event. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the failure event is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: TBF Days
    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.
  • Title: Failure Date
    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.
  • Title: Failure Event 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.
  • Failure Instances
    Title: Failure Instances
    Failure instances.
  • Title: Failure Set 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.
  • Title: Failure Set 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.
  • Title: Failure Set 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.
  • Title: Failure Set 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.
  • Title: Item Description
    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.
  • Title: Item 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.
  • Title: Item Long Description
    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.
  • Title: 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.
  • Read Only: true
    Date when the user most recently updated the failure event. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the failure event. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 32
    Login 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
  • Title: TBF Meter Units
    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.
  • Title: Organization 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.
  • 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.
  • Title: Repair Cost
    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.
  • Title: Source Document ID
    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.
  • Title: Source Doc Type 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.
  • Read Only: true
    Maximum Length: 320
    Name that identifies the work order. This name is meaning value from the look up based on the lookup type.
  • Title: Source Application Type
    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.
  • Title: Source Application 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.
  • Title: Source Application Type
    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.
  • Read Only: true
    Maximum Length: 80
    Name that identifies the work order. This name is meaning value from the look up based on the lookup type.
  • Title: Tracking Object Type
    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.
  • Title: Tracking Object Type
    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.
  • Read Only: true
    Maximum Length: 25
    Number that identifies the unit of measure.
  • Title: TBF Meter Units UOM Code
    Maximum Length: 3
    Number that identifies the unit of measure.
  • Title: Work Order Description
    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.
  • Title: Work Order 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.
  • Title: Work Order Number
    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.
Nested Schema : Failure Instances
Type: array
Title: Failure Instances
Failure instances.
Show Source
Nested Schema : assetFailureEvents-failureInstances-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Date when the failure instance is created. The application automatically sets this value during creation. This attribute is read-only.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Failed Item ID
    ItemId that uniquely identifies the failed component.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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".
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 120
    Name that identifies the operation within a work order.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Failure Root Causes
    Title: Failure Root Causes
    Failure root cause.
  • 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.
  • 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.
  • 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.
  • 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.
  • Value that uniquely identifies the work order operation associated with the failure instance.
  • 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.
  • 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.
  • 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 : Failure Root Causes
Type: array
Title: Failure Root Causes
Failure root cause.
Show Source
Nested Schema : assetFailureEvents-failureInstances-rootCauses-item-response
Type: object
Show Source
  • 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.
  • 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.
  • Read Only: true
    Date when the failure root cause is created. The application automatically sets this value during creation. This attribute is read-only.
  • 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.
  • 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.
  • 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.
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
Back to Top

Examples

This example describes how to get all asset failure events.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/assetFailureEvents"

Example Response Body

The following shows an example of the response body in JSON format.
"{
            "FailureEventId": 300100548802875,
            "FailureDate": "2020-09-08T19:00:28+00:00",
            "AvailableDate": "2020-09-09T19:00:28+00:00",
            "AssetId": 300100541412523,
            "FailureSetId": 300100547607460,
            "FailureSetCode": "AB_FAILURE_SET_CODE05",
            "FailureSetDescription": null,
            "FailureSetName": "AB_Failure_Set_Name_05",
            "RepairCost": null,
            "SourceDocumentId": null,
            "SourceDocumentTypeCode": null,
            "SourceDocumentTypeName": null,
            "SourceSystemId": null,
            "SourceSystemTypeCode": "ORA_INTERNAL",
            "SourceSystemTypeName": "Internal",
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-16T22:10:04+00:00",
            "LastUpdateDate": "2021-11-16T22:10:04.718+00:00",
            "LastUpdateLogin": "D071F2FBDC6069F4E053AF01F40A35E3",
            "LastUpdatedBy": "MNT_QA",
            "DaysBetweenFailure": null,
            "MeterUnitsBetweenFailure": null,
            "UOMCode": null,
            "UomName": null,
            "TrackingObjectType": "ORA_WORK_ORDER",
            "CompletionDate": null,
            "TrackingObjectTypeCode": "ORA_WORK_ORDER",
            "WorkOrderNumber": "FL212",
            "WorkOrderId": 75480,
            "WorkOrderDescription": "Priority 1",
            "OrganizationCode": "MNTALM",
            "OrganizationId": 300100113363336,
            "AssetDownIndicator": "Y",
            "AssetNumber": "Forklift Asset 03",
            "AssetDescription": "Forklift Asset 03",
            "ItemNumber": "SAPS-WRH-Forklift",
            "ItemDescription": "Warehouse Forklift",
            "ItemLongDescription": null,
            "SourceSystem": null
}"
Back to Top