# Get options for a custom field.

Endpoint: POST /v3/companies/{companyId}/custom-fields/{customFieldId}/arms/{armId}/option-list
Version: v3
Security: Bearer

## Security:

  - `Bearer` (unknown)
    http bearer

## Path parameters:

  - `companyId` (string, required)
    Identifier for company.

  - `customFieldId` (string, required)
    Identifier for custom field.

  - `armId` (string, required)
    Identifier for arm.

## Request fields (application/json):

  - `paginationParams` (object, required)
    Pagination parameters for requests.

  - `paginationParams.offset` (integer)
    The starting index in the list from which results are returned. The value must be greater than or equal to 0.

  - `paginationParams.limit` (integer)
    Maximum number of results to be fetched.

  - `nameSearchText` (string)
    Only the option that contain the specified text in name will be returned.

  - `fetchEffectiveAdditionalInfos` (boolean, required)
    Indicates whether the additional infos should be fetched for each option
from arm level if individual option does not have definition of additional infos.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `paginationParams` (object, required)
    Pagination parameters for response.

  - `paginationParams.totalNumResults` (integer, required)
    Total number of results.

  - `options` (array)

  - `options.name` (string, required)
    Unique name of the option
    Example: XC

  - `options.description` (string)
    User understandable details for the given name
    Example: Air exchange code

  - `options.additionalInfos` (array)
    Option level additional infos.

  - `options.additionalInfos.type` (string, required)
    Enum: "VARIABLE", "EXPRESSION"

  - `options.additionalInfos.name` (string, required)
    Name of the variable.
    Enum: "PUBLISHED_FARE", "LLF", "ADD_COLLECT_AMOUNT", "SELECTED_FARE", "SPLIT_PAYMENT_FARE"

  - `options.additionalInfos.formatExpression` (string, required)
    The expression must be of format : `<any_text> ${expression} <any_text>`.The expression
can consist of a combination of variables and mathematical operations.
Variable names must be same as VariableName Enum.
To define mathematical operations, the operation name should follow the format
`math.<math_op>(arg1, arg2)`. Both `arg1` and `arg2` can be variables or constants.
The supported math operations (math_op) include: `add, mul, div, sub, min, and max`. All keywords, such as `<math_op>, math, and var` must be written in lowercase.
    Example: Result:  ${math.mul(LLF,5)}  ${ADD_COLLECT_AMOUNT}

  - `options.additionalInfos.variables` (array)
    Reference names of the variables present in the expression.

  - `options.translatedName` (string)
    Translated name of the option, matching the users preferred language
    Example: XC

  - `options.translatedDescription` (string)
    Translated description of the option, matching the users preferred language
    Example: Código de intercambio de aire

  - `options.optionId` (string)
    Server-assigned id of the option. Absent while the option has no id. On update it may be omitted, and a sent value is ignored (options are matched by name), but it must be a UUID.
    Example: 1b0f6c1e-3c2a-4d8e-9f10-2a3b4c5d6e7f

  - `options.outcomes` (object)
    What selecting the option does. Returned only to users who can edit the custom fields of the company that owns the options (for an inherited field, the parent company). On update, omit it to keep the stored outcomes, or send an empty object to clear them.

  - `options.outcomes.policyAssignment` (object)
    Assigns a travel policy to the traveler who selects the option.

  - `options.outcomes.policyAssignment.policyId` (string, required)
    Id of an active policy of the company that owns the options.
    Example: 8774a66b-7493-4f41-908c-58ba81093947

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 401 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

## Response 404:

  - `404` (unknown)
    The specified resource was not found.

## Response 404 fields (application/json):

  - `debugIdentifier` (string)
    Link to debug the error internally.

  - `errorMessages` (array)

  - `errorMessages.errorCode` (string)
    Error code to identify the specific errors.

  - `errorMessages.message` (string)
    Message containing details of error.

  - `errorMessages.errorParameters` (array)
    Error message parameters.

  - `errorMessages.errorParameters.name` (string)
    Parameter name

  - `errorMessages.errorParameters.value` (string)
    Parameter value

  - `errorMessages.errorDetail` (string)
    More details about the error.

