Jump to

• Request
• Response

Create a workflow task and its associated application data

post

/fscmRestApi/resources/11.13.18.05/publicSectorWorklistTasks

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  The classification for the associated application.
• ProcessId: integer (int64)
  The workflow process ID to which the workflow task belongs.
• PropertyAddress1: string
  Maximum Length: 1000

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

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

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

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

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

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

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

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

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

  The record status for the associated application.
• RecordType: string
  Maximum Length: 100

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

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

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

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

{
    "type":"object",
    "properties":{
        "TaskCreatedDate":{
            "type":"string",
            "description":"The date on which the workflow task got created.",
            "format":"date-time",
            "nullable":false
        },
        "TaskId":{
            "type":"integer",
            "description":"The task ID for the workflow task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":22
            }
        },
        "RecordKey":{
            "type":"integer",
            "description":"The record key for the associated application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TaskPriority":{
            "type":"integer",
            "description":"The priority for the workflow task.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            }
        },
        "TaskDueDate":{
            "type":"string",
            "description":"The due date to complete the workflow task.",
            "format":"date-time",
            "nullable":true
        },
        "PropertyStreetNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The street number in the property address.",
            "nullable":true
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"The sub-classification for the associated application.",
            "nullable":true
        },
        "TaskStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the workflow task.",
            "nullable":false
        },
        "PropertyState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in the property address.",
            "nullable":true
        },
        "PropertyStreetNameConcat":{
            "maxLength":500,
            "type":"string",
            "description":"The street direction, street name, street type and street suffix in the property address.",
            "nullable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type for the associated application.",
            "nullable":false
        },
        "TaskUpdatedDate":{
            "type":"string",
            "description":"The date on which the workflow task got updated.",
            "format":"date-time",
            "nullable":false
        },
        "TaskName":{
            "maxLength":400,
            "type":"string",
            "description":"The name for the workflow task.",
            "nullable":false
        },
        "PropertyPostalCode":{
            "maxLength":100,
            "type":"string",
            "description":"The postal code in the property address.",
            "nullable":true
        },
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification for the associated application.",
            "nullable":true
        },
        "PropertyAddress2":{
            "maxLength":1000,
            "type":"string",
            "description":"The other lines of property address for the associated application.",
            "nullable":true
        },
        "PropertyAddress1":{
            "maxLength":1000,
            "type":"string",
            "description":"The first line of property address for the associated application.",
            "nullable":true
        },
        "RecordDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The record description for the associated application.",
            "nullable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"The workflow process ID to which the workflow task belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":22
            }
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"The record ID for the associated application.",
            "nullable":false
        },
        "PropertyCity":{
            "maxLength":100,
            "type":"string",
            "description":"The city in the property address.",
            "nullable":true
        },
        "RecordStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The record status for the associated application.",
            "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(required):
  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(required):
  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 : publicSectorWorklistTasks-item-response

Type: object

Show Source

• Classification: string
  Maximum Length: 10

  The classification for the associated application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessId: integer (int64)
  The workflow process ID to which the workflow task belongs.
• PropertyAddress1: string
  Maximum Length: 1000

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

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

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

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

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

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

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

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

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

  The record status for the associated application.
• RecordType: string
  Maximum Length: 100

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

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

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

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

{
    "type":"object",
    "properties":{
        "TaskCreatedDate":{
            "type":"string",
            "description":"The date on which the workflow task got created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TaskId":{
            "type":"integer",
            "description":"The task ID for the workflow task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The record key for the associated application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskPriority":{
            "type":"integer",
            "description":"The priority for the workflow task.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "TaskDueDate":{
            "type":"string",
            "description":"The due date to complete the workflow task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyStreetNumber":{
            "maxLength":100,
            "type":"string",
            "description":"The street number in the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "SubClassification":{
            "maxLength":100,
            "type":"string",
            "description":"The sub-classification for the associated application.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskStatus":{
            "maxLength":50,
            "type":"string",
            "description":"The status of the workflow task.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyState":{
            "maxLength":100,
            "type":"string",
            "description":"The state in the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyStreetNameConcat":{
            "maxLength":500,
            "type":"string",
            "description":"The street direction, street name, street type and street suffix in the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type for the associated application.",
            "nullable":false,
            "x-queryable":true
        },
        "TaskUpdatedDate":{
            "type":"string",
            "description":"The date on which the workflow task got updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TaskName":{
            "maxLength":400,
            "type":"string",
            "description":"The name for the workflow task.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":100,
            "type":"string",
            "description":"The postal code in the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":10,
            "type":"string",
            "description":"The classification for the associated application.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress2":{
            "maxLength":1000,
            "type":"string",
            "description":"The other lines of property address for the associated application.",
            "nullable":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "maxLength":1000,
            "type":"string",
            "description":"The first line of property address for the associated application.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordDesc":{
            "maxLength":1000,
            "type":"string",
            "description":"The record description for the associated application.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"The workflow process ID to which the workflow task belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":22
            },
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":100,
            "type":"string",
            "description":"The record ID for the associated application.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":100,
            "type":"string",
            "description":"The city in the property address.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The record status for the associated application.",
            "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