ReportCustomFieldSearchSettingsResponse

The response body for the POST /api/v1/reports/get_custom_field_search_settings endpoint.

This is a list of select-type (ENUM) Custom Fields that can be used in the report search filter.

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

statusstring[]

An array of status (confirmation) messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a green icon.

errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

results object[]

Array [

valuestring

The internal ID of the Custom Field.

Example: users_dept

textstring

The display name (pname) of the Custom Field.

Example: Department

items object[]

The list of options for the Custom Field. This list will only be populated for ENUM type Custom Fields.

Array [

textstring

The display name of the Custom Field option.

Example: Sales

valuestring

The internal ID of the Custom Field option.

Example: 12345

]

]

ReportCustomFieldSearchSettingsResponse

{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "results": [
    {
      "value": "users_dept",
      "text": "Department",
      "items": [
        {
          "text": "Sales",
          "value": 12345
        }
      ]
    }
  ]
}