API

Collaboration APIs

PUT collaboration/files/{fileId}/versions/{versionId}/approval-checklist/{checkListItemId}

Updates a fileapproval checklist item

HTTP method PUT
URI https://api.rambase.net/collaboration/files/{fileId}/versions/{versionId}/approval-checklist/{checkListItemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {fileId} File identifier
Integer, minimum 100000
- URI parameter {versionId} Version of the file
Integer, minimum 100
- URI parameter {checkListItemId} ItemId for a checklist item
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5268, version 2

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
<ChecklistItem
ChecklistItem

This field is optional.

>
2
     <Descripton
Descripton

Descriptive checklist bulletpoint

This field is optional.

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

Comments from controller to a checklist item

This field is optional.

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

Checkmark to indicate that a bulletpoint has been checked and verified

This field is optional.

>{Boolean}</IsChecked>
5
     <CheckedBy
CheckedBy

Userid for the person who commented or checked this element

This field is optional.

>
6
          <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
7
     </CheckedBy>
8
</ChecklistItem>
1
{
2
     "checklistItem
ChecklistItem

This field is optional.

": {
3
          "descripton
Descripton

Descriptive checklist bulletpoint

This field is optional.

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

Comments from controller to a checklist item

This field is optional.

": "{String}",
5
          "isChecked
IsChecked

Checkmark to indicate that a bulletpoint has been checked and verified

This field is optional.

": "{Boolean}",
6
          "checkedBy
CheckedBy

Userid for the person who commented or checked this element

This field is optional.

": {
7
               "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
8
          }
9
     }
10
}

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.

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.

Format:
1
1

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 103815 HTTP 404 File version not found
Error 107213 HTTP 400 File approval checklist id not found