API

Base APIs

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

Creates new approver assignment

HTTP method POST
URI https://api.rambase.net/base/notification-types/{notificationTypeId}/approval-rules/{approvalRuleId}/approver-assignments
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
Successful HTTP status code 201
API resource identifier 3258, version 4

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

Is default approver

Default value: False

This field is optional.

>{Boolean}</IsDefaultApprover>
3
     <Comment
Comment

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

This field is optional.

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

Required/mandatory field

Link to approver role or user

>
5
          <ObjectId
ObjectId

Required/mandatory field

Identifier of the object

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

Required/mandatory field

Type of object

>{String}</ObjectType>
7
     </Approver>
8
</ApproverAssignment>
1
{
2
     "approverAssignment": {
3
          "isDefaultApprover
IsDefaultApprover

Is default approver

Default value: False

This field is optional.

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

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

This field is optional.

": "{String}",
5
          "approver
Approver

Required/mandatory field

Link to approver role or user

": {
6
               "objectId
ObjectId

Required/mandatory field

Identifier of the object

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

Required/mandatory field

Type of object

": "{String}"
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.
$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]

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

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

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

Valid from

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

Valid to

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

Link to approver role or user

>
11
          <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

Internal RamBase identifier of the object/item

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

API reference to the object

>{String}</ObjectLink>
15
     </Approver>
16
</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
          "comment
Comment

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

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

Valid from

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

Valid to

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

Link to approver role or user

": {
12
               "objectId
ObjectId

Identifier of the object

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

Type of object

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

Internal RamBase identifier of the object/item

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

API reference to the object

": "{String}"
16
          }
17
     }
18
}

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 101015 HTTP 404 Permission not found
Error 105991 HTTP 400 Event is not of the same type as event set on the automated flow
Error 101420 HTTP 404 Setting definition not found