API

System APIs

POST system/context-menu-collections/{contextMenuCollectionId}/parameters

Add a parameter to the context menu collection

HTTP method POST
URI https://api.rambase.net/system/context-menu-collections/{contextMenuCollectionId}/parameters
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 201
API resource identifier 2179, version 1

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

Required/mandatory field

The name of the paramter needed in this collection

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

Required/mandatory field

The description of this parameter

>{String}</Description>
4
</Parameter>
1
{
2
     "parameter": {
3
          "name
Name

Required/mandatory field

The name of the paramter needed in this collection

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

Required/mandatory field

The description of this parameter

": "{String}"
5
     }
6
}

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
<Parameter>
2
     <ParameterId
ParameterId

A unique id for this specific parameter

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

The name of the paramter needed in this collection

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

The description of this parameter

>{String}</Description>
5
</Parameter>
1
{
2
     "parameter": {
3
          "parameterId
ParameterId

A unique id for this specific parameter

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

The name of the paramter needed in this collection

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

The description of this parameter

": "{String}"
6
     }
7
}

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 101852 HTTP 404 Context menu collection not found
Error 101856 HTTP 400 Parameter description is required
Error 101857 HTTP 400 Parameter name must be unique