Base APIs
Creates a new color
| HTTP method | POST |
| URI | https://api.rambase.net/base/colors |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 6575, 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.
Title
Title of the color
This field is optional.
>{String}</Title>HexColor
Required/mandatory field
Hex color id. Ex. #112233
>{String}</HexColor>ColorScheme
Required/mandatory field
ColorScheme that is either Document, Media or Diagram
Applicable domain values can be found here
>{String}</ColorScheme>Title
Title of the color
This field is optional.
": "{String}",HexColor
Required/mandatory field
Hex color id. Ex. #112233
": "{String}",ColorScheme
Required/mandatory field
ColorScheme that is either Document, Media or Diagram
Applicable domain values can be found here
": "{String}"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.
ColorId
Color identifier
>{Integer}</ColorId>Title
Title of the color
>{String}</Title>HexColor
Hex color id. Ex. #112233
>{String}</HexColor>ColorScheme
ColorScheme that is either Document, Media or Diagram
Possible domain values can be found here
>{String}</ColorScheme>ColorId
Color identifier
": "{Integer}",Status
Color status
Possible domain values can be found here
": "{Integer}",Title
Title of the color
": "{String}",HexColor
Hex color id. Ex. #112233
": "{String}",ColorScheme
ColorScheme that is either Document, Media or Diagram
Possible domain values can be found here
": "{String}"
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 101079 HTTP 400 | Mismatch in size of revision parameters |
| Error 101551 HTTP 404 | Object {0} not found |
| Error 109175 HTTP 400 | You have not selected a valid colorscheme |