API

Base APIs

GET base/notification-types/{notificationTypeId}/approval-rules/{approvalRuleId}/approver-assignments/{approverAssignmentId}

Get details of an approver for specified rule and assignment identifier

HTTP method GET
URI https://api.rambase.net/base/notification-types/{notificationTypeId}/approval-rules/{approvalRuleId}/approver-assignments/{approverAssignmentId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {notificationTypeId} Notification type identifier
Integer, minimum 100
- URI parameter {approvalRuleId} Approval rule identifier
Integer, minimum 100000
- URI parameter {approverAssignmentId} Approver identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3261, version 6

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
<ApproverAssignment>
2
     <ApproverAssignmentId
ApproverAssignmentId

Approver identifier

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

Approver assignment status

Possible domain values can be found here

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

Is default approver

>{Boolean}</IsDefaultApprover>
5
     <Description
Description

Name of user or role

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

>{String}</Description>
6
     <Comment
Comment

Comment why the user/role has been assigned to the approval rule

>{String}</Comment>
7
     <Validity>
8
          <EffectiveDate
EffectiveDate

Valid from

>{Date}</EffectiveDate>
9
          <ExpirationDate
ExpirationDate

Valid to

>{Date}</ExpirationDate>
10
     </Validity>
11
     <Approver
Approver

Link to approver role or user

>
12
          <ObjectId
ObjectId

Identifier of the object

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

Type of object

>{String}</ObjectType>
14
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
15
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
16
     </Approver>
17
</ApproverAssignment>
1
{
2
     "approverAssignment": {
3
          "approverAssignmentId
ApproverAssignmentId

Approver identifier

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

Approver assignment status

Possible domain values can be found here

": "{Integer}",
5
          "isDefaultApprover
IsDefaultApprover

Is default approver

": "{Boolean}",
6
          "description
Description

Name of user or role

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

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

Comment why the user/role has been assigned to the approval rule

": "{String}",
8
          "validity": {
9
               "effectiveDate
EffectiveDate

Valid from

": "{Date}",
10
               "expirationDate
ExpirationDate

Valid to

": "{Date}"
11
          },
12
          "approver
Approver

Link to approver role or user

": {
13
               "objectId
ObjectId

Identifier of the object

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

Type of object

": "{String}",
15
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}"
17
          }
18
     }
19
}

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 104006 HTTP 404 Approval rule not found
Error 104044 HTTP 404 Approver not found