API

System APIs

POST system/output-theme

Used to create a new company theme link in RamBase

HTTP method POST
URI https://api.rambase.net/system/output-theme
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 3152, 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
<OutputTheme>
2
     <Name
Name

Required/mandatory field

Name of the company theme

>{String}</Name>
3
</OutputTheme>
1
{
2
     "outputTheme": {
3
          "name
Name

Required/mandatory field

Name of the company theme

": "{String}"
4
     }
5
}

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
<OutputTheme>
2
     <OutputThemeId
OutputThemeId

Output theme identifier

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

Name of the company theme

>{String}</Name>
4
</OutputTheme>
1
{
2
     "outputTheme": {
3
          "outputThemeId
OutputThemeId

Output theme identifier

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

Name of the company theme

": "{String}"
5
     }
6
}

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 100027 HTTP 400 Missing mandatory parameter {0}
Error 105991 HTTP 400 Event is not of the same type as event set on the automated flow
Error 100012 HTTP 400 {0} must exist in {1}
Error 100065 HTTP 400 Can not change Scope from Global to Local
Error 100060 HTTP 400 The combination of OBJECT, FIELD and VALUE already exists