API

System APIs

PUT system/context-menu-collections/{contextMenuCollectionId}

Update context menu collection details for provided identifier

HTTP method PUT
URI https://api.rambase.net/system/context-menu-collections/{contextMenuCollectionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {contextMenuCollectionId} Context menu collection id. A unique Id representing a single context menu collection.
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2182, 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
<ContextMenuCollection
ContextMenuCollection

This field is optional.

>
2
     <Name
Name

Name of the context menu collection.

This field is optional.

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

Namespace of the context menu collection

This field is optional.

>{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
ContextMenuCollection

This field is optional.

": {
3
          "name
Name

Name of the context menu collection.

This field is optional.

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

Namespace of the context menu collection

This field is optional.

": "{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.

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. Fields colored in grey is expandable 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 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