System APIs
Create a template for a custom field that the given extension requires to wrok. If the custom field does not exist previously it will be created when extension is activated.
| HTTP method | POST |
| URI | https://api.rambase.net/system/extensions/{extensionId}/required-custom-fields |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {extensionId} |
Extension identifier
Integer, minimum 100000, default 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 3969, version 4 |
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.
Object
Required/mandatory field
Object where the custom field is created
Applicable domain values can be found here
>{Integer}</Object>Name
Required/mandatory field
Name of custom field
>{String}</Name>Description
Description of custom field
This field is optional.
>{String}</Description>DataType
Required/mandatory field
Datatype of custom field
Applicable domain values can be found here
>{Integer}</DataType>ValueList
This field is optional.
>Object
Object/archive/context of the values
This field is optional.
>{String}</Object>Field
Fieldname of the DOV
This field is optional.
>{String}</Field>Object
Required/mandatory field
Object where the custom field is created
Applicable domain values can be found here
": "{Integer}",Name
Required/mandatory field
Name of custom field
": "{String}",Description
Description of custom field
This field is optional.
": "{String}",DataType
Required/mandatory field
Datatype of custom field
Applicable domain values can be found here
": "{Integer}",ValueList
This field is optional.
": {Object
Object/archive/context of the values
This field is optional.
": "{String}",Field
Fieldname of the DOV
This field is optional.
": "{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.
RequiredCustomFieldId
Identifier of custom field
>{Integer}</RequiredCustomFieldId>Status
Status of the required custom field
Possible domain values can be found here
>{Integer}</Status>Object
Object where the custom field is created
Possible domain values can be found here
>{Integer}</Object>Name
Name of custom field
>{String}</Name>Description
Description of custom field
>{String}</Description>DataType
Datatype of custom field
Possible domain values can be found here
>{Integer}</DataType>HasValueList
Is true if the custom field has assigned predefined domain values
>{Boolean}</HasValueList>Object
Object/archive/context of the values
>{String}</Object>Field
Fieldname of the DOV
>{String}</Field>Name
Type of object
>{String}</Name>ShowCustomField
True if custom field should show. Note that field still exists in database, but it is hidden.
>{Boolean}</ShowCustomField>RequiredCustomFieldId
Identifier of custom field
": "{Integer}",Status
Status of the required custom field
Possible domain values can be found here
": "{Integer}",Object
Object where the custom field is created
Possible domain values can be found here
": "{Integer}",Name
Name of custom field
": "{String}",Description
Description of custom field
": "{String}",DataType
Datatype of custom field
Possible domain values can be found here
": "{Integer}",HasValueList
Is true if the custom field has assigned predefined domain values
": "{Boolean}",Object
Object/archive/context of the values
": "{String}",Field
Fieldname of the DOV
": "{String}"Name
Type of object
": "{String}",ShowCustomField
True if custom field should show. Note that field still exists in database, but it is hidden.
": "{Boolean}"
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 104997 HTTP 400 | Archive field is mandatory |
| Error 105118 HTTP 400 | Select at least one object type |
| Error 104998 HTTP 400 | Datatype field is mandatory |
| Error 104999 HTTP 400 | Name field is mandatory |
| Error 105547 HTTP 400 | Illegal combination of object and field for domain value reference. |
| Error 103592 HTTP 400 | The domain value object reference contains illegal characters. Only a-z, A-Z and 0-9 can be used. |
| Error 103593 HTTP 400 | The domain value field reference contains illegal characters. Only a-z, A-Z and 0-9 can be used. |