Jump to

• Request
• Response

Get all failure chains

get

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

Request

Path Parameters

• FailureSetId(required): integer(int64)
  Value that uniquely identifies the failure set. The value is system generated and read-only.

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• finder: string
  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 chain identifier.
    Finder Variables:
    • FailureChainId; integer; Value that uniquely identifies the failure chain.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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 chain becomes inactive. This attribute is read-only and is only set when the failureChainDisableFlag passes a value of true.
  • CauseCategoryCode; string; Category code of the cause code associated to chain.
  • CauseCategoryName; string; Category name of the cause code associated to chain.
  • CauseCode; string; 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.
  • CauseCodeId; integer; Value that uniquely identifies the cause code. The value is system generated and read-only.
  • CauseDescription; string; Description of the cause code associated to chain.
  • CauseName; string; Name of the cause code associated to chain.
  • CreatedBy; string; User who created the failure chain. The application automatically sets this value during creation. This attribute is read-only.
  • CreationDate; string; Date when the failure chain is created. The application automatically sets this value during creation. This attribute is read-only.
  • FailureCategoryCode; string; Category code of the failure code associated to chain.
  • FailureCategoryName; string; Category name of the failure code associated to chain.
  • FailureChainId; integer; Value that uniquely identifies the failure chain. The value is system generated and read-only.
  • FailureCode; string; 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.
  • FailureCodeId; integer; Value that uniquely identifies the failure code. The value is system generated and read-only.
  • FailureDescription; string; Description of the failure code associated to chain.
  • FailureName; string; Name of the failure code associated to chain.
  • FailureSetId; integer; Value that uniquely identifies the failure set. The value is system generated and read-only.
  • LastUpdateDate; string; Date when the user most recently updated the failure chain. The application automatically sets this value during creation. This attribute is read-only.
  • LastUpdateLogin; string; 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.
  • LastUpdatedBy; string; User who most recently updated the failure chain. The application assigns a value to this attribute during creation. This attribute is read-only.
  • ResolutionCategoryCode; string; Category code of the resolution code associated to chain.
  • ResolutionCategoryName; string; Category name of the resolution code associated to chain.
  • ResolutionCode; string; 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.
  • ResolutionCodeId; number; Value that uniquely identifies the resolution code. The value is system generated and read-only.
  • ResolutionDescription; string; Description of the resolution code associated to chain.
  • ResolutionName; string; Name of the resolution code associated to chain.
• totalResults: boolean
  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

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : assetFailureSets-failureChains

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/assetFailureSets-failureChains-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object assetFailureSets-failureChains-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assetFailureSets-failureChains-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : assetFailureSets-failureChains-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  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.
• CauseCategoryCode: string
  Title: Cause Category Code

  Read Only: true

  Maximum Length: 255

  Category code of the cause code associated to chain.
• CauseCategoryName: string
  Title: Cause Category Name

  Read Only: true

  Maximum Length: 255

  Category name of the cause code associated to chain.
• CauseCode: string
  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.
• CauseCodeId: integer (int64)
  Title: Cause Code ID

  Value that uniquely identifies the cause code. The value is system generated and read-only.
• CauseDescription: string
  Title: Cause Description

  Read Only: true

  Maximum Length: 255

  Description of the cause code associated to chain.
• CauseName: string
  Title: Cause Name

  Read Only: true

  Maximum Length: 255

  Name of the cause code associated to chain.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the failure chain is created. The application automatically sets this value during creation. This attribute is read-only.
• FailureCategoryCode: string
  Title: Failure Category Code

  Read Only: true

  Maximum Length: 255

  Category code of the failure code associated to chain.
• FailureCategoryName: string
  Title: Failure Category Name

  Read Only: true

  Maximum Length: 255

  Category name of the failure code associated to chain.
• FailureChainDisableFlag: boolean
  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.
• FailureChainId: integer (int64)
  Title: Failure Chain ID

  Read Only: true

  Value that uniquely identifies the failure chain. The value is system generated and read-only.
• FailureCode: string
  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.
• FailureCodeId: integer (int64)
  Title: Failure Code

  Value that uniquely identifies the failure code. The value is system generated and read-only.
• FailureDescription: string
  Title: Failure Description

  Read Only: true

  Maximum Length: 255

  Description of the failure code associated to chain.
• FailureName: string
  Title: Failure Name

  Read Only: true

  Maximum Length: 255

  Name of the failure code associated to chain.
• FailureSetId: integer (int64)
  Title: Failure Set ID

  Value that uniquely identifies the failure set. The value is system generated and read-only.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResolutionCategoryCode: string
  Title: Resolution Category Code

  Read Only: true

  Maximum Length: 255

  Category code of the resolution code associated to chain.
• ResolutionCategoryName: string
  Title: Resolution Category Name

  Read Only: true

  Maximum Length: 255

  Category name of the resolution code associated to chain.
• ResolutionCode: string
  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.
• ResolutionCodeId: number
  Title: Resolution Code ID

  Value that uniquely identifies the resolution code. The value is system generated and read-only.
• ResolutionDescription: string
  Title: Resolution Description

  Read Only: true

  Maximum Length: 255

  Description of the resolution code associated to chain.
• ResolutionName: string
  Title: Resolution Name

  Read Only: true

  Maximum Length: 255

  Name of the resolution code associated to chain.

{
    "type":"object",
    "properties":{
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cause code. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the failure chain is created. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseDescription":{
            "title":"Cause Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the cause code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionDescription":{
            "title":"Resolution Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the resolution code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureSetId":{
            "title":"Failure Set ID",
            "type":"integer",
            "description":"Value that uniquely identifies the failure set. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CauseName":{
            "title":"Cause Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the cause code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCategoryName":{
            "title":"Cause Category Name",
            "maxLength":"255",
            "type":"string",
            "description":"Category name of the cause code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FailureCodeId":{
            "title":"Failure Code",
            "type":"integer",
            "description":"Value that uniquely identifies the failure code. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Date when the failure chain becomes inactive. This attribute is read-only and is only set when the failureChainDisableFlag passes a value of true.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCategoryCode":{
            "title":"Resolution Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Category code of the resolution code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCode":{
            "title":"Resolution Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the failure chain. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the failure chain. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureDescription":{
            "title":"Failure Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the failure code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureCode":{
            "title":"Failure Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"if (FailureCodeVA.first()!= null ) {    return FailureCodeVA.first().getAttribute(\"ConditionEventCode\"); }",
            "x-queryable":true
        },
        "FailureCategoryCode":{
            "title":"Failure Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Category code of the failure code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCodeId":{
            "title":"Resolution Code ID",
            "type":"number",
            "description":"Value that uniquely identifies the resolution code. The value is system generated and read-only.",
            "nullable":false,
            "x-queryable":true
        },
        "FailureChainDisableFlag":{
            "title":"Disable",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FailureCategoryName":{
            "title":"Failure Category Name",
            "maxLength":"255",
            "type":"string",
            "description":"Category name of the failure code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCategoryCode":{
            "title":"Cause Category Code",
            "maxLength":"255",
            "type":"string",
            "description":"Category code of the cause code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCode":{
            "title":"Cause Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "FailureChainId":{
            "title":"Failure Chain ID",
            "type":"integer",
            "description":"Value that uniquely identifies the failure chain. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FailureName":{
            "title":"Failure Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the failure code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCategoryName":{
            "title":"Resolution Category Name",
            "maxLength":"255",
            "type":"string",
            "description":"Category name of the resolution code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the failure chain. The application automatically sets this value during creation. This attribute is read-only.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionName":{
            "title":"Resolution Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the resolution code associated to chain.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top