Jump to

• Request
• Response

Update one failure set association

patch

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

Request

Path Parameters

• FailureSetId(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=
• SetAssociationId(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

• CaptureRequiredCode: string
  Title: Capture Required

  Maximum Length: 1

  Default Value: N

  Indicates whether the values are Yes, No, or Corrective only. If yes, a failure code, cause code, and resolution code must be recorded on a failure event instance before the associated work order can be finished. If Corrective only, then a failure code, cause code, and resolution code must be registered on a failure event instance before completing the work order, but only if the work order is of type Corrective. If No, then failure, cause, and resolution aren't required to complete a work order. This attribute defaults to No if no value is provided.
• FailureAssociationDisableFlag: boolean
  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.
• FailureSetId: integer (int64)
  Title: Failure Set ID

  Value that uniquely identifies the failure set. The value is system generated and read-only.
• ItemCategoryId: integer
  Number that identifies the Item Category.
• ObjectTypeCode: string
  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.

{
    "type":"object",
    "properties":{
        "CaptureRequiredCode":{
            "title":"Capture Required",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the values are Yes, No, or Corrective only. If yes, a failure code, cause code, and resolution code must be recorded on a failure event instance before the associated work order can be finished. If Corrective only, then a failure code, cause code, and resolution code must be registered on a failure event instance before completing the work order, but only if the work order is of type Corrective. If No, then failure, cause, and resolution aren't required to complete a work order. This attribute defaults to No if no value is provided.",
            "nullable":false,
            "default":"N"
        },
        "FailureAssociationDisableFlag":{
            "title":"Disable",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
            }
        },
        "ItemCategoryId":{
            "type":"integer",
            "description":"Number that identifies the Item Category.",
            "nullable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false
        }
    }
}

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-failureAssociations-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  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 failureAssociationDisableCheckbox passes a value of true.
• AssetDescription: string
  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.
• AssetId: integer
  Title: Asset ID

  Value that uniquely identifies the asset. The value is system-generated and read-only. This is a required attribute if ObjectTypeCode is ORA_ASSET and no AssetNumber is provided.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 255

  Name that uniquely identifies the asset associated with the failure set. This is a required attribute if ObjectTypeCode is ORA_ASSET and no AssetID is provided.
• CaptureRequiredCode: string
  Title: Capture Required

  Maximum Length: 1

  Default Value: N

  Indicates whether the values are Yes, No, or Corrective only. If yes, a failure code, cause code, and resolution code must be recorded on a failure event instance before the associated work order can be finished. If Corrective only, then a failure code, cause code, and resolution code must be registered on a failure event instance before completing the work order, but only if the work order is of type Corrective. If No, then failure, cause, and resolution aren't required to complete a work order. This attribute defaults to No if no value is provided.
• CaptureRequiredName: string
  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 resolution 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 resolution 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 aren't required to complete a work order. This attribute defaults to No if no value is passed.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  Date when the failure association is created. The application automatically sets this value during creation. This attribute is read-only.
• FailureAssociationDisableFlag: boolean
  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.
• FailureSetId: integer (int64)
  Title: Failure Set ID

  Value that uniquely identifies the failure set. The value is system generated and read-only.
• ItemCategoryCode: string
  Title: Item Category Code

  Maximum Length: 255

  Code that uniquely identifies the item category associated with the failure set. This is a required attribute if ObjectTypeCode is ORA_CATEGORY.
• ItemCategoryDescription: string
  Read Only: true

  Maximum Length: 240

  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
  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.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the associated item.This is a read-only attribute.
• ItemId: integer
  Read Only: true

  Value that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode is ORA_ITEM.
• ItemNumber: string
  Title: Item Number

  Maximum Length: 255

  Name that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode is ORA_ITEM.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• MasterOrganizationCode: string
  Maximum Length: 255

  Abbreviation that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode is ORA_ITEM.
• MasterOrganizationId: integer (int64)
  Value that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode is ORA_ITEM.
• ObjectTypeCode: string
  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.
• ObjectTypeMeaning: string
  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.
• SetAssociationId: integer (int64)
  Title: Set Association ID

  Read Only: true

  Value that uniquely identifies the failure set association. The value is system generated and read-only.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Date when the failure set association becomes inactive. This attribute is read-only and is only set when the failureAssociationDisableCheckbox passes a value of true.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset. The value is system-generated and read-only. This is a required attribute if ObjectTypeCode is ORA_ASSET and no AssetNumber is provided.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the asset associated with the failure set. This is a required attribute if ObjectTypeCode is ORA_ASSET and no AssetID is provided.",
            "nullable":true,
            "x-queryable":true
        },
        "CaptureRequiredCode":{
            "title":"Capture Required",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the values are Yes, No, or Corrective only. If yes, a failure code, cause code, and resolution code must be recorded on a failure event instance before the associated work order can be finished. If Corrective only, then a failure code, cause code, and resolution code must be registered on a failure event instance before completing the work order, but only if the work order is of type Corrective. If No, then failure, cause, and resolution aren't required to complete a work order. This attribute defaults to No if no value is provided.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CaptureRequiredName":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name corresponding to one yes, no, or corrective only values. If yes, then a failure code, cause code, and resolution 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 resolution 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 aren't required to complete a work order. This attribute defaults to No if no value is passed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the failure association. 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 association 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
        },
        "FailureAssociationDisableFlag":{
            "title":"Disable",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "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
        },
        "ItemCategoryCode":{
            "title":"Item Category Code",
            "maxLength":255,
            "type":"string",
            "description":"Code that uniquely identifies the item category associated with the failure set. This is a required attribute if ObjectTypeCode is ORA_CATEGORY.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ItemCategoryDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item category in a failure set association. This is a read-only attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategoryId":{
            "type":"integer",
            "description":"Number that identifies the Item Category.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCategoryName":{
            "title":"Item Category Name",
            "maxLength":255,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the associated item.This is a read-only attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode is ORA_ITEM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":255,
            "type":"string",
            "description":"Name that uniquely identifies the associated item. This is a required attribute if ObjectTypeCode is ORA_ITEM.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the failure association. 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 association. 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 association. The application assigns a value to this attribute during creation. This attribute is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode is ORA_ITEM.",
            "nullable":true,
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the master organization in which the associated item is created. This attribute is required when ObjectTypeCode is ORA_ITEM.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectTypeMeaning":{
            "maxLength":240,
            "type":"string",
            "description":"Meaning of the abbreviation that uniquely identifies the object type associated with a failure set. This is a read-only attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetAssociationId":{
            "title":"Set Association ID",
            "type":"integer",
            "description":"Value that uniquely identifies the failure set association. 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
        },
        "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