Collaboration APIs
Lists all checklist items for a task
| HTTP method | GET |
| 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 |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 2538, version 26 |
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.
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.
| $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] |
| $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 |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $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. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| Checked() Named filter | Lists all the checked checklist items |
| Rejected() Named filter | Lists all rejected checklist items |
| Unchecked() Named filter | Lists all unchecked checklist items |
| CheckedBy Integer | User identifier. |
| CheckType Integer | Defines whether checklist item checkbox or yes/no. |
| Comment String | Checklist comment. The comment associated with this checklistitem. |
| CommentedBy Integer | User identifier. |
| CreatedAt Datetime | Checklist item under a task. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| IsRequired Boolean | Checklist required. Defines if the checklist item is mandatory to be checked. |
| Label String | Checklist label. The text associated with this checklistitem (checkbox). |
| TaskChecklistItemId Integer | Checklist item unique id. |
Read more about filters and sorting on how to use sortable parameters
| CheckedBy Integer | User identifier |
| CheckType Integer | Defines whether checklist item checkbox or yes/no |
| Comment String | Checklist comment. The comment associated with this checklistitem |
| CommentedBy Integer | User identifier |
| CreatedAt Datetime | Checklist item under a task |
| IsRequired Boolean | Checklist required. Defines if the checklist item is mandatory to be checked |
| Label String | Checklist label. The text associated with this checklistitem (checkbox) |
| TaskChecklistItemId Integer | Checklist item unique id |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
TaskChecklistItemId
Checklist item unique id
>{Integer}</TaskChecklistItemId>CreatedAt
Checklist item under a task
>{Datetime}</CreatedAt>CheckedAt
Time when a checklist item was marked as checked
>{Datetime}</CheckedAt>CheckedBy
User that ticked off a task checklist item.
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Label
Checklist label. The text associated with this checklistitem (checkbox)
>{String}</Label>IsChecked
True if the checklist item has been completed.
Possible domain values can be found here
>{Integer}</IsChecked>TaskChecklistItemLink
Refernce to a task checklist item
>{String}</TaskChecklistItemLink>Comment
Checklist comment. The comment associated with this checklistitem
>{String}</Comment>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Group
Checklist group. The group associated with this checklistitem
Possible domain values can be found here
>{String}</Group>IsRequired
Checklist required. Defines if the checklist item is mandatory to be checked
>{Boolean}</IsRequired>CheckType
Defines whether checklist item checkbox or yes/no
Possible domain values can be found here
>{Integer}</CheckType>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>TaskChecklistItemId
Checklist item unique id
": "{Integer}",CreatedAt
Checklist item under a task
": "{Datetime}",CheckedAt
Time when a checklist item was marked as checked
": "{Datetime}",CheckedBy
User that ticked off a task checklist item.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Label
Checklist label. The text associated with this checklistitem (checkbox)
": "{String}",IsChecked
True if the checklist item has been completed.
Possible domain values can be found here
": "{Integer}",TaskChecklistItemLink
Refernce to a task checklist item
": "{String}",Comment
Checklist comment. The comment associated with this checklistitem
": "{String}",UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Group
Checklist group. The group associated with this checklistitem
Possible domain values can be found here
": "{String}",IsRequired
Checklist required. Defines if the checklist item is mandatory to be checked
": "{Boolean}",CheckType
Defines whether checklist item checkbox or yes/no
Possible domain values can be found here
": "{Integer}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 108271 HTTP 403 | You are not authorized to view this process |