API

System APIs

POST system/deployment-packages/{deploymentPackageId}/risk-controls

Adds a risk control to deployment package

HTTP method POST
URI https://api.rambase.net/system/deployment-packages/{deploymentPackageId}/risk-controls
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {deploymentPackageId} Deployment package identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 5675, version 1

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
<RiskControl>
2
     <Control
Control

Required/mandatory field

Identifier of the control

Applicable domain values can be found here

>{Integer}</Control>
3
</RiskControl>
1
{
2
     "riskControl": {
3
          "control
Control

Required/mandatory field

Identifier of the control

Applicable domain values can be found here

": "{Integer}"
4
     }
5
}

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
<RiskControl>
2
     <RiskControlId
RiskControlId

Risk control identifier

>{Integer}</RiskControlId>
3
     <Control
Control

Identifier of the control

Possible domain values can be found here

>{Integer}</Control>
4
     <AddedAt
AddedAt

Date and time risk control was added to deployment package

>{Datetime}</AddedAt>
5
     <AddedBy>
6
          <UserId
UserId

User identifier

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

User reference

>{String}</UserLink>
8
     </AddedBy>
9
</RiskControl>
1
{
2
     "riskControl": {
3
          "riskControlId
RiskControlId

Risk control identifier

": "{Integer}",
4
          "control
Control

Identifier of the control

Possible domain values can be found here

": "{Integer}",
5
          "addedAt
AddedAt

Date and time risk control was added to deployment package

": "{Datetime}",
6
          "addedBy": {
7
               "userId
UserId

User identifier

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

User reference

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

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 107815 HTTP 400 Only administrators of this deployment package can perform this operation