Collaboration APIs
Get details for a checklist item
| HTTP method | GET |
| URI | https://api.rambase.net/collaboration/tasks/{taskId}/checklist/{taskChecklistItemId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {taskId} |
Unique task identifier
Integer, minimum 100000 |
| - URI parameter {taskChecklistItemId} |
Checklist item unique id
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 2540, version 18 |
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
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. 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>Label
Checklist label. The text associated with this checklistitem (checkbox)
>{String}</Label>Group
Checklist group. The group associated with this checklistitem
Possible domain values can be found here
>{Integer}</Group>CheckType
Defines whether checklist item checkbox or yes/no
Possible domain values can be found here
>{Integer}</CheckType>IsRequired
Checklist required. Defines if the checklist item is mandatory to be checked
>{Boolean}</IsRequired>IsChecked
True if the checklist item has been completed.
Possible domain values can be found here
>{Integer}</IsChecked>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>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>TaskChecklistItemId
Checklist item unique id
": "{Integer}",CreatedAt
Checklist item under a task
": "{Datetime}",Label
Checklist label. The text associated with this checklistitem (checkbox)
": "{String}",Group
Checklist group. The group associated with this checklistitem
Possible domain values can be found here
": "{Integer}",CheckType
Defines whether checklist item checkbox or yes/no
Possible domain values can be found here
": "{Integer}",IsRequired
Checklist required. Defines if the checklist item is mandatory to be checked
": "{Boolean}",IsChecked
True if the checklist item has been completed.
Possible domain values can be found here
": "{Integer}",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}"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}"
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 |