Jump to

• Request
• Response

Update an asset failure event

patch

/fscmRestApi/resources/11.13.18.05/assetFailureEvents/{FailureEventId}/child/failureInstances/{FailureInstanceId}/child/rootCauses/{RootCauseId}

Request

Path Parameters

• FailureEventId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• FailureInstanceId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• RootCauseId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CauseCodeId: integer (int64)
  Title: Cause Code ID

  Value that uniquely identifies the root cause code. The value is system generated and read-only.
• FailureInstanceId: integer (int64)
  Title: Failure Instance ID

  Value that uniquely identifies the failure instance. The value is system generated and read-only.
• RootCauseCode: string
  Title: Cause Code

  Abbreviation that uniquely identifies the root cause of failure. The root cause code is required and if entered must be a valid code. The code must use uppercase letters and alphanumeric.
• RootCauseComments: string
  Title: Comments

  Maximum Length: 2000

  Notes captured with free-text details about the causes and root cause of failure, or any other relevant data. This value is optional.

{
    "type":"object",
    "properties":{
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the root cause code. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FailureInstanceId":{
            "title":"Failure Instance ID",
            "type":"integer",
            "description":"Value that uniquely identifies the failure instance. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RootCauseCode":{
            "title":"Cause Code",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the root cause of failure. The root cause code is required and if entered must be a valid code. The code must use uppercase letters and alphanumeric.",
            "nullable":true
        },
        "RootCauseComments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Notes captured with free-text details about the causes and root cause of failure, or any other relevant data. This value is optional.",
            "nullable":true
        }
    }
}

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 : assetFailureEvents-failureInstances-rootCauses-item-response

Type: object

Show Source

• CauseCodeId: integer (int64)
  Title: Cause Code ID

  Value that uniquely identifies the root cause code. The value is system generated and read-only.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the failure root cause is created. The application automatically sets this value during creation. This attribute is read-only.
• FailureInstanceId: integer (int64)
  Title: Failure Instance ID

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

  The link relations associated with the resource instance.
• RootCauseCategoryCode: string
  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.
• RootCauseCategoryName: string
  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.
• RootCauseCode: string
  Title: Cause Code

  Abbreviation that uniquely identifies the root cause of failure. The root cause code is required and if entered must be a valid code. The code must use uppercase letters and alphanumeric.
• RootCauseComments: string
  Title: Comments

  Maximum Length: 2000

  Notes captured with free-text details about the causes and root cause of failure, or any other relevant data. This value is optional.
• RootCauseDescription: string
  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.
• RootCauseId: integer (int64)
  Title: Root Cause ID

  Read Only: true

  Value that uniquely identifies the root cause. The value is system generated and read-only.
• RootCauseName: string
  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.

{
    "type":"object",
    "properties":{
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the root cause code. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the failure root cause. The application automatically sets this value during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the failure root cause 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
        },
        "FailureInstanceId":{
            "title":"Failure Instance ID",
            "type":"integer",
            "description":"Value that uniquely identifies the failure instance. The value is system generated and read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the failure root cause. 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 root cause. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the failure root cause. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseCategoryCode":{
            "title":"Cause Category Code",
            "maxLength":30,
            "type":"string",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseCategoryName":{
            "title":"Cause Category Name",
            "maxLength":255,
            "type":"string",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseCode":{
            "title":"Cause Code",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the root cause of failure. The root cause code is required and if entered must be a valid code. The code must use uppercase letters and alphanumeric.",
            "nullable":true,
            "x-queryable":true
        },
        "RootCauseComments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Notes captured with free-text details about the causes and root cause of failure, or any other relevant data. This value is optional.",
            "nullable":true,
            "x-queryable":true
        },
        "RootCauseDescription":{
            "title":"Cause Description",
            "maxLength":540,
            "type":"string",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RootCauseId":{
            "title":"Root Cause ID",
            "type":"integer",
            "description":"Value that uniquely identifies the root cause. 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
        },
        "RootCauseName":{
            "title":"Cause Name",
            "maxLength":240,
            "type":"string",
            "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.",
            "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"
            }
        }
    }
}

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