API

System APIs

POST system/deployment-packages

Creates a new deployment package

HTTP method POST
URI https://api.rambase.net/system/deployment-packages
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5625, version 5

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
<DeploymentPackage>
2
     <Name
Name

Required/mandatory field

Name of deployment object package

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

Description of deployment package object

This field is optional.

>{String}</Description>
4
     <RiskAssessment
RiskAssessment

This field is optional.

>
5
          <IsEmergency
IsEmergency

True if deployment is urgent

Default value: False

This field is optional.

>{Boolean}</IsEmergency>
6
     </RiskAssessment>
7
     <DeploymentObjects
DeploymentObjects

This field is optional.

>
8
          <DeploymentObject
DeploymentObject

This field is optional.

>
9
               <Comment
Comment

Comment to the deployment object

This field is optional.

>{String}</Comment>
10
               <Object
Object

This field is optional.

>
11
                    <ObjectType
ObjectType

Type of object

This field is optional.

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

Identifier of the object

This field is optional.

>{String}</ObjectId>
13
               </Object>
14
          </DeploymentObject>
15
     </DeploymentObjects>
16
     <DeploymentPackageAdministrators
DeploymentPackageAdministrators

This field is optional.

>
17
          <DeploymentPackageAdministrator
DeploymentPackageAdministrator

This field is optional.

>
18
               <User
User

This field is optional.

>
19
                    <UserId
UserId

User identifier

Minimum value: 100

This field is optional.

>{Integer}</UserId>
20
               </User>
21
          </DeploymentPackageAdministrator>
22
     </DeploymentPackageAdministrators>
23
</DeploymentPackage>
1
{
2
     "deploymentPackage": {
3
          "name
Name

Required/mandatory field

Name of deployment object package

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

Description of deployment package object

This field is optional.

": "{String}",
5
          "riskAssessment
RiskAssessment

This field is optional.

": {
6
               "isEmergency
IsEmergency

True if deployment is urgent

Default value: False

This field is optional.

": "{Boolean}"
7
          },
8
          "deploymentObjects
DeploymentObjects

This field is optional.

": [
9
               {
10
                    "comment
Comment

Comment to the deployment object

This field is optional.

": "{String}",
11
                    "object
Object

This field is optional.

": {
12
                         "objectType
ObjectType

Type of object

This field is optional.

": "{String}",
13
                         "objectId
ObjectId

Identifier of the object

This field is optional.

": "{String}"
14
                    }
15
               }
16
          ],
17
          "deploymentPackageAdministrators
DeploymentPackageAdministrators

This field is optional.

": [
18
               {
19
                    "user
User

This field is optional.

": {
20
                         "userId
UserId

User identifier

Minimum value: 100

This field is optional.

": "{Integer}"
21
                    }
22
               }
23
          ]
24
     }
25
}

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
<DeploymentPackage>
2
     <DeploymentPackageId
DeploymentPackageId

Deployment package identifier

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

Status of deployment package

Possible domain values can be found here

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

Date and time of creation

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

Name of deployment object package

>{String}</Name>
6
     <ExternalReference
ExternalReference

External reference (jira issue) of deployment package

>{String}</ExternalReference>
7
     <Description
Description

Description of deployment package object

>{String}</Description>
8
     <NumberOfObjects
NumberOfObjects

Number of objects in package

>{Integer}</NumberOfObjects>
9
     <NumberOfFolders
NumberOfFolders

Number of folders in package

>{Integer}</NumberOfFolders>
10
     <NumberOfControls
NumberOfControls

Number of control in deployment package

>{Integer}</NumberOfControls>
11
     <NumberOfRelatedAPIResources
NumberOfRelatedAPIResources

Total number of related API resources added to deployment package

>{Integer}</NumberOfRelatedAPIResources>
12
     <CommittedAt
CommittedAt

Date and time deployment package was committed

>{Datetime}</CommittedAt>
13
     <CommittedBy>
14
          <UserId
UserId

User identifier

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

First name of the user

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

Name of the user

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

User reference

>{String}</UserLink>
18
     </CommittedBy>
19
     <RiskAssessment>
20
          <IsEmergency
IsEmergency

True if deployment is urgent

>{Boolean}</IsEmergency>
21
          <RiskScore
RiskScore

Risk score of assessment

>{Integer}</RiskScore>
22
          <ReducedProductQuality>
23
               <Severity
Severity

Severity of reduced product quality

Possible domain values can be found here

>{Integer}</Severity>
24
               <Likelihood
Likelihood

Likelihood of reduced product quality

Possible domain values can be found here

>{Integer}</Likelihood>
25
          </ReducedProductQuality>
26
     </RiskAssessment>
27
</DeploymentPackage>
1
{
2
     "deploymentPackage": {
3
          "deploymentPackageId
DeploymentPackageId

Deployment package identifier

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

Status of deployment package

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of deployment object package

": "{String}",
7
          "externalReference
ExternalReference

External reference (jira issue) of deployment package

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

Description of deployment package object

": "{String}",
9
          "numberOfObjects
NumberOfObjects

Number of objects in package

": "{Integer}",
10
          "numberOfFolders
NumberOfFolders

Number of folders in package

": "{Integer}",
11
          "numberOfControls
NumberOfControls

Number of control in deployment package

": "{Integer}",
12
          "numberOfRelatedAPIResources
NumberOfRelatedAPIResources

Total number of related API resources added to deployment package

": "{Integer}",
13
          "committedAt
CommittedAt

Date and time deployment package was committed

": "{Datetime}",
14
          "committedBy": {
15
               "userId
UserId

User identifier

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

First name of the user

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

Name of the user

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

User reference

": "{String}"
19
          },
20
          "riskAssessment": {
21
               "isEmergency
IsEmergency

True if deployment is urgent

": "{Boolean}",
22
               "riskScore
RiskScore

Risk score of assessment

": "{Integer}",
23
               "reducedProductQuality": {
24
                    "severity
Severity

Severity of reduced product quality

Possible domain values can be found here

": "{Integer}",
25
                    "likelihood
Likelihood

Likelihood of reduced product quality

Possible domain values can be found here

": "{Integer}"
26
               }
27
          }
28
     }
29
}

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 104814 HTTP 400 Invalid archive
Error 101551 HTTP 404 Object {0} not found
Error 104815 HTTP 400 Object already exists
Error 104833 HTTP 404 Folder not found