API

RamBase REST APIs

POST system/users/{userId}/system-permissions

Creates a new system permission for the user

HTTP method POST
URI https://api.rambase.net/system/users/{userId}/system-permissions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {userId} User identifier
Integer, minimum 100
Successful HTTP status code 201
API resource identifier 3688, 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
<SystemPermission>
2
     <Reason
Reason

Required/mandatory field

A reason for granting a systempermission to production systems must be given.

>
{String}</Reason>
3
     <RamBaseSystem>
4
          <RamBaseSystemId
RamBaseSystemId

Required/mandatory field

RamBase system identifier

Minimum value: 1

>
{Integer}</RamBaseSystemId>
5
     </RamBaseSystem>
6
     <LoginCompany
LoginCompany

User main company name in database format

This field is optional.

>
7
          <Database
Database

Abbreviation/code to identify the company

This field is optional.

>
{String}</Database>
8
     </LoginCompany>
9
</SystemPermission>
1
{
2
     "systemPermission": {
3
          "reason
Reason

Required/mandatory field

A reason for granting a systempermission to production systems must be given.

":
"{String}",
4
          "ramBaseSystem": {
5
               "ramBaseSystemId
RamBaseSystemId

Required/mandatory field

RamBase system identifier

Minimum value: 1

":
"{Integer}"
6
          },
7
          "loginCompany
LoginCompany

User main company name in database format

This field is optional.

":
{
8
               "database
Database

Abbreviation/code to identify the company

This field is optional.

":
"{String}"
9
          }
10
     }
11
}

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
<SystemPermission>
2
     <SystemPermissionId
SystemPermissionId

Unique identifier for a users system permission

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

A description of the permissions to the rambasesystem

Possible domain values can be found here

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

Date when the system permission was created

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

A reason for granting a systempermission to production systems must be given.

>
{String}</Reason>
6
     <HasGlobalDataExtractionAccess
HasGlobalDataExtractionAccess

User having access doing data extractions towards the system.

>
{Boolean}</HasGlobalDataExtractionAccess>
7
     <HasDeveloperAccess
HasDeveloperAccess

User having full development access towards the system.

>
{Boolean}</HasDeveloperAccess>
8
     <Validity>
9
          <EffectiveAt
EffectiveAt

Date and time the system permission took effect

>
{Datetime}</EffectiveAt>
10
          <ExpireAt
ExpireAt

Time the system permission will expire.

>
{Datetime}</ExpireAt>
11
     </Validity>
12
     <LoginCompany
LoginCompany

User main company name in database format

>
13
          <Database
Database

Abbreviation/code to identify the company

>
{String}</Database>
14
     </LoginCompany>
15
     <CreatedBy>
16
          <UserId
UserId

User identifier

>
{Integer}</UserId>
17
          <FirstName
FirstName

First name of the user

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

Name of the user

>
{String}</Name>
19
          <UserLink
UserLink

User reference

>
{String}</UserLink>
20
     </CreatedBy>
21
     <RamBaseSystem>
22
          <RamBaseSystemId
RamBaseSystemId

RamBase system identifier

>
{Integer}</RamBaseSystemId>
23
          <Name
Name

The name of the rambasesystem.

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

Description of the rambasesytem.

>
{String}</Description>
25
          <IsTestSystem
IsTestSystem

A boolean that indicates if the system is a test-system.

>
{Boolean}</IsTestSystem>
26
     </RamBaseSystem>
27
     <Portal>
28
          <Contact>
29
               <ContactId
ContactId

Contact identifier

>
{Integer}</ContactId>
30
               <ContactLink
ContactLink

Contact reference

>
{String}</ContactLink>
31
          </Contact>
32
          <Representing
Representing

The customer or supplier represented by the portal user.

>
33
               <ObjectId
ObjectId

Identifier of the object

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

Type of object

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

Internal RamBase identifier of the object/item

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

API reference to the object

>
{String}</ObjectLink>
37
          </Representing>
38
     </Portal>
39
</SystemPermission>
1
{
2
     "systemPermission": {
3
          "systemPermissionId
SystemPermissionId

Unique identifier for a users system permission

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

A description of the permissions to the rambasesystem

Possible domain values can be found here

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

Date when the system permission was created

":
"{Datetime}",
6
          "reason
Reason

A reason for granting a systempermission to production systems must be given.

":
"{String}",
7
          "hasGlobalDataExtractionAccess
HasGlobalDataExtractionAccess

User having access doing data extractions towards the system.

":
"{Boolean}",
8
          "hasDeveloperAccess
HasDeveloperAccess

User having full development access towards the system.

":
"{Boolean}",
9
          "validity": {
10
               "effectiveAt
EffectiveAt

Date and time the system permission took effect

":
"{Datetime}",
11
               "expireAt
ExpireAt

Time the system permission will expire.

":
"{Datetime}"
12
          },
13
          "loginCompany
LoginCompany

User main company name in database format

":
{
14
               "database
Database

Abbreviation/code to identify the company

":
"{String}"
15
          },
16
          "createdBy": {
17
               "userId
UserId

User identifier

":
"{Integer}",
18
               "firstName
FirstName

First name of the user

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

Name of the user

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

User reference

":
"{String}"
21
          },
22
          "ramBaseSystem": {
23
               "ramBaseSystemId
RamBaseSystemId

RamBase system identifier

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

The name of the rambasesystem.

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

Description of the rambasesytem.

":
"{String}",
26
               "isTestSystem
IsTestSystem

A boolean that indicates if the system is a test-system.

":
"{Boolean}"
27
          },
28
          "portal": {
29
               "contact": {
30
                    "contactId
ContactId

Contact identifier

":
"{Integer}",
31
                    "contactLink
ContactLink

Contact reference

":
"{String}"
32
               },
33
               "representing
Representing

The customer or supplier represented by the portal user.

":
{
34
                    "objectId
ObjectId

Identifier of the object

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

Type of object

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

Internal RamBase identifier of the object/item

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

API reference to the object

":
"{String}"
38
               }
39
          }
40
     }
41
}

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: