Jump to

• Request
• Response

Update

patch

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

Request

Path Parameters

• FailureChainId(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=
• 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=

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

• FailureChainDisableFlag: boolean
  Title: Disable
• FailureSetId: integer (int64)
  Title: Failure Set ID

{
    "type":"object",
    "properties":{
        "FailureChainDisableFlag":{
            "title":"Disable",
            "type":"boolean",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FailureSetId":{
            "title":"Failure Set ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Active End Date

  Read Only: true
• CauseCategoryCode: string
  Title: Cause Category Code

  Read Only: true

  Maximum Length: 255
• CauseCategoryName: string
  Title: Cause Category Name

  Read Only: true

  Maximum Length: 255
• CauseCode: string
  Title: Cause Code

  Maximum Length: 30
• CauseCodeId: integer (int64)
  Title: Cause Code ID
• CauseDescription: string
  Title: Cause Description

  Read Only: true

  Maximum Length: 255
• CauseName: string
  Title: Cause Name

  Read Only: true

  Maximum Length: 255
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• FailureCategoryCode: string
  Title: Failure Category Code

  Read Only: true

  Maximum Length: 255
• FailureCategoryName: string
  Title: Failure Category Name

  Read Only: true

  Maximum Length: 255
• FailureChainDisableFlag: boolean
  Title: Disable
• FailureChainId: integer (int64)
  Title: Failure Chain ID

  Read Only: true
• FailureCode: string
  Title: Failure Code

  Maximum Length: 30
• FailureCodeId: integer (int64)
  Title: Failure Code
• FailureDescription: string
  Title: Failure Description

  Read Only: true

  Maximum Length: 255
• FailureName: string
  Title: Failure Name

  Read Only: true

  Maximum Length: 255
• FailureSetId: integer (int64)
  Title: Failure Set ID
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• 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
• ResolutionCategoryName: string
  Title: Resolution Category Name

  Read Only: true

  Maximum Length: 255
• ResolutionCode: string
  Title: Resolution Code

  Maximum Length: 30
• ResolutionCodeId: number
  Title: Resolution Code ID
• ResolutionDescription: string
  Title: Resolution Description

  Read Only: true

  Maximum Length: 255
• ResolutionName: string
  Title: Resolution Name

  Read Only: true

  Maximum Length: 255

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCategoryCode":{
            "title":"Cause Category Code",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCategoryName":{
            "title":"Cause Category Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseCode":{
            "title":"Cause Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CauseCodeId":{
            "title":"Cause Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CauseDescription":{
            "title":"Cause Description",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CauseName":{
            "title":"Cause Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureCategoryCode":{
            "title":"Failure Category Code",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureCategoryName":{
            "title":"Failure Category Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureChainDisableFlag":{
            "title":"Disable",
            "type":"boolean",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FailureChainId":{
            "title":"Failure Chain ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FailureCode":{
            "title":"Failure Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FailureCodeId":{
            "title":"Failure Code",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FailureDescription":{
            "title":"Failure Description",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureName":{
            "title":"Failure Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FailureSetId":{
            "title":"Failure Set ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCategoryCode":{
            "title":"Resolution Category Code",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCategoryName":{
            "title":"Resolution Category Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionCode":{
            "title":"Resolution Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionCodeId":{
            "title":"Resolution Code ID",
            "type":"number",
            "nullable":false,
            "x-queryable":true
        },
        "ResolutionDescription":{
            "title":"Resolution Description",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResolutionName":{
            "title":"Resolution Name",
            "maxLength":255,
            "type":"string",
            "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