API

Collaboration APIs

POST collaboration/files/{fileId}/versions/{versionId}/approval-checklist

Adds new approval checklist to a file object.

HTTP method POST
URI https://api.rambase.net/collaboration/files/{fileId}/versions/{versionId}/approval-checklist
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
Successful HTTP status code 201
API resource identifier 5165, version 3

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>
2
     <Descripton
Descripton

Required/mandatory field

Descriptive checklist bulletpoint

>{String}</Descripton>
3
</ChecklistItem>
1
{
2
     "checklistItem": {
3
          "descripton
Descripton

Required/mandatory field

Descriptive checklist bulletpoint

": "{String}"
4
     }
5
}

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:
1
<ChecklistItem>
2
     <CheckListItemId
CheckListItemId

ItemId for a checklist item

>{Integer}</CheckListItemId>
3
     <Descripton
Descripton

Descriptive checklist bulletpoint

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

Comments from controller to a checklist item

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

Checkmark to indicate that a bulletpoint has been checked and verified

>{Boolean}</IsChecked>
6
     <CheckedAt
CheckedAt

Time and date the checkpoint was checked or commented

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

Userid for the person who commented or checked this element

>
8
          <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>{String}</UserLink>
12
     </CheckedBy>
13
     <ExclusivelyFor>
14
          <ObjectId
ObjectId

Identifier of the object

>{Integer}</ObjectId>
15
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
16
          <FirstName
FirstName

First name of the customer/supplier

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

Name of the customer/supplier, or last name if it is a person.

>{String}</Name>
18
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
19
     </ExclusivelyFor>
20
</ChecklistItem>
1
{
2
     "checklistItem": {
3
          "checkListItemId
CheckListItemId

ItemId for a checklist item

": "{Integer}",
4
          "descripton
Descripton

Descriptive checklist bulletpoint

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

Comments from controller to a checklist item

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

Checkmark to indicate that a bulletpoint has been checked and verified

": "{Boolean}",
7
          "checkedAt
CheckedAt

Time and date the checkpoint was checked or commented

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

Userid for the person who commented or checked this element

": {
9
               "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

": "{String}"
13
          },
14
          "exclusivelyFor": {
15
               "objectId
ObjectId

Identifier of the object

": "{Integer}",
16
               "objectType
ObjectType

Type of object

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

First name of the customer/supplier

": "{String}",
18
               "name
Name

Name of the customer/supplier, or last name if it is a person.

": "{String}",
19
               "objectLink
ObjectLink

API reference to the object

": "{String}"
20
          }
21
     }
22
}

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