POST v1/Tasks

Create Task

Request Information

URI Parameters

None.

Body Parameters

Task info

TaskInboundDTO
NameDescriptionTypeAdditional information
Id

Task Id

integer

None.

ModifiedUserId

Modified User Id

integer

None.

ModifiedDate

Modified Date

date

None.

FromUserId

From User Id

integer

None.

CreationDate

Creation Date

date

None.

AssignedUserId

Assigned User Id

integer

None.

ReferenceType

Reference Type

TaskReferenceTypeEnum

None.

ReferenceKey

Reference Key

string

String length: inclusive between 0 and 254

Subject

Subject

string

String length: inclusive between 0 and 254

DueDate

Due Date

date

None.

CompletionDate

Completion Date

date

None.

Status

Status

TaskStatusEnum

None.

Priority

Priority

TaskPriorityEnum

None.

Annotation

Annotation

string

String length: inclusive between 0 and 500

Expand

Comma separated list of expansions to include in results

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "ModifiedUserId": 1,
  "ModifiedDate": "2022-01-20T03:13:42.1296965-10:00",
  "FromUserId": 2,
  "CreationDate": "2022-01-20T03:13:42.1296965-10:00",
  "AssignedUserId": 3,
  "ReferenceType": "Unknown",
  "ReferenceKey": "sample string 4",
  "Subject": "sample string 5",
  "DueDate": "2022-01-20T03:13:42.1296965-10:00",
  "CompletionDate": "2022-01-20T03:13:42.1296965-10:00",
  "Status": "Unknown",
  "Priority": "Unknown",
  "Annotation": "sample string 7",
  "Expand": ""
}

application/xml, text/xml

Sample:
<TaskInboundDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GCApi.Models.Inbound">
  <Expand></Expand>
  <Expansions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GCApi.Enums" />
  <Id>1</Id>
  <Annotation>sample string 7</Annotation>
  <AssignedUserId>3</AssignedUserId>
  <CompletionDate>2022-01-20T03:13:42.1296965-10:00</CompletionDate>
  <CreationDate>2022-01-20T03:13:42.1296965-10:00</CreationDate>
  <DueDate>2022-01-20T03:13:42.1296965-10:00</DueDate>
  <FromUserId>2</FromUserId>
  <ModifiedDate>2022-01-20T03:13:42.1296965-10:00</ModifiedDate>
  <ModifiedUserId>1</ModifiedUserId>
  <Priority>Unknown</Priority>
  <ReferenceKey>sample string 4</ReferenceKey>
  <ReferenceType>Unknown</ReferenceType>
  <Status>Unknown</Status>
  <Subject>sample string 5</Subject>
</TaskInboundDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Id (integer) of newly created task, with Http Status Code 201 when created, 400/500 with error details

IdResponseDTO
NameDescriptionTypeAdditional information
Id

Primary Id

integer

None.

WarningMessages

List of warning messages encountered while servicing request

Collection of string

None.

Response Formats

application/json, text/json

Sample:

Sample not available.