1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Maintenance
  4. Asset Failure Sets

Get all failure sets

get

/fscmRestApi/resources/11.13.18.05/assetFailureSets

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:

    • ObjectTypeFinder: Finds resources according to the association.
      Finder Variables:
      • BindAssetNumber; string; Finds resources according to the asset number.
      • BindCategoryName; string; Finds resources according to the category name.
      • BindItemNumber; string; Finds resources according to the item number.
      • BindObjectTypeCode; string; Finds resources according to the object type code.
    • PrimaryKey: Finds assets according to the failure set identifier.
      Finder Variables:
      • FailureSetId; integer; Value that uniquely identifies the failure set.
  • 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:
    • CreatedBy; string; User who created the failure set. The application automatically sets this value during creation. This attribute is read-only.
    • CreationDate; string; Date when the failure set is created. The application automatically sets this value during creation. This attribute is read-only.
    • FailureChainsEnforcedFlag; boolean; Contains one of the following values: true or false. If true, then failure-cause-resolution combinations will be validated to ensure they match a valid failure chain in the applicable failure set when creating or updating failure event instances. If false, then any failure-cause-resolution combination can be entered when creating or updating failure event instances. The default value is false.
    • FailureSetCode; string; Abbreviation that uniquely identifies the failure set. The alphanumeric failure set code is a required field.
    • FailureSetDescription; string; Description of the failure set. This optional attribute provides a brief user-defined text providing information on the failure set's use and characteristics.
    • FailureSetId; integer; Value that uniquely identifies the failure set. The value is system generated and read-only.
    • FailureSetName; string; Name of the failure set. The failure code name is required and must be unique.
    • LastUpdateDate; string; Date when the user most recently updated the failure set. The application automatically sets this value during creation. This attribute is read-only.
    • LastUpdateLogin; string; Login that the user used when updating the failure set. The application assigns a value to this attribute during creation. This attribute is read-only.
    • LastUpdatedBy; string; User who most recently updated the failure set. The application assigns a value to this attribute during creation. This attribute is read-only.
  • 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 : assetFailureSets
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assetFailureSets-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the failure set. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the failure set is created. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Maximum Length: 80
    Contains one of the following values: true or false. If true, then the failure set is qualified as the default, based on the specific failure set association criteria. If false, then the failure set is not qualified as a default. For a given failure set, the value is derived and read only.
  • Failure Associations
    Title: Failure Associations
    The Failure Associations resource manages the failure associations. Failure associations defines to which assets a failure set applies and whether capturing failure data is required for a given asset.
  • Failure Chain Causes
    Title: Failure Chain Causes
    The Failure Chain Causes resource lists all possible failure causes defined for the Failure Set.
  • Failure Chain Failures
    Title: Failure Chain Failures
    The Failure Chain Failures resource lists all possible failures defined for the Failure Set.
  • Failure Chain Resolutions
    Title: Failure Chain Resolutions
    The Failure Chain Resolutions resource lists all possible failure resolutions defined for the Failure Set.
  • Failure Chains
    Title: Failure Chains
    The Failure Chains resource manages the failure chains. Failure chains define specific combinations of failure, cause, and resolution.
  • Title: Failure Chains Enforced
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then failure-cause-resolution combinations will be validated to ensure they match a valid failure chain in the applicable failure set when creating or updating failure event instances. If false, then any failure-cause-resolution combination can be entered when creating or updating failure event instances. The default value is false.
  • Title: Failure Set Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the failure set. The alphanumeric failure set code is a required field.
  • Title: Failure Set Description
    Maximum Length: 540
    Description of the failure set. This optional attribute provides a brief user-defined text providing information on the failure set's use and characteristics.
  • Title: Failure Set ID
    Read Only: true
    Value that uniquely identifies the failure set. The value is system generated and read-only.
  • Title: Failure Set Name
    Maximum Length: 240
    Name of the failure set. The failure code name is required and must be unique.
  • Read Only: true
    Date when the user most recently updated the failure set. 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 set. 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 set. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
Nested Schema : Failure Associations
Type: array
Title: Failure Associations
The Failure Associations resource manages the failure associations. Failure associations defines to which assets a failure set applies and whether capturing failure data is required for a given asset.
Show Source
Nested Schema : Failure Chain Causes
Type: array
Title: Failure Chain Causes
The Failure Chain Causes resource lists all possible failure causes defined for the Failure Set.
Show Source
Nested Schema : Failure Chain Failures
Type: array
Title: Failure Chain Failures
The Failure Chain Failures resource lists all possible failures defined for the Failure Set.
Show Source
Nested Schema : Failure Chain Resolutions
Type: array
Title: Failure Chain Resolutions
The Failure Chain Resolutions resource lists all possible failure resolutions defined for the Failure Set.
Show Source
Nested Schema : Failure Chains
Type: array
Title: Failure Chains
The Failure Chains resource manages the failure chains. Failure chains define specific combinations of failure, cause, and resolution.
Show Source
Nested Schema : assetFailureSets-failureAssociations-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Date when the failure set association becomes inactive. This attribute is read-only and is only set when the failureAssociationDisableFlag passes a value of true.
  • Title: Asset Description
    Read Only: true
    Maximum Length: 255
    Description of the asset association to the failure set. This optional attribute provides a brief user-defined text providing information on the asset's use and characteristics.
  • Title: Asset ID
    Value that uniquely identifies the asset. The value is system generated and read-only. This is a required attribute if ObjectTypeCode = ORA_ASSET and no AssetNumber is provided.
  • Title: Asset Number
    Maximum Length: 255
    Name that uniquely identifies the asset associated to the failure set. This is a required attribute if ObjectTypeCode = ORA_ASSET and no AssetID is provided.
  • Title: Capture Required
    Maximum Length: 1
    Default Value: N
    Code corresponding to one yes, no, or corrective only values. If yes, then a failure code, cause code, and resoluton code must be captured on a failure event instance before the associated work order can be completed. If corrective only, then a failure code, cause code, and resoluton code must be captured on a failure event instance before the associated work order can be completed if and only if the work order is of Work Order Type "Corrective". If no, then failure, cause, and resolution are not required to complete a work order. This attribute defaults to "No" if no value is passed.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Name corresponding to one yes, no, or corrective only values. If yes, then a failure code, cause code, and resoluton code must be captured on a failure event instance before the associated work order can be completed. If corrective only, then a failure code, cause code, and resoluton code must be captured on a failure event instance before the associated work order can be completed if and only if the work order is of Work Order Type "Corrective". If no, then failure, cause, and resolution are not required to complete a work order. This attribute defaults to "No" if no value is passed.
  • Read Only: true
    Maximum Length: 64
    User who created the failure association. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the failure association is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Disable
    Contains one of the following values: true or false. If true, then the active end date of the failure association is set to the system date and time.
  • Title: Failure Set ID
    Value that uniquely identifies the failure set. The value is system generated and read-only.
  • Title: Item Category Code
    Maximum Length: 255
    Code that uniquely identifies the item category associated to the failure set. This is a required attribute if ObjectTypeCode = ORA_CATEGORY.
  • Read Only: true
    Maximum Length: 240
    Description of the item category in a failure set association. This is a read-only attribute.
  • Number that identifies the Item Category.
  • Title: Item Category Name
    Maximum Length: 255
    Name of the item category association to the failure set. This optional attribute provides a brief user-defined text providing information on the item category's use and characteristics.
  • Read Only: true
    Maximum Length: 255
    Description of the item in a failure set association. This is a read-only attribute.
  • Read Only: true
    Value that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode = ORA_ITEM.
  • Title: Item Number
    Maximum Length: 255
    Name that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode = ORA_ITEM.
  • Read Only: true
    Date when the user most recently updated the failure association. 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 association. 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 association. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Maximum Length: 255
    Abbreviation that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode = ORA_ITEM.
  • Value that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode = ORA_ITEM.
  • Title: Object Type Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the object type association to a failure set. The alphanumeric code is a required field. Values can be ORA_CATEGORY, ORA_ITEM, ORA_ASSET, or ORA_ALL.
  • Read Only: true
    Maximum Length: 240
    Meaning of the abbreviation that uniquely identifies the object type associated with a failure set. This is a read-only attribute.
  • Title: Set Association ID
    Read Only: true
    Value that uniquely identifies the failure set association. The value is system generated and read-only.
Nested Schema : assetFailureSets-failureChainCauses-item-response
Type: object
Show Source
Nested Schema : assetFailureSets-failureChainFailures-item-response
Type: object
Show Source
Nested Schema : assetFailureSets-failureChainResolutions-item-response
Type: object
Show Source
Nested Schema : assetFailureSets-failureChains-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Date when the failure chain becomes inactive. This attribute is read-only and is only set when the failureChainDisableFlag passes a value of true.
  • Title: Cause Category Code
    Read Only: true
    Maximum Length: 255
    Category code of the cause code associated to chain.
  • Title: Cause Category Name
    Read Only: true
    Maximum Length: 255
    Category name of the cause code associated to chain.
  • Title: Cause Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the cause of failure. The cause code is required and must be a valid code. The code must use uppercase letters and alphanumeric.
  • Title: Cause Code ID
    Value that uniquely identifies the cause code. The value is system generated and read-only.
  • Title: Cause Description
    Read Only: true
    Maximum Length: 255
    Description of the cause code associated to chain.
  • Title: Cause Name
    Read Only: true
    Maximum Length: 255
    Name of the cause code associated to chain.
  • Read Only: true
    Maximum Length: 64
    User who created the failure chain. The application automatically sets this value during creation. This attribute is read-only.
  • Read Only: true
    Date when the failure chain is created. The application automatically sets this value during creation. This attribute is read-only.
  • Title: Failure Category Code
    Read Only: true
    Maximum Length: 255
    Category code of the failure code associated to chain.
  • Title: Failure Category Name
    Read Only: true
    Maximum Length: 255
    Category name of the failure code associated to chain.
  • Title: Disable
    Contains one of the following values: true or false. If true, then the active end date of the failure cahin is set to the system date and time.
  • Title: Failure Chain ID
    Read Only: true
    Value that uniquely identifies the failure chain. The value is system generated and read-only.
  • Title: Failure Code
    Maximum Length: 30
    Default Value: if (FailureCodeVA.first()!= null ) { return FailureCodeVA.first().getAttribute("ConditionEventCode"); }
    Abbreviation that uniquely identifies the failure mode. The failure code is required and must be a valid code. The code must use uppercase letters and alphanumeric.
  • Title: Failure Code
    Value that uniquely identifies the failure code. The value is system generated and read-only.
  • Title: Failure Description
    Read Only: true
    Maximum Length: 255
    Description of the failure code associated to chain.
  • Title: Failure Name
    Read Only: true
    Maximum Length: 255
    Name of the failure code associated to chain.
  • Title: Failure Set ID
    Value that uniquely identifies the failure set. The value is system generated and read-only.
  • Read Only: true
    Date when the user most recently updated the failure chain. 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 chain. 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 chain. The application assigns a value to this attribute during creation. This attribute is read-only.
  • Links
  • Title: Resolution Category Code
    Read Only: true
    Maximum Length: 255
    Category code of the resolution code associated to chain.
  • Title: Resolution Category Name
    Read Only: true
    Maximum Length: 255
    Category name of the resolution code associated to chain.
  • Title: Resolution Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the manner in which the failure was resolved. The resolution code is required and must be a valid code. The code must use uppercase letters and alphanumeric.
  • Title: Resolution Code ID
    Value that uniquely identifies the resolution code. The value is system generated and read-only.
  • Title: Resolution Description
    Read Only: true
    Maximum Length: 255
    Description of the resolution code associated to chain.
  • Title: Resolution Name
    Read Only: true
    Maximum Length: 255
    Name of the resolution code associated to chain.
Back to Top

Examples

This example describes how to get all failure sets.

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/assetFailureSets"

Example Response Body

The following shows an example of the response body in JSON format.
"{
            "FailureSetId": 300100547607460,
            "FailureSetCode": "AB_FAILURE_SET_CODE05",
            "FailureSetName": "AB_Failure_Set_Name_05",
            "ActiveEndDate": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2021-11-11T09:20:40+00:00",
            "FailureChainsEnforcedFlag": false,
            "FailureSetDescription": null,
            "LastUpdateDate": "2021-11-11T09:20:40.454+00:00",
            "LastUpdateLogin": "D071F309D20269EAE053AF01F40A3935",
            "LastUpdatedBy": "MNT_QA",
            "FailureSetDisableFlag": null
}"
Back to Top