API

System APIs

PUT system/dictionary/custom-fields/{customFieldId}

Update custom field details for provided identifier.

HTTP method PUT
URI https://api.rambase.net/system/dictionary/custom-fields/{customFieldId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {customFieldId} Custom field identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 2927, version 5

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
<CustomField
CustomField

This field is optional.

>
2
     <Description
Description

Description of the custom field

Maximum value: 4500

This field is optional.

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

True if custom field has a valuelist. The domain values will be of object UDF, and field is the name of the custom field.

This field is optional.

>{Boolean}</HasValueList>
4
     <SortingPriority
SortingPriority

Priority to sort the field

Minimum value: 0

This field is optional.

>{Integer}</SortingPriority>
5
     <ObjectTypes
ObjectTypes

This field is optional.

>
6
          <ObjectType
ObjectType

This field is optional.

>
7
               <Name
Name

Type of object

This field is optional.

>{String}</Name>
8
               <ShowCustomField
ShowCustomField

True if custom field should show. Note that field still exists in database, but it is hidden.

This field is optional.

>{Boolean}</ShowCustomField>
9
          </ObjectType>
10
     </ObjectTypes>
11
     <Companies
Companies

This field is optional.

>
12
          <Company
Company

This field is optional.

>
13
               <Database
Database

Abbreviation/code to identify the company

This field is optional.

>{String}</Database>
14
               <ShowCustomField
ShowCustomField

True if custom field should show. Note that field still exists in database, but it is hidden.

This field is optional.

>{Boolean}</ShowCustomField>
15
          </Company>
16
     </Companies>
17
</CustomField>
1
{
2
     "customField
CustomField

This field is optional.

": {
3
          "description
Description

Description of the custom field

Maximum value: 4500

This field is optional.

": "{String}",
4
          "hasValueList
HasValueList

True if custom field has a valuelist. The domain values will be of object UDF, and field is the name of the custom field.

This field is optional.

": "{Boolean}",
5
          "sortingPriority
SortingPriority

Priority to sort the field

Minimum value: 0

This field is optional.

": "{Integer}",
6
          "objectTypes
ObjectTypes

This field is optional.

": [
7
               {
8
                    "name
Name

Type of object

This field is optional.

": "{String}",
9
                    "showCustomField
ShowCustomField

True if custom field should show. Note that field still exists in database, but it is hidden.

This field is optional.

": "{Boolean}"
10
               }
11
          ],
12
          "companies
Companies

This field is optional.

": [
13
               {
14
                    "database
Database

Abbreviation/code to identify the company

This field is optional.

": "{String}",
15
                    "showCustomField
ShowCustomField

True if custom field should show. Note that field still exists in database, but it is hidden.

This field is optional.

": "{Boolean}"
16
               }
17
          ]
18
     }
19
}

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: