POST api/consumer/v1/workspaces/{workspaceId}/jobs/{jobId}/cards/{cardId}/checkList
Add a new Check List to Card
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workspaceId |
Workspace ID |
integer |
Required |
| jobId |
Job ID |
integer |
Required |
| cardId |
Card ID |
integer |
Required |
Body Parameters
New Check List information
CheckListItemEditDto| Name | Description | Type | Additional information |
|---|---|---|---|
| IsCompleted |
If true element is completed, false otherwise |
boolean |
None |
| IsPublic |
If true element is public, false otherwise |
boolean |
None |
| OwnerId |
Owner of element |
integer |
None |
| EntityId |
EntityId of element |
integer |
None |
| EntityFullName |
EntityFullName of the element |
string |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Id |
Unique ID |
integer |
None |
Request Formats
application/json, text/json
Sample:
{
"IsCompleted": true,
"IsPublic": true,
"OwnerId": 3,
"EntityId": 4,
"EntityFullName": "sample string 5",
"Code": "sample string 6",
"Description": "sample string 7",
"IsActive": true,
"Id": 9
}
application/xml, text/xml
Sample:
<CheckListItemEditDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models"> <Id>9</Id> <Code>sample string 6</Code> <Description>sample string 7</Description> <IsActive>true</IsActive> <EntityFullName>sample string 5</EntityFullName> <EntityId>4</EntityId> <IsCompleted>true</IsCompleted> <IsPublic>true</IsPublic> <OwnerId>3</OwnerId> </CheckListItemEditDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
List of found Check List
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None |
|
| Content | HttpContent |
None |
|
| StatusCode | HttpStatusCode |
None |
|
| ReasonPhrase | string |
None |
|
| Headers | Collection of Object |
None |
|
| RequestMessage | HttpRequestMessage |
None |
|
| IsSuccessStatusCode | boolean |
None |