API

Collaboration APIs

POST collaboration/tasks/{taskId}/checklist

Creates a new checklist item

HTTP method POST
URI https://api.rambase.net/collaboration/tasks/{taskId}/checklist
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {taskId} Unique task identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2541, version 17

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:
1
<TaskChecklistItem>
2
     <Label
Label

Required/mandatory field

Checklist label. The text associated with this checklistitem (checkbox)

>{String}</Label>
3
     <Comment
Comment

Checklist comment. The comment associated with this checklistitem

This field is optional.

>{String}</Comment>
4
     <Group
Group

Checklist group. The group associated with this checklistitem

Applicable domain values can be found here

This field is optional.

>{String}</Group>
5
     <IsRequired
IsRequired

Checklist required. Defines if the checklist item is mandatory to be checked

Default value: False

This field is optional.

>{Boolean}</IsRequired>
6
     <CheckType
CheckType

Defines whether checklist item checkbox or yes/no

Applicable domain values can be found here

Minimum value: 1

Maximum value: 2

This field is optional.

>{Integer}</CheckType>
7
</TaskChecklistItem>
1
{
2
     "taskChecklistItem": {
3
          "label
Label

Required/mandatory field

Checklist label. The text associated with this checklistitem (checkbox)

": "{String}",
4
          "comment
Comment

Checklist comment. The comment associated with this checklistitem

This field is optional.

": "{String}",
5
          "group
Group

Checklist group. The group associated with this checklistitem

Applicable domain values can be found here

This field is optional.

": "{String}",
6
          "isRequired
IsRequired

Checklist required. Defines if the checklist item is mandatory to be checked

Default value: False

This field is optional.

": "{Boolean}",
7
          "checkType
CheckType

Defines whether checklist item checkbox or yes/no

Applicable domain values can be found here

Minimum value: 1

Maximum value: 2

This field is optional.

": "{Integer}"
8
     }
9
}

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.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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:
1
<TaskChecklistItem>
2
     <TaskChecklistItemId
TaskChecklistItemId

Checklist item unique id

>{Integer}</TaskChecklistItemId>
3
     <CreatedAt
CreatedAt

Checklist item under a task

>{Datetime}</CreatedAt>
4
     <Label
Label

Checklist label. The text associated with this checklistitem (checkbox)

>{String}</Label>
5
     <Group
Group

Checklist group. The group associated with this checklistitem

Possible domain values can be found here

>{Integer}</Group>
6
     <CheckType
CheckType

Defines whether checklist item checkbox or yes/no

Possible domain values can be found here

>{Integer}</CheckType>
7
     <IsRequired
IsRequired

Checklist required. Defines if the checklist item is mandatory to be checked

>{Boolean}</IsRequired>
8
     <IsChecked
IsChecked

True if the checklist item has been completed.

Possible domain values can be found here

>{Integer}</IsChecked>
9
     <CheckedAt
CheckedAt

Time when a checklist item was marked as checked

>{Datetime}</CheckedAt>
10
     <CheckedBy
CheckedBy

User that ticked off a task checklist item.

>
11
          <UserId
UserId

User identifier

>{Integer}</UserId>
12
          <Name
Name

Name of the user

>{String}</Name>
13
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
14
          <UserLink
UserLink

User reference

>{String}</UserLink>
15
     </CheckedBy>
16
     <Comment
Comment

Checklist comment. The comment associated with this checklistitem

>{String}</Comment>
17
     <CommentedBy>
18
          <UserId
UserId

User identifier

>{Integer}</UserId>
19
          <Name
Name

Name of the user

>{String}</Name>
20
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
21
          <UserLink
UserLink

User reference

>{String}</UserLink>
22
     </CommentedBy>
23
</TaskChecklistItem>
1
{
2
     "taskChecklistItem": {
3
          "taskChecklistItemId
TaskChecklistItemId

Checklist item unique id

": "{Integer}",
4
          "createdAt
CreatedAt

Checklist item under a task

": "{Datetime}",
5
          "label
Label

Checklist label. The text associated with this checklistitem (checkbox)

": "{String}",
6
          "group
Group

Checklist group. The group associated with this checklistitem

Possible domain values can be found here

": "{Integer}",
7
          "checkType
CheckType

Defines whether checklist item checkbox or yes/no

Possible domain values can be found here

": "{Integer}",
8
          "isRequired
IsRequired

Checklist required. Defines if the checklist item is mandatory to be checked

": "{Boolean}",
9
          "isChecked
IsChecked

True if the checklist item has been completed.

Possible domain values can be found here

": "{Integer}",
10
          "checkedAt
CheckedAt

Time when a checklist item was marked as checked

": "{Datetime}",
11
          "checkedBy
CheckedBy

User that ticked off a task checklist item.

": {
12
               "userId
UserId

User identifier

": "{Integer}",
13
               "name
Name

Name of the user

": "{String}",
14
               "firstName
FirstName

First name of the user

": "{String}",
15
               "userLink
UserLink

User reference

": "{String}"
16
          },
17
          "comment
Comment

Checklist comment. The comment associated with this checklistitem

": "{String}",
18
          "commentedBy": {
19
               "userId
UserId

User identifier

": "{Integer}",
20
               "name
Name

Name of the user

": "{String}",
21
               "firstName
FirstName

First name of the user

": "{String}",
22
               "userLink
UserLink

User reference

": "{String}"
23
          }
24
     }
25
}

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 101606 HTTP 404 Module not found
Error 101079 HTTP 400 Mismatch in size of revision parameters