Jump to

• Request
• Response

Update a workflow task and its associated application data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks/{TaskId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• TaskId: integer
  The task ID for the workflow task.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorWorklistTasks-item

Type: object

Show Source

• Classification(optional): string
  Maximum Length: 10

  The classification for the associated application.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessId(optional): integer(int64)
  The workflow process ID to which the workflow task belongs.
• PropertyAddress1(optional): string
  Maximum Length: 1000

  The first line of property address for the associated application.
• PropertyAddress2(optional): string
  Maximum Length: 1000

  The other lines of property address for the associated application.
• PropertyCity(optional): string
  Maximum Length: 100

  The city in the property address.
• PropertyPostalCode(optional): string
  Maximum Length: 100

  The postal code in the property address.
• PropertyState(optional): string
  Maximum Length: 100

  The state in the property address.
• PropertyStreetNameConcat(optional): string
  Maximum Length: 500

  The street direction, street name, street type and street suffix in the property address.
• PropertyStreetNumber(optional): string
  Maximum Length: 100

  The street number in the property address.
• RecordDesc(optional): string
  Maximum Length: 1000

  The record description for the associated application.
• RecordId(optional): string
  Maximum Length: 100

  The record ID for the associated application.
• RecordKey(optional): integer(int64)
  The record key for the associated application.
• RecordType(optional): string
  Maximum Length: 100

  The record type for the associated application.
• SubClassification(optional): string
  Maximum Length: 100

  The sub-classification for the associated application.
• TaskCreatedDate(optional): string(date-time)
  The date on which the workflow task got created.
• TaskDueDate(optional): string(date-time)
  The due date to complete the workflow task.
• TaskId(optional): integer(int64)
  The task ID for the workflow task.
• TaskName(optional): string
  Maximum Length: 400

  The name for the workflow task.
• TaskPriority(optional): integer(int32)
  The priority for the workflow task.
• TaskStatus(optional): string
  Maximum Length: 50

  The status of the workflow task.
• TaskUpdatedDate(optional): string(date-time)
  The date on which the workflow task got updated.

{
    "properties":{
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification for the associated application."
        },
        "ProcessId":{
            "format":"int64",
            "type":"integer",
            "description":"The workflow process ID to which the workflow task belongs."
        },
        "PropertyAddress1":{
            "maxLength":1000,
            "type":"string",
            "description":"The first line of property address for the associated application."
        },
        "PropertyAddress2":{
            "maxLength":1000,
            "type":"string",
            "description":"The other lines of property address for the associated application."
        },
        "PropertyCity":{
            "maxLength":100,
            "type":"string",
            "description":"The city in the property address."
        },
        "PropertyPostalCode":{
            "maxLength":100,
            "type":"string",
            "description":"The postal code in the property address."
        },
        "PropertyState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in the property address."
        },
        "PropertyStreetNameConcat":{
            "maxLength":500,
            "type":"string",
            "description":"The street direction, street name, street type and street suffix in the property address."
        },
        "PropertyStreetNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The street number in the property address."
        },
        "RecordDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The record description for the associated application."
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"The record ID for the associated application."
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The record key for the associated application."
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type for the associated application."
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"The sub-classification for the associated application."
        },
        "TaskCreatedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the workflow task got created."
        },
        "TaskDueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The due date to complete the workflow task."
        },
        "TaskId":{
            "format":"int64",
            "type":"integer",
            "description":"The task ID for the workflow task."
        },
        "TaskName":{
            "maxLength":400,
            "type":"string",
            "description":"The name for the workflow task."
        },
        "TaskPriority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority for the workflow task."
        },
        "TaskStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the workflow task."
        },
        "TaskUpdatedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the workflow task got updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorWorklistTasks-item

Type: object

Show Source

• Classification(optional): string
  Maximum Length: 10

  The classification for the associated application.
• links(optional): array Items
  Title: Items

  Link Relations
• ProcessId(optional): integer(int64)
  The workflow process ID to which the workflow task belongs.
• PropertyAddress1(optional): string
  Maximum Length: 1000

  The first line of property address for the associated application.
• PropertyAddress2(optional): string
  Maximum Length: 1000

  The other lines of property address for the associated application.
• PropertyCity(optional): string
  Maximum Length: 100

  The city in the property address.
• PropertyPostalCode(optional): string
  Maximum Length: 100

  The postal code in the property address.
• PropertyState(optional): string
  Maximum Length: 100

  The state in the property address.
• PropertyStreetNameConcat(optional): string
  Maximum Length: 500

  The street direction, street name, street type and street suffix in the property address.
• PropertyStreetNumber(optional): string
  Maximum Length: 100

  The street number in the property address.
• RecordDesc(optional): string
  Maximum Length: 1000

  The record description for the associated application.
• RecordId(optional): string
  Maximum Length: 100

  The record ID for the associated application.
• RecordKey(optional): integer(int64)
  The record key for the associated application.
• RecordType(optional): string
  Maximum Length: 100

  The record type for the associated application.
• SubClassification(optional): string
  Maximum Length: 100

  The sub-classification for the associated application.
• TaskCreatedDate(optional): string(date-time)
  The date on which the workflow task got created.
• TaskDueDate(optional): string(date-time)
  The due date to complete the workflow task.
• TaskId(optional): integer(int64)
  The task ID for the workflow task.
• TaskName(optional): string
  Maximum Length: 400

  The name for the workflow task.
• TaskPriority(optional): integer(int32)
  The priority for the workflow task.
• TaskStatus(optional): string
  Maximum Length: 50

  The status of the workflow task.
• TaskUpdatedDate(optional): string(date-time)
  The date on which the workflow task got updated.

{
    "properties":{
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification for the associated application."
        },
        "ProcessId":{
            "format":"int64",
            "type":"integer",
            "description":"The workflow process ID to which the workflow task belongs."
        },
        "PropertyAddress1":{
            "maxLength":1000,
            "type":"string",
            "description":"The first line of property address for the associated application."
        },
        "PropertyAddress2":{
            "maxLength":1000,
            "type":"string",
            "description":"The other lines of property address for the associated application."
        },
        "PropertyCity":{
            "maxLength":100,
            "type":"string",
            "description":"The city in the property address."
        },
        "PropertyPostalCode":{
            "maxLength":100,
            "type":"string",
            "description":"The postal code in the property address."
        },
        "PropertyState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in the property address."
        },
        "PropertyStreetNameConcat":{
            "maxLength":500,
            "type":"string",
            "description":"The street direction, street name, street type and street suffix in the property address."
        },
        "PropertyStreetNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The street number in the property address."
        },
        "RecordDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The record description for the associated application."
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"The record ID for the associated application."
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The record key for the associated application."
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type for the associated application."
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"The sub-classification for the associated application."
        },
        "TaskCreatedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the workflow task got created."
        },
        "TaskDueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The due date to complete the workflow task."
        },
        "TaskId":{
            "format":"int64",
            "type":"integer",
            "description":"The task ID for the workflow task."
        },
        "TaskName":{
            "maxLength":400,
            "type":"string",
            "description":"The name for the workflow task."
        },
        "TaskPriority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority for the workflow task."
        },
        "TaskStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the workflow task."
        },
        "TaskUpdatedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the workflow task got updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top