API

System APIs

POST system/deployment-packages/{deploymentPackageId}/objects

Adds an object to deployment package

HTTP method POST
URI https://api.rambase.net/system/deployment-packages/{deploymentPackageId}/objects
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 5622, version 2

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
<DeploymentObject>
2
     <Comment
Comment

Comment to the deployment object

This field is optional.

>{String}</Comment>
3
     <Object>
4
          <ObjectType
ObjectType

Required/mandatory field

Type of object

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

Required/mandatory field

Identifier of the object

>{String}</ObjectId>
6
     </Object>
7
     <DeploymentFolder
DeploymentFolder

This field is optional.

>
8
          <DeploymentFolderId
DeploymentFolderId

Deployment folder identifier

Minimum value: 1

This field is optional.

>{Integer}</DeploymentFolderId>
9
     </DeploymentFolder>
10
</DeploymentObject>
1
{
2
     "deploymentObject": {
3
          "comment
Comment

Comment to the deployment object

This field is optional.

": "{String}",
4
          "object": {
5
               "objectType
ObjectType

Required/mandatory field

Type of object

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

Required/mandatory field

Identifier of the object

": "{String}"
7
          },
8
          "deploymentFolder
DeploymentFolder

This field is optional.

": {
9
               "deploymentFolderId
DeploymentFolderId

Deployment folder identifier

Minimum value: 1

This field is optional.

": "{Integer}"
10
          }
11
     }
12
}

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.
$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
1

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