API

Finance APIs

GET finance/dimension-definitions/{dimensionDefinitionId}/custom-values/{customValueId}

Custom value details for a specific dimension definition

HTTP method GET
URI https://api.rambase.net/finance/dimension-definitions/{dimensionDefinitionId}/custom-values/{customValueId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {dimensionDefinitionId} Dimension identifier
Integer, minimum 1, maximum 10
- URI parameter {customValueId} Dimension value identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3414, 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
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.

$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$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.
$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.

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
<CustomValue>
2
     <CustomValueId
CustomValueId

Dimension value identifier

>{String}</CustomValueId>
3
     <Status
Status

Status of dimension value

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

Dimension value name

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

Dimension value description

>{String}</Description>
6
     <CreatedBy>
7
          <UserId
UserId

User identifier

>{Integer}</UserId>
8
          <Name
Name

Name of the user

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

>{String}</Name>
9
          <FirstName
FirstName

First name of the user

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

>{String}</FirstName>
10
          <UserLink
UserLink

User reference

>{String}</UserLink>
11
     </CreatedBy>
12
     <Validity>
13
          <EffectivePeriod
EffectivePeriod

Period the dimension value is effective/valid from

>{Integer}</EffectivePeriod>
14
          <ExpirationPeriod
ExpirationPeriod

Period the dimension value expires (is valid to)

>{Integer}</ExpirationPeriod>
15
     </Validity>
16
</CustomValue>
1
{
2
     "customValue": {
3
          "customValueId
CustomValueId

Dimension value identifier

": "{String}",
4
          "status
Status

Status of dimension value

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

Dimension value name

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

Dimension value description

": "{String}",
7
          "createdBy": {
8
               "userId
UserId

User identifier

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

Name of the user

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

": "{String}",
10
               "firstName
FirstName

First name of the user

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

": "{String}",
11
               "userLink
UserLink

User reference

": "{String}"
12
          },
13
          "validity": {
14
               "effectivePeriod
EffectivePeriod

Period the dimension value is effective/valid from

": "{Integer}",
15
               "expirationPeriod
ExpirationPeriod

Period the dimension value expires (is valid to)

": "{Integer}"
16
          }
17
     }
18
}

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 104192 HTTP 404 Custom value not found