API

Collaboration APIs

GET collaboration/files/{fileId}/versions/{versionId}/approvals/{approvalId}

Get details for a file approval

HTTP method GET
URI https://api.rambase.net/collaboration/files/{fileId}/versions/{versionId}/approvals/{approvalId}
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 {approvalId} Item id for approval items
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 5272, 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
1

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.
$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.

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
<FileApproval>
2
     <FileApprovalId
FileApprovalId

Item id for approval items

>{Integer}</FileApprovalId>
3
     <Status
Status

Status will indicate the current level of approval and general readiness of a file
4: Pending review.
7: Declined approval.
9: Approved.

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <CurrentUserCanApprove
CurrentUserCanApprove

True if current user is allowed to approve the notification.

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserCanApprove in your request URI to get this field

>{Boolean}</CurrentUserCanApprove>
6
     <Response>
7
          <Comment
Comment

Comment made by reviewer

>{String}</Comment>
8
          <ReviewedAt
ReviewedAt

The time the approval type was done

>{Datetime}</ReviewedAt>
9
          <ReviewedBy
ReviewedBy

The userid that approved or declined the approvaltype

>
10
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
11
               <LastName
LastName

Last name of employee

>{String}</LastName>
12
               <FirstName
FirstName

First name of employee

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

Employee reference

>{String}</EmployeeLink>
14
          </ReviewedBy>
15
     </Response>
16
     <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>
17
          <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>{Integer}</NotificationTypeId>
18
          <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>{String}</Category>
19
          <Priority
Priority

Priority of notification with this notification type.

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>{String}</Priority>
20
          <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>{String}</Message>
21
          <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>{String}</TranslatedMessage>
22
          <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

>{String}</NotificationTypeLink>
23
     </NotificationType>
24
</FileApproval>
1
{
2
     "fileApproval": {
3
          "fileApprovalId
FileApprovalId

Item id for approval items

": "{Integer}",
4
          "status
Status

Status will indicate the current level of approval and general readiness of a file
4: Pending review.
7: Declined approval.
9: Approved.

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "currentUserCanApprove
CurrentUserCanApprove

True if current user is allowed to approve the notification.

This field is greyed out because it is an expandable field. You have to add $expand=CurrentUserCanApprove in your request URI to get this field

": "{Boolean}",
7
          "response": {
8
               "comment
Comment

Comment made by reviewer

": "{String}",
9
               "reviewedAt
ReviewedAt

The time the approval type was done

": "{Datetime}",
10
               "reviewedBy
ReviewedBy

The userid that approved or declined the approvaltype

": {
11
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
12
                    "lastName
LastName

Last name of employee

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

First name of employee

": "{String}",
14
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
15
               }
16
          },
17
          "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": {
18
               "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": "{Integer}",
19
               "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": "{String}",
20
               "priority
Priority

Priority of notification with this notification type.

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": "{String}",
21
               "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": "{String}",
22
               "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": "{String}",
23
               "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=NotificationType in your request URI to get this field

": "{String}"
24
          }
25
     }
26
}

Possible error codes the response might return:

Error 101013 HTTP 404 Sub-module not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}