API

System APIs

POST system/duties/{dutyId}/privileges

Create a privilege for a specific duty.

HTTP method POST
URI https://api.rambase.net/system/duties/{dutyId}/privileges
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {dutyId} Duty identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2151, version 10

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
<Privilege>
2
     <Permission>
3
          <PermissionId
PermissionId

Required/mandatory field

Permission identifier

>{Integer}</PermissionId>
4
     </Permission>
5
</Privilege>
1
{
2
     "privilege": {
3
          "permission": {
4
               "permissionId
PermissionId

Required/mandatory field

Permission identifier

": "{Integer}"
5
          }
6
     }
7
}

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
<Privilege>
2
     <PrivilegeId
PrivilegeId

Privilege identifier

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

Status of privilege

Possible domain values can be found here

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

Date and time of creation

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

Datarestriction put on the link between a duty and a permission (privilege)

>{String}</DataRestriction>
6
     <RamBaseDataRestriction
RamBaseDataRestriction

The data restriction in RamBase internal syntax

>{String}</RamBaseDataRestriction>
7
     <Note
Note

The group title field. Used to identify different mappings of the same permission that have different datarestrictions

>{String}</Note>
8
     <Permission>
9
          <PermissionId
PermissionId

Permission identifier

>{Integer}</PermissionId>
10
          <Status
Status

Status of the permission

Possible domain values can be found here

>{Integer}</Status>
11
          <Name
Name

Name of the permission

>{String}</Name>
12
          <Description
Description

Technical description of the permission

>{String}</Description>
13
          <TranslatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

>{String}</TranslatedDescription>
14
          <FieldAPIResource>
15
               <Verb
Verb

Reference to the verb the API resource uses (GET, POST, PUT, DELETE)

>{String}</Verb>
16
               <Url
Url

Reference to API resource that holds the fields that can be restricted for the permission.

>{String}</Url>
17
          </FieldAPIResource>
18
          <FilterAPIResource>
19
               <Url
Url

Reference to API resource that will be used when building data restrictions on duties.

>{String}</Url>
20
          </FilterAPIResource>
21
          <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
22
          <Scope
Scope

Scope of privilege

>{String}</Scope>
23
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
24
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
25
               <UserId
UserId

User identifier

>{Integer}</UserId>
26
               <UserLink
UserLink

User reference

>{String}</UserLink>
27
          </ChangedBy>
28
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
29
     </Permission>
30
</Privilege>
1
{
2
     "privilege": {
3
          "privilegeId
PrivilegeId

Privilege identifier

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

Status of privilege

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "dataRestriction
DataRestriction

Datarestriction put on the link between a duty and a permission (privilege)

": "{String}",
7
          "ramBaseDataRestriction
RamBaseDataRestriction

The data restriction in RamBase internal syntax

": "{String}",
8
          "note
Note

The group title field. Used to identify different mappings of the same permission that have different datarestrictions

": "{String}",
9
          "permission": {
10
               "permissionId
PermissionId

Permission identifier

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

Status of the permission

Possible domain values can be found here

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

Name of the permission

": "{String}",
13
               "description
Description

Technical description of the permission

": "{String}",
14
               "translatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

": "{String}",
15
               "fieldAPIResource": {
16
                    "verb
Verb

Reference to the verb the API resource uses (GET, POST, PUT, DELETE)

": "{String}",
17
                    "url
Url

Reference to API resource that holds the fields that can be restricted for the permission.

": "{String}"
18
               },
19
               "filterAPIResource": {
20
                    "url
Url

Reference to API resource that will be used when building data restrictions on duties.

": "{String}"
21
               },
22
               "permissionLink
PermissionLink

Permission reference

": "{String}",
23
               "scope
Scope

Scope of privilege

": "{String}",
24
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
25
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
26
                    "userId
UserId

User identifier

": "{Integer}",
27
                    "userLink
UserLink

User reference

": "{String}"
28
               },
29
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
30
          }
31
     }
32
}

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 101079 HTTP 400 Mismatch in size of revision parameters
Error 107892 HTTP 403 You don't have the requierd user level for this permission
Error 104493 HTTP 400 Only JHC users can do global changes to privileges
Error 107890 HTTP 400 Permission "{0}" has higher required user level than duty.
Error 101793 HTTP 400 Permissions with no API reference can only be added to a specific duty once