API

System APIs

PUT system/extensions/{extensionId}/required-custom-fields/{requiredCustomFieldId}

Update custom field

HTTP method PUT
URI https://api.rambase.net/system/extensions/{extensionId}/required-custom-fields/{requiredCustomFieldId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {extensionId} Extension identifier
Integer, minimum 100000, default 100000
- URI parameter {requiredCustomFieldId} Identifier of custom field
Integer, minimum 0, default 0
Successful HTTP status code 200
API resource identifier 3971, 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.

Format:
1
<RequiredCustomField
RequiredCustomField

This field is optional.

>
2
     <Object
Object

Object where the custom field is created

Applicable domain values can be found here

This field is optional.

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

Name of custom field

This field is optional.

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

Description of custom field

This field is optional.

>{String}</Description>
5
     <DataType
DataType

Datatype of custom field

Applicable domain values can be found here

This field is optional.

>{Integer}</DataType>
6
     <ValueList
ValueList

This field is optional.

>
7
          <Object
Object

Object/archive/context of the values

This field is optional.

>{String}</Object>
8
          <Field
Field

Fieldname of the DOV

This field is optional.

>{String}</Field>
9
     </ValueList>
10
     <ObjectTypes
ObjectTypes

This field is optional.

>
11
          <ObjectType
ObjectType

This field is optional.

>
12
               <Name
Name

Type of object

This field is optional.

>{String}</Name>
13
               <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>
14
          </ObjectType>
15
     </ObjectTypes>
16
</RequiredCustomField>
1
{
2
     "requiredCustomField
RequiredCustomField

This field is optional.

": {
3
          "object
Object

Object where the custom field is created

Applicable domain values can be found here

This field is optional.

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

Name of custom field

This field is optional.

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

Description of custom field

This field is optional.

": "{String}",
6
          "dataType
DataType

Datatype of custom field

Applicable domain values can be found here

This field is optional.

": "{Integer}",
7
          "valueList
ValueList

This field is optional.

": {
8
               "object
Object

Object/archive/context of the values

This field is optional.

": "{String}",
9
               "field
Field

Fieldname of the DOV

This field is optional.

": "{String}"
10
          },
11
          "objectTypes
ObjectTypes

This field is optional.

": [
12
               {
13
                    "name
Name

Type of object

This field is optional.

": "{String}",
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}"
15
               }
16
          ]
17
     }
18
}

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:

Error 104997 HTTP 400 Archive field is mandatory
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.
Error 105118 HTTP 400 Select at least one object type