Get all failure set associations

get

/fscmRestApi/resources/11.13.18.05/assetFailureSets/{FailureSetId}/child/failureAssociations

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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:

    • PrimaryKey: Finds assets according to the failure association identifier.
      Finder Variables:
      • SetAssociationId; integer; Value that uniquely identifies the failure association.
  • 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:
    • ActiveEndDate; string; 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.
    • AssetDescription; string; 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.
    • AssetNumber; string; 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.
    • CaptureRequiredCode; string; 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.
    • CaptureRequiredName; string; 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.
    • CreatedBy; string; User who created the failure association. The application automatically sets this value during creation. This attribute is read-only.
    • CreationDate; string; Date when the failure association is created. The application automatically sets this value during creation. This attribute is read-only.
    • FailureSetId; integer; Value that uniquely identifies the failure set. The value is system generated and read-only.
    • ItemCategoryCode; string; Code that uniquely identifies the item category associated to the failure set. This is a required attribute if ObjectTypeCode = ORA_CATEGORY.
    • ItemCategoryDescription; string; Description of the item category in a failure set association. This is a read-only attribute.
    • ItemCategoryId; integer; Number that identifies the Item Category.
    • ItemCategoryName; string; 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.
    • ItemDescription; string; Description of the item in a failure set association. This is a read-only attribute.
    • ItemId; integer; Value that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode = ORA_ITEM.
    • ItemNumber; string; Name that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode = ORA_ITEM.
    • LastUpdateDate; string; Date when the user most recently updated the failure association. The application automatically sets this value during creation. This attribute is read-only.
    • LastUpdateLogin; string; 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.
    • LastUpdatedBy; string; User who most recently updated the failure association. The application assigns a value to this attribute during creation. This attribute is read-only.
    • MasterOrganizationCode; string; Abbreviation that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode = ORA_ITEM.
    • MasterOrganizationId; integer; Value that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode = ORA_ITEM.
    • ObjectTypeCode; string; 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.
    • ObjectTypeMeaning; string; Meaning of the abbreviation that uniquely identifies the object type associated with a failure set. This is a read-only attribute.
    • SetAssociationId; integer; Value that uniquely identifies the failure set association. The value is system generated and 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-failureAssociations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
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.
Back to Top