Create task

post

https://{hostname}/api/task-management/v1/tasks

Creates a new task

Body Params

parentEntityId

uuid

required

The unique identifier of the parent record where the task was created.

taskName

string

required

length between 0 and 512

The name of the task.

description

string

length between 0 and 2000

The description of the task.

orgGroupId

uuid

required

The unique identifier of the organization responsible for the task.

taskTypeNameKey

string

required

length between 1 and 100

The key that identifies the type of activity for the task.

assigneeId

uuid

The unique identifier of the user assigned as an assignee on the task.

assigneeEmail

string

length between 0 and 255

The email address of the user assigned as an assignee on the task.

collaborators

array of objects

The details of the collaborators assigned to the task.

collaborators

deadline

date-time

The date and time by which the task should be completed.

context

object

The contextual details of the task.

isActive

boolean

Defaults to true

This flag indicates whether the task is active.

sourceType

string

length between 0 and 16

The type of source that created the task.

sourceId

uuid

The unique identifier of the source that created the task.

resourceId

uuid

The unique identifier of the resource.

resourceTypeNameKey

string

length between 1 and 100

The key used to identify the type of resource.

moduleSource

string

enum

The source product of the task.

priority

string

enum

Defaults to MEDIUM

The priority level of the task.

Allowed:

isRequired

boolean

Defaults to false

This flag indicates whether the task is required.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

201Task created successfully

429Too Many Requests. For more information, see API Rate Limits.