Jump to

• Request
• Response

Update a faulted process by FaultedTransId

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFaultedProcesses/{FaultedTransId}

Request

Path Parameters

• FaultedTransId(required): integer(int64)
  Unique ID of the faulted transaction.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  Classification of a faulted transaction.
• ErrorDetails: string (byte)
  Error details of faulted the transaction.
• ErrorSummary: string
  Maximum Length: 1000

  Error summary of the faulted transaction.
• FaultedTransId: integer (int64)
  Unique ID of the faulted transaction.
• ProcessDefId: string
  Maximum Length: 100

  Process definition unique identifier of a faulted transaction.
• ProcessId: string
  Maximum Length: 100

  Process unique identifier of a faulted transaction.
• ProcessState: string
  Maximum Length: 100

  Process state of a faulted transaction.
• RecipientsUserId: string
  Maximum Length: 1000

  Unique Identifier of a the recipient associated with a faulted transaction.
• RecordId: string
  Maximum Length: 100

  Unique record ID of a faulted transaction.
• RecordKey: integer (int64)
  Record key of a faulted transaction.
• RecordStatus: string
  Maximum Length: 100

  Record status of a faulted transaction.
• RecordType: string
  Maximum Length: 100

  Record type of a faulted transaction.
• ResourceType: string
  Maximum Length: 30

  Recipient type of a faulted transaction.
• SubClassification: string
  Maximum Length: 100

  Subclassification of a faulted transaction.
• TaskId: string
  Maximum Length: 100

  Unique task ID of a faulted transaction.
• TaskStatus: string
  Maximum Length: 100

  Task status of a faulted transaction.

{
    "type":"object",
    "properties":{
        "ErrorSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"Error summary of the faulted transaction.",
            "nullable":true
        },
        "TaskId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique task ID of a faulted transaction.",
            "nullable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"Record key of a faulted transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProcessDefId":{
            "maxLength":"100",
            "type":"string",
            "description":"Process definition unique identifier of a faulted transaction.",
            "nullable":true
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Recipient type of a faulted transaction.",
            "nullable":true
        },
        "ErrorDetails":{
            "type":"string",
            "description":"Error details of faulted the transaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SubClassification":{
            "maxLength":"100",
            "type":"string",
            "description":"Subclassification of a faulted transaction.",
            "nullable":true
        },
        "TaskStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Task status of a faulted transaction.",
            "nullable":true
        },
        "ProcessState":{
            "maxLength":"100",
            "type":"string",
            "description":"Process state of a faulted transaction.",
            "nullable":false
        },
        "FaultedTransId":{
            "type":"integer",
            "description":"Unique ID of the faulted transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"Record type of a faulted transaction.",
            "nullable":false
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"Classification of a faulted transaction.",
            "nullable":true
        },
        "RecipientsUserId":{
            "maxLength":"1000",
            "type":"string",
            "description":"Unique Identifier of a the recipient associated with a faulted transaction.",
            "nullable":true
        },
        "ProcessId":{
            "maxLength":"100",
            "type":"string",
            "description":"Process unique identifier of a faulted transaction.",
            "nullable":false
        },
        "RecordId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique record ID of a faulted transaction.",
            "nullable":false
        },
        "RecordStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Record status of a faulted transaction.",
            "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 : publicSectorFaultedProcesses-item-response

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  Classification of a faulted transaction.
• ErrorDetails: string (byte)
  Error details of faulted the transaction.
• ErrorSummary: string
  Maximum Length: 1000

  Error summary of the faulted transaction.
• FaultedTransId: integer (int64)
  Unique ID of the faulted transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessDefId: string
  Maximum Length: 100

  Process definition unique identifier of a faulted transaction.
• ProcessId: string
  Maximum Length: 100

  Process unique identifier of a faulted transaction.
• ProcessState: string
  Maximum Length: 100

  Process state of a faulted transaction.
• RecipientsUserId: string
  Maximum Length: 1000

  Unique Identifier of a the recipient associated with a faulted transaction.
• RecordId: string
  Maximum Length: 100

  Unique record ID of a faulted transaction.
• RecordKey: integer (int64)
  Record key of a faulted transaction.
• RecordStatus: string
  Maximum Length: 100

  Record status of a faulted transaction.
• RecordType: string
  Maximum Length: 100

  Record type of a faulted transaction.
• ResourceType: string
  Maximum Length: 30

  Recipient type of a faulted transaction.
• SubClassification: string
  Maximum Length: 100

  Subclassification of a faulted transaction.
• TaskId: string
  Maximum Length: 100

  Unique task ID of a faulted transaction.
• TaskStatus: string
  Maximum Length: 100

  Task status of a faulted transaction.

{
    "type":"object",
    "properties":{
        "ErrorSummary":{
            "maxLength":"1000",
            "type":"string",
            "description":"Error summary of the faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique task ID of a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"Record key of a faulted transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcessDefId":{
            "maxLength":"100",
            "type":"string",
            "description":"Process definition unique identifier of a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceType":{
            "maxLength":"30",
            "type":"string",
            "description":"Recipient type of a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorDetails":{
            "type":"string",
            "description":"Error details of faulted the transaction.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SubClassification":{
            "maxLength":"100",
            "type":"string",
            "description":"Subclassification of a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Task status of a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessState":{
            "maxLength":"100",
            "type":"string",
            "description":"Process state of a faulted transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "FaultedTransId":{
            "type":"integer",
            "description":"Unique ID of the faulted transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"Record type of a faulted transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"10",
            "type":"string",
            "description":"Classification of a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RecipientsUserId":{
            "maxLength":"1000",
            "type":"string",
            "description":"Unique Identifier of a the recipient associated with a faulted transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "maxLength":"100",
            "type":"string",
            "description":"Process unique identifier of a faulted transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique record ID of a faulted transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":"100",
            "type":"string",
            "description":"Record status of a faulted transaction.",
            "nullable":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