API

System APIs

POST system/extensions/{extensionId}/required-objects

Adds an object to extension

HTTP method POST
URI https://api.rambase.net/system/extensions/{extensionId}/required-objects
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {extensionId} Extension identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 5925, 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
<RequiredObject>
2
     <Object>
3
          <ObjectType
ObjectType

Required/mandatory field

Type of object

Applicable domain values can be found here

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

Required/mandatory field

Identifier of the object

Minimum value: 1

>{Integer}</ObjectId>
5
     </Object>
6
</RequiredObject>
1
{
2
     "requiredObject": {
3
          "object": {
4
               "objectType
ObjectType

Required/mandatory field

Type of object

Applicable domain values can be found here

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

Required/mandatory field

Identifier of the object

Minimum value: 1

": "{Integer}"
6
          }
7
     }
8
}

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
<RequiredObject>
2
     <RequiredObjectId
RequiredObjectId

Required object identifier

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

Status of the required object

Possible domain values can be found here

>{Integer}</Status>
4
     <Object>
5
          <ObjectType
ObjectType

Type of object

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

Identifier of the object

>{String}</ObjectId>
7
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>
8
               <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

>{String}</Scope>
9
               <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
10
               <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
11
                    <UserId
UserId

User identifier

>{Integer}</UserId>
12
                    <Name
Name

Name of the user

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

First name of the user

>{String}</FirstName>
14
                    <UserLink
UserLink

User reference

>{String}</UserLink>
15
               </ChangedBy>
16
               <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
17
          </RamBaseKey>
18
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
19
     </Object>
20
</RequiredObject>
1
{
2
     "requiredObject": {
3
          "requiredObjectId
RequiredObjectId

Required object identifier

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

Status of the required object

Possible domain values can be found here

": "{Integer}",
5
          "object": {
6
               "objectType
ObjectType

Type of object

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

Identifier of the object

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

Internal RamBase identifier of the object/item

": {
9
                    "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

": "{String}",
10
                    "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
11
                    "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
12
                         "userId
UserId

User identifier

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

Name of the user

": "{String}",
14
                         "firstName
FirstName

First name of the user

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

User reference

": "{String}"
16
                    },
17
                    "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
18
               },
19
               "objectLink
ObjectLink

API reference to the object

": "{String}"
20
          }
21
     }
22
}

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 100138 HTTP 400 Only the operators NE and EQ can be used on Values containing a comma list or wildcards ( ?, * )
Error 102063 HTTP 400 Wildcard compare does not support both ? and *
Error 102064 HTTP 400 Wildcard compare does not support more than two asterisks (*)
Error 107656 HTTP 400 Application must have status 4 when adding to extension
Error 108292 HTTP 400 Only objects in status 4 or 8 can be added to extension