Collaboration APIs

POST collaboration/task-templates/{taskTemplateId}/checklist

Create a new checklist item for a task template

HTTP method	POST
URI	https://api.rambase.net/collaboration/task-templates/{taskTemplateId}/checklist
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {taskTemplateId}	TaskTemplate unique identifier Integer, minimum 100000
Successful HTTP status code	201
API resource identifier	2546, version 10

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

                                        <TaskTemplateChecklistItem>
                                    

<Label

Label

Required/mandatory field

Checklist item label for the task template

>{String}</Label>

<Group

Group

Checklist group. The group associated with this checklistitem

Applicable domain values can be found here

This field is optional.

>{String}</Group>

<IsRequired

IsRequired

Defines if the checklist item is mandatory to be checked

Default value: True

This field is optional.

>{Boolean}</IsRequired>

<CheckType

CheckType

Defines whether checklist item checkbox or yes/no

Applicable domain values can be found here

This field is optional.

>{Integer}</CheckType>

<Status

Status

Status of the task template checklist item

Applicable domain values can be found here

Default value: 4

This field is optional.

>{Integer}</Status>

                                        </TaskTemplateChecklistItem>
                                    

{

                                             "taskTemplateChecklistItem": {
                                    

"label

Label

Required/mandatory field

Checklist item label for the task template

": "{String}",

"group

Group

Checklist group. The group associated with this checklistitem

Applicable domain values can be found here

This field is optional.

": "{String}",

"isRequired

IsRequired

Defines if the checklist item is mandatory to be checked

Default value: True

This field is optional.

": "{Boolean}",

"checkType

CheckType

Defines whether checklist item checkbox or yes/no

Applicable domain values can be found here

This field is optional.

": "{Integer}",

"status

Status

Status of the task template checklist item

Applicable domain values can be found here

Default value: 4

This field is optional.

": "{Integer}"

}

}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <TaskTemplateChecklistItem>
                                    

<TaskTemplateChecklistItemId

TaskTemplateChecklistItemId

Unique item identifier for the task template checklist item

>{Integer}</TaskTemplateChecklistItemId>

<CreatedAt

CreatedAt

Created stamp for Task template checklist item

>{Datetime}</CreatedAt>

<Label

Label

Checklist item label for the task template

>{String}</Label>

<TaskTemplateChecklistItemLink

TaskTemplateChecklistItemLink

Unique checklist item referencing tasktemplate and its checklist item

>{String}</TaskTemplateChecklistItemLink>

<IsRequired

IsRequired

Defines if the checklist item is mandatory to be checked

>{Boolean}</IsRequired>

                                        </TaskTemplateChecklistItem>
                                    

{

                                             "taskTemplateChecklistItem": {
                                    

"taskTemplateChecklistItemId

TaskTemplateChecklistItemId

Unique item identifier for the task template checklist item

": "{Integer}",

"createdAt

CreatedAt

Created stamp for Task template checklist item

": "{Datetime}",

"label

Label

Checklist item label for the task template

": "{String}",

"taskTemplateChecklistItemLink

TaskTemplateChecklistItemLink

Unique checklist item referencing tasktemplate and its checklist item

": "{String}",

"isRequired

IsRequired

Defines if the checklist item is mandatory to be checked

": "{Boolean}"

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102699 HTTP 404	Task template was not found
Error 107346 HTTP 400	Cannot add the record. Checklist limit exceeded.