quick_code_values

create_quick_code_value

POST

/api/v2/quick_code_values/create_quick_code_value

Code
Create a new quick code value.

The quick code must exist and have codeAccessLevel of 'user' or 'extensible',
and codeType must be 'list'.

Args:
    quick_code_value: dict containing:
        - code_value_type (required): The unique identifier for this value
        - quick_code (required): The quick code this value belongs to
        - label (required): Display label for the value
        - description (optional): Description of the value
        - active (optional, default True): Whether the value is active
        - default (optional, default False): Whether this is the default value
        - sort_order (optional): Order for display

Returns:
    The created quick code value

create_quick_code_value › Request Body

Request payload for /api/v2/quick_code_values/create_quick_code_value.

request-create_quick_code_value

object · required

create_quick_code_value › Responses

200

Response payload for /api/v2/quick_code_values/create_quick_code_value.

response-create_quick_code_value

success

boolean · required

Whether the request was successful

object

The created quick code value

messages

object

Any messages or errors

POST/api/v2/quick_code_values/create_quick_code_value

curl --request POST \
  --url /api/v2/quick_code_values/create_quick_code_value \
  --header 'Content-Type: application/json' \
  --data '
{
  "quick_code_value": {
    "quick_code": "quick_code",
    "code_value_type": "code_value_type",
    "label": "label",
    "description": "description",
    "active": true,
    "default": false,
    "sort_order": 0
  }
}
'

Example Request Body

{
  "quick_code_value": {
    "quick_code": "quick_code",
    "code_value_type": "code_value_type",
    "label": "label",
    "description": "description",
    "active": true,
    "default": false,
    "sort_order": 0
  }
}

json

Example Responses

{
  "success": true,
  "data": {
    "quick_code": "quick_code",
    "code_value_type": "code_value_type",
    "label": "label",
    "description": "description",
    "active": true,
    "default": true,
    "is_system_default": true,
    "sort_order": 0,
    "added_by": "added_by",
    "date_added": "date_added",
    "updated_by": "updated_by",
    "date_updated": "date_updated"
  },
  "messages": {}
}

json

application/json

delete_quick_code_value

POST

/api/v2/quick_code_values/delete_quick_code_value

Code
Delete a user-created quick code value.

System default values cannot be deleted.
Values that are referenced by other tables cannot be deleted.

Args:
    code_value_type: The code value type to delete
    quick_code: The quick code the value belongs to

Returns:
    Success message

delete_quick_code_value › Request Body

Request payload for /api/v2/quick_code_values/delete_quick_code_value.

request-delete_quick_code_value

code_value_type

string · maxLength: 100 · required

The unique code value identifier to delete

quick_code

string · maxLength: 100 · required

The quick code identifier this value belongs to

delete_quick_code_value › Responses

200

Response payload for /api/v2/quick_code_values/delete_quick_code_value.

response-delete_quick_code_value

success

boolean · required

Whether the deletion was successful

object

Response data

messages

object

Any messages or errors

list_definition_overrides

POST

/api/v2/quick_code_values/list_definition_overrides

Schemas: api_specs/request-list_definition_overrides.json, api_specs/response-list_definition_overrides.json.

list_definition_overrides › Request Body

Request payload for /api/v2/quick_code_values/list_definition_overrides.

request-list_definition_overrides

quick_code

string · maxLength: 200 · required

The quick code whose policy type definition overrides are reported

code_value_type

string | null · maxLength: 200

Optional quick code value. When provided, definitions_for_value lists the definitions holding an override row for it; when omitted, that list is empty.

list_definition_overrides › Responses

200

Response payload for /api/v2/quick_code_values/list_definition_overrides.

response-list_definition_overrides

success

boolean · required

Whether the request was successful

object

Endpoint payload wrapped by the api_request response envelope

messages

array | object

Human messages on success (array) or errors (object)

list_quick_code_values

POST

/api/v2/quick_code_values/list_quick_code_values

Schemas: api_specs/request-list_quick_code_values.json, api_specs/response-list_quick_code_values.json.

list_quick_code_values › Request Body

Request payload for /api/v2/quick_code_values/list_quick_code_values.

request-list_quick_code_values

required

A single quick code or a list of quick codes to list values for. When definition_code is provided, exactly one quick code is required.

active_only

boolean

When true, only globally-active values are returned. Ignored when definition_code is provided: the definition decides for itself, and one with its own list keeps returning a value that has since been retired globally.

Default: false

definition_code

string | null · maxLength: 200

Optional policy type definition code. When provided, only the values enabled for that definition are returned; if the definition has no overrides, all globally-active values are returned. Requires exactly one quick code.

list_quick_code_values › Responses

200

Response payload for /api/v2/quick_code_values/list_quick_code_values.

response-list_quick_code_values

success

boolean · required

Whether the request was successful

object[]

The quick code values. In definition scope, only the values enabled for the definition are returned.

messages

array | object

Human messages on success (array) or errors (object)

POST/api/v2/quick_code_values/list_quick_code_values

curl --request POST \
  --url /api/v2/quick_code_values/list_quick_code_values \
  --header 'Content-Type: application/json' \
  --data '
{
  "quick_codes": "string",
  "active_only": false,
  "definition_code": "definition_code"
}
'

Example Request Body

{
  "quick_codes": "string",
  "active_only": false,
  "definition_code": "definition_code"
}

json

Example Responses

{
  "success": true,
  "data": [
    {
      "quick_code": "quick_code",
      "code_value_type": "code_value_type",
      "label": "label",
      "description": "description",
      "active": true,
      "default": true,
      "is_system_default": true,
      "sort_order": 0,
      "added_by": "added_by",
      "date_added": "date_added",
      "updated_by": "updated_by",
      "date_updated": "date_updated"
    }
  ],
  "messages": [
    "string"
  ]
}

json

application/json

save_definition_quick_code_value_toggle

POST

/api/v2/quick_code_values/save_definition_quick_code_value_toggle

Schemas: api_specs/request-save_definition_quick_code_value_toggle.json, api_specs/response-save_definition_quick_code_value_toggle.json.

save_definition_quick_code_value_toggle › Request Body

Request payload for /api/v2/quick_code_values/save_definition_quick_code_value_toggle.

request-save_definition_quick_code_value_toggle

definition_code

string · maxLength: 200 · required

Policy type definition code the toggle applies to

quick_code

string · maxLength: 100 · required

The quick code the value belongs to

code_value_type

string · maxLength: 100 · required

The code value type being enabled or disabled for the definition

enabled

boolean · required

True to enable the value for the definition, false to disable it

save_definition_quick_code_value_toggle › Responses

200

Response payload for /api/v2/quick_code_values/save_definition_quick_code_value_toggle.

response-save_definition_quick_code_value_toggle

success

boolean · required

Whether the toggle was saved successfully

object

Endpoint payload wrapped by the api_request response envelope

messages

array | object

Human messages on success (array) or errors (object)

save_remove_value_from_definitions_and_deactivate

POST

/api/v2/quick_code_values/save_remove_value_from_definitions_and_deactivate

Schemas: api_specs/request-save_remove_value_from_definitions_and_deactivate.json, api_specs/response-save_remove_value_from_definitions_and_deactivate.json.

save_remove_value_from_definitions_and_deactivate › Request Body

Request payload for /api/v2/quick_code_values/save_remove_value_from_definitions_and_deactivate.

request-save_remove_value_from_definitions_and_deactivate

quick_code

string · maxLength: 100 · required

The quick code the value belongs to

code_value_type

string · maxLength: 100 · required

The code value type to strip from every policy type definition and then deactivate globally

save_remove_value_from_definitions_and_deactivate › Responses

200

Response payload for /api/v2/quick_code_values/save_remove_value_from_definitions_and_deactivate.

response-save_remove_value_from_definitions_and_deactivate

success

boolean · required

Whether the bulk removal and deactivation succeeded

object

Endpoint payload wrapped by the api_request response envelope

messages

array | object

Human messages on success (array) or errors (object)

save_reset_definition_quick_code_values

POST

/api/v2/quick_code_values/save_reset_definition_quick_code_values

Schemas: api_specs/request-save_reset_definition_quick_code_values.json, api_specs/response-save_reset_definition_quick_code_values.json.

save_reset_definition_quick_code_values › Request Body

Request payload for /api/v2/quick_code_values/save_reset_definition_quick_code_values.

request-save_reset_definition_quick_code_values

definition_code

string · maxLength: 200 · required

Policy type definition code whose overrides are cleared so it inherits the global values again

quick_code

string · maxLength: 100 · required

The quick code the reset is scoped to; other quick codes on the same definition are untouched

save_reset_definition_quick_code_values › Responses

200

Response payload for /api/v2/quick_code_values/save_reset_definition_quick_code_values.

response-save_reset_definition_quick_code_values

success

boolean · required

Whether the reset succeeded

object

Endpoint payload wrapped by the api_request response envelope

messages

array | object

Human messages on success (array) or errors (object)

update_quick_code_value

POST

/api/v2/quick_code_values/update_quick_code_value

update_quick_code_value

update_quick_code_value › Request Body

update_quick_code_value › Responses

200

success

boolean

message

string[]

data

object

prior_policies quick_codes