API

System APIs

GET system/dictionary/custom-fields

List of all custom fields for current system

HTTP method GET
URI https://api.rambase.net/system/dictionary/custom-fields
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2916, version 6

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
1

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.

$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]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

CustomFieldId Integer Custom field identifier.
DataType Integer Datatype to use for this custom field.
Description String Description of the custom field.
Name String Name of the custom field.
Object Integer Object this custom field is belonging to.
SortingPriority Integer Priority to sort the field.
Status Integer Status of the custom field. 4 is active. 9 is deactivated.

Read more about filters and sorting on how to use sortable parameters

CustomFieldId Integer Custom field identifier
DataType Integer Datatype to use for this custom field
Description String Description of the custom field
Name String Name of the custom field
Object Integer Object this custom field is belonging to
SortingPriority Integer Priority to sort the field
Status Integer Status of the custom field. 4 is active. 9 is deactivated.

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
<CustomFields>
2
     <CustomField>
3
          <CustomFieldId
CustomFieldId

Custom field identifier

>{Integer}</CustomFieldId>
4
          <Status
Status

Status of the custom field. 4 is active. 9 is deactivated.

Possible domain values can be found here

>{Integer}</Status>
5
          <Name
Name

Name of the custom field

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

Description of the custom field

>{String}</Description>
7
          <Object
Object

Object this custom field is belonging to

Possible domain values can be found here

>{Integer}</Object>
8
          <DataType
DataType

Datatype to use for this custom field

Possible domain values can be found here

>{Integer}</DataType>
9
          <SortingPriority
SortingPriority

Priority to sort the field

>{Integer}</SortingPriority>
10
          <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.

>{Boolean}</HasValueList>
11
          <ValueList>
12
               <Object
Object

Object/archive/context of the values

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

Fieldname of the DOV

>{String}</Field>
14
          </ValueList>
15
          <Publisher>
16
               <PublisherId
PublisherId

Publisher identifier

>{Integer}</PublisherId>
17
               <Name
Name

Publisher name

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

Publisher description

>{String}</Description>
19
               <Prefix
Prefix

Unique prefix used for extension objects created by the publisher, e.g. custom fields.

>{String}</Prefix>
20
               <PublisherLink
PublisherLink

Publisher reference

>{String}</PublisherLink>
21
          </Publisher>
22
          <CustomFieldLink
CustomFieldLink

Custom field reference

>{String}</CustomFieldLink>
23
     </CustomField>
24
     <Paging
Paging

Detailed paging information for this list.

>
25
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
26
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
27
          <Page
Page

Page index

>{Integer}</Page>
28
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
29
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
30
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
31
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
32
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
33
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
34
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
35
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
36
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
37
     </Paging>
38
</CustomFields>
1
{
2
     "customFields": [
3
          {
4
               "customFieldId
CustomFieldId

Custom field identifier

": "{Integer}",
5
               "status
Status

Status of the custom field. 4 is active. 9 is deactivated.

Possible domain values can be found here

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

Name of the custom field

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

Description of the custom field

": "{String}",
8
               "object
Object

Object this custom field is belonging to

Possible domain values can be found here

": "{Integer}",
9
               "dataType
DataType

Datatype to use for this custom field

Possible domain values can be found here

": "{Integer}",
10
               "sortingPriority
SortingPriority

Priority to sort the field

": "{Integer}",
11
               "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.

": "{Boolean}",
12
               "valueList": {
13
                    "object
Object

Object/archive/context of the values

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

Fieldname of the DOV

": "{String}"
15
               },
16
               "publisher": {
17
                    "publisherId
PublisherId

Publisher identifier

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

Publisher name

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

Publisher description

": "{String}",
20
                    "prefix
Prefix

Unique prefix used for extension objects created by the publisher, e.g. custom fields.

": "{String}",
21
                    "publisherLink
PublisherLink

Publisher reference

": "{String}"
22
               },
23
               "customFieldLink
CustomFieldLink

Custom field reference

": "{String}"
24
          }
25
     ],
26
     "paging
Paging

Detailed paging information for this list.

": {
27
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
28
          "position
Position

Position of the first element in the list

": "{Integer}",
29
          "page
Page

Page index

": "{Integer}",
30
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
31
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
32
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
33
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
34
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
35
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
36
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
37
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
38
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
39
     }
40
}

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: