System APIs
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.
Reason
Required/mandatory field
A reason for granting a systempermission to production systems must be given.
>{String}</Reason>RamBaseSystemId
Required/mandatory field
RamBase system identifier
Minimum value: 1
>{Integer}</RamBaseSystemId>LoginCompany
User main company name in database format
This field is optional.
>Database
Abbreviation/code to identify the company
This field is optional.
>{String}</Database>Reason
Required/mandatory field
A reason for granting a systempermission to production systems must be given.
": "{String}",RamBaseSystemId
Required/mandatory field
RamBase system identifier
Minimum value: 1
": "{Integer}"LoginCompany
User main company name in database format
This field is optional.
": {Database
Abbreviation/code to identify the company
This field is optional.
": "{String}"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.
SystemPermissionId
Unique identifier for a users system permission
>{Integer}</SystemPermissionId>Status
A description of the permissions to the rambasesystem
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date when the system permission was created
>{Datetime}</CreatedAt>Reason
A reason for granting a systempermission to production systems must be given.
>{String}</Reason>HasGlobalDataExtractionAccess
User having access doing data extractions towards the system.
>{Boolean}</HasGlobalDataExtractionAccess>HasDeveloperAccess
User having full development access towards the system.
>{Boolean}</HasDeveloperAccess>EffectiveAt
Date and time the system permission took effect
>{Datetime}</EffectiveAt>ExpireAt
Time the system permission will expire.
>{Datetime}</ExpireAt>LoginCompany
User main company name in database format
>Database
Abbreviation/code to identify the company
>{String}</Database>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>RamBaseSystemId
RamBase system identifier
>{Integer}</RamBaseSystemId>Name
The name of the rambasesystem.
>{String}</Name>Description
Description of the rambasesytem.
>{String}</Description>IsTestSystem
A boolean that indicates if the system is a test-system.
>{Boolean}</IsTestSystem>ContactId
Contact identifier
>{Integer}</ContactId>ContactLink
Contact reference
>{String}</ContactLink>Representing
The customer or supplier represented by the portal user.
>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ObjectLink
API reference to the object
>{String}</ObjectLink>SystemPermissionId
Unique identifier for a users system permission
": "{Integer}",Status
A description of the permissions to the rambasesystem
Possible domain values can be found here
": "{Integer}",CreatedAt
Date when the system permission was created
": "{Datetime}",Reason
A reason for granting a systempermission to production systems must be given.
": "{String}",HasGlobalDataExtractionAccess
User having access doing data extractions towards the system.
": "{Boolean}",HasDeveloperAccess
User having full development access towards the system.
": "{Boolean}",EffectiveAt
Date and time the system permission took effect
": "{Datetime}",ExpireAt
Time the system permission will expire.
": "{Datetime}"LoginCompany
User main company name in database format
": {Database
Abbreviation/code to identify the company
": "{String}"UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"RamBaseSystemId
RamBase system identifier
": "{Integer}",Name
The name of the rambasesystem.
": "{String}",Description
Description of the rambasesytem.
": "{String}",IsTestSystem
A boolean that indicates if the system is a test-system.
": "{Boolean}"ContactId
Contact identifier
": "{Integer}",ContactLink
Contact reference
": "{String}"Representing
The customer or supplier represented by the portal user.
": {ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ObjectLink
API reference to the object
": "{String}"
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: