API

System APIs

POST system/context-menu-collections

Creates a new context menu collection

HTTP method POST
URI https://api.rambase.net/system/context-menu-collections
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2178, version 3

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

Required/mandatory field

Name of the context menu collection.

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

Required/mandatory field

Namespace of the context menu collection

>{String}</Namespace>
4
     <Repository
Repository

This field is optional.

>
5
          <Scope
Scope

Scope of the context menu collection (local or global)

Applicable domain values can be found here

This field is optional.

>{String}</Scope>
6
     </Repository>
7
</ContextMenuCollection>
1
{
2
     "contextMenuCollection": {
3
          "name
Name

Required/mandatory field

Name of the context menu collection.

": "{String}",
4
          "namespace
Namespace

Required/mandatory field

Namespace of the context menu collection

": "{String}",
5
          "repository
Repository

This field is optional.

": {
6
               "scope
Scope

Scope of the context menu collection (local or global)

Applicable domain values can be found here

This field is optional.

": "{String}"
7
          }
8
     }
9
}

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
<ContextMenuCollection>
2
     <ContextMenuCollectionId
ContextMenuCollectionId

Context menu collection id. A unique Id representing a single context menu collection.

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

Status of context menu collection

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

Name of the context menu collection.

>{String}</Name>
5
     <Namespace
Namespace

Namespace of the context menu collection

>
6
          <Parameter>
7
               <ParameterId
ParameterId

A unique id for this specific parameter

>{Integer}</ParameterId>
8
               <Name
Name

The name of the paramter needed in this collection

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

The description of this parameter

>{String}</Description>
10
               <ParameterLink
ParameterLink

Reference to parameter of context menu collection

>{String}</ParameterLink>
11
          </Parameter>
12
          <IsChanged
IsChanged

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

>{Boolean}</IsChanged>
13
          <Scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

>{String}</Scope>
14
          <OverriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

>{String}</OverriddenStatus>
15
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
16
               <UserId
UserId

User identifier

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

User reference

>{String}</UserLink>
18
          </ChangedBy>
19
     </Namespace>
20
</ContextMenuCollection>
1
{
2
     "contextMenuCollection": {
3
          "contextMenuCollectionId
ContextMenuCollectionId

Context menu collection id. A unique Id representing a single context menu collection.

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

Status of context menu collection

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

Name of the context menu collection.

": "{String}",
6
          "namespace
Namespace

Namespace of the context menu collection

": {
7
               "parameter": {
8
                    "parameterId
ParameterId

A unique id for this specific parameter

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

The name of the paramter needed in this collection

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

The description of this parameter

": "{String}",
11
                    "parameterLink
ParameterLink

Reference to parameter of context menu collection

": "{String}"
12
               },
13
               "isChanged
IsChanged

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

": "{Boolean}",
14
               "scope
Scope

Scope of the DOV (LOCAL/GLOBAL)

": "{String}",
15
               "overriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

": "{String}",
16
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
17
                    "userId
UserId

User identifier

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

User reference

": "{String}"
19
               }
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 101853 HTTP 400 Context menu collection is in a status that does not allow update
Error 101854 HTTP 400 The combination of Name and Namespace must be unique