Kantata Kantata OX Knowledge Base
Release Notes
Status Page

Custom Field Values

If Custom Fields represent the fields themselves, Custom Field Values represent the values in/of those fields. The Custom Field Values object allows you to view, create, update, and delete these values.

Fetching a list of Custom Field Values

Returns all values for the specified set of Custom Fields. Custom fields are organized into sets, by the objects they store additional information for (Estimate, Project, Group, Resource, Task, or User). Use the subject_type parameter to specify which set of Custom Fields to return values for:

  • Estimate
  • Story (Task)
  • User
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource

Custom field values for archived Projects and Tasks are included in returned values. Values are sorted from less to more recently updated.

Note:

The read_access permission setting on each custom field determines the minimum permission needed to view a custom field and its value.

  • Workspace (Project), Resource, and Story (Task) custom fields are project-specific objects, so their minimum permissions are set at the project level:
    • project_collaboration (default)
    • time_logging
    • financial
    • project_admin

Most account-level permissions supercede project-level permissions. Therefore, Account Administrators are able to view all Project, Resource, and Task custom fields and values across the account, regardless of project participation or read_access settings.

  • Estimate, WorkspaceGroup (Group), and User custom fields are account-wide objects, so their minimum permissions are set at the account level:
    • account_collaboration
    • project_creator
    • project_lead
    • reports_viewer
    • reports_viewer_with_cost
    • account_admin (default)

This endpoint returns structured Custom Field Value objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_field_values top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
subject_type
required
string

You must specify which set of Custom Fields to return values for:

  • Estimate
  • Story (Task)
  • User
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource

This parameter is required.

created_after
string <date-time>

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_before
string <date-time>

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refs
string

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

has_external_references
boolean

Filter by whether or not the object has external references.

include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • custom_field (CustomField) - Retrieves the custom field the value is for. The response will include custom_field_id, which references the data in the custom_fields top-level key.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • selected_choices (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include selected_choice_ids, which references the data in the custom_field_choices top-level key.
  • setter (User) - Retrieves the user that set the custom field value. The response will include setter_id, which references the data in the users top-level key.
  • subject (polymorphic) - Retrieves the object which the custom field value is for. The response will include subject_ref, which references the data in the top-level key specified in the key field of subject_ref. The possible objects are as follows:
  • Estimate
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource
  • Story (Task)
  • User.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

order
string
Default: "created_at:asc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, subject_id:asc, subject_id:desc, updated_at:asc, and updated_at:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
updated_after
string <date-time>

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_before
string <date-time>

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

with_custom_field_id
string

Filters for values of the Custom Field(s) with the specified ID(s). Give multiple Custom Field IDs in a comma-separated list.

with_setter_id
string

Filters for Custom Field Values set by a user with the specified ID(s). Give multiple user IDs in a comma-separated list.

with_subject_id
string

Filters for Custom Field Values associated with the specified ID(s) of an Estimate, Project, Group, Resource, Task, or User. Give multiple IDs in a comma-separated list.

without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

Responses
200

A list of Custom Field Values have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/custom_field_values
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_values": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    },
  • "users": {
    },
  • "custom_field_choices": {
    },
  • "stories": {
    },
  • "workspaces": {
    },
  • "workspace_groups": {
    }
}

Creating a new Custom Field Value

Creates a new value for the specified custom field. Creating a value can also override existing values, effectively making this an update request as well. Up to 100 values can be created at one time.

When creating new single or multi choice values that override existing values, note that new values are not added to existing values, but instead replace existing values. Additionally, every new value has a unique, new ID.

This endpoint returns structured Custom Field Value objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_field_values top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • custom_field (CustomField) - Retrieves the custom field the value is for. The response will include custom_field_id, which references the data in the custom_fields top-level key.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • selected_choices (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include selected_choice_ids, which references the data in the custom_field_choices top-level key.
  • setter (User) - Retrieves the user that set the custom field value. The response will include setter_id, which references the data in the users top-level key.
  • subject (polymorphic) - Retrieves the object which the custom field value is for. The response will include subject_ref, which references the data in the top-level key specified in the key field of subject_ref. The possible objects are as follows:
  • Estimate
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource
  • Story (Task)
  • User.
Request Body schema: application/json
required
object
subject_type
required
string

You must specify which set of Custom Fields to return values for:

  • Estimate
  • Story (Task)
  • User
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource

This parameter is required.

subject_id
required
integer <int32>

The ID of the Estimate, Project, Group, Resource, Task, or User the custom field is for.

custom_field_id
required
integer <int32>

The ID of the Custom Field to create or update the value for.

value
required
string

The value to create or update to for the specified custom field.

Values can be created or updated in these formats:

Value Type Format Sample
string <text_string> "foo"
date <ISO_8601 Date Format> "2014-02-25"
number <integer_value> 13
currency [<int_value_in_cents>, <currency_code>] [998, "USD"]
single and multi [<choice_ids>] [1, 2, 4]
Note:

The write_access permission setting on each custom field determines the minimum permission needed to edit the value of each custom field.

  • Editing Workspace (Project), Resource, and Story (Task) custom fields are project-specific changes, so permissions are set at the project level:
  • project_collaboration
  • time_logging
  • financial
  • project_admin (default)

Most account-level permissions supercede project-level permissions. Therefore, Account Administrators are able to edit all Project, Resource, and Task custom fields and values across the account, regardless of project participation or write_access settings.

  • Editing Estimate, WorkspaceGroup (Group), and User custom fields are account-wide changes, so permissions are set at the account level:
  • account_collaboration
  • project_creator
  • project_lead
  • reports_viewer
  • reports_viewer_with_cost
  • account_admin (default).
Responses
200

Custom Field Value has been created.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

post/custom_field_values
Request samples
application/json
{
  • "custom_field_value": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_values": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    },
  • "users": {
    },
  • "custom_field_choices": {
    },
  • "stories": {
    },
  • "workspaces": {
    },
  • "workspace_groups": {
    }
}

Delete multiple custom field values

The IDs of the custom field values to delete can be provided in the ids query parameter or via the request body.

Request body example:

{ "ids": "1,2,3" }

If any specified custom field values cannot be deleted, the entire request will fail and an error message will be returned that specifies which ones could not be deleted and why.

This endpoint returns structured Custom Field Value objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_field_values top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
ids
string

A comma-separated list of IDs of custom field values. You can provide up to 100 IDs. The IDs can be provided in this query parameter or via the request body.

Responses
204

Custom Field Value has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

delete/custom_field_values
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}

Fetching a single Custom Field Value

This endpoint returns structured Custom Field Value objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_field_values top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • custom_field (CustomField) - Retrieves the custom field the value is for. The response will include custom_field_id, which references the data in the custom_fields top-level key.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • selected_choices (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include selected_choice_ids, which references the data in the custom_field_choices top-level key.
  • setter (User) - Retrieves the user that set the custom field value. The response will include setter_id, which references the data in the users top-level key.
  • subject (polymorphic) - Retrieves the object which the custom field value is for. The response will include subject_ref, which references the data in the top-level key specified in the key field of subject_ref. The possible objects are as follows:
  • Estimate
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource
  • Story (Task)
  • User.
Responses
200

The Custom Field Value has been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/custom_field_values/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_values": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    },
  • "users": {
    },
  • "custom_field_choices": {
    },
  • "stories": {
    },
  • "workspaces": {
    },
  • "workspace_groups": {
    }
}

Updating an existing Custom Field Value

Updates an existing value for the specified custom field. Up to 100 values can be updated at one time.

This endpoint returns structured Custom Field Value objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the custom_field_values top-level JSON key. Please see our Response Format section for more information.

Request
path Parameters
id
required
integer

The ID of the Model.

query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • custom_field (CustomField) - Retrieves the custom field the value is for. The response will include custom_field_id, which references the data in the custom_fields top-level key.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • selected_choices (CustomFieldChoice) - Retrieves the custom field choice that corresponds to the custom field value. The response will include selected_choice_ids, which references the data in the custom_field_choices top-level key.
  • setter (User) - Retrieves the user that set the custom field value. The response will include setter_id, which references the data in the users top-level key.
  • subject (polymorphic) - Retrieves the object which the custom field value is for. The response will include subject_ref, which references the data in the top-level key specified in the key field of subject_ref. The possible objects are as follows:
  • Estimate
  • Workspace (Project)
  • WorkspaceGroup (Group)
  • Resource
  • Story (Task)
  • User.
Request Body schema: application/json
required
object
value
required
string

The new value that replaces the existing value for the specified custom field.

These value types are updated in the following formats:

Value Type Format Sample
string <text_string> "foo"
date <ISO_8601 Date Format> "2014-02-25"
number <integer_value> 13
currency [<int_value_in_cents>, <currency_code>] [998, "USD"]
single and multi [<choice_ids>] [1, 2, 4]

For single or multi choice Custom Fields, you can think of selected choice(s) as a list, even with only 1 selected choice. The list of values in your request becomes the new list of selected choices. And the new choices all have new, unique choice IDs.

Note:

The write_access permission setting on each custom field determines the minimum permission needed to edit the value of each custom field.

  • Editing Workspace (Project), Resource, and Story (Task) custom fields are project-specific changes, so permissions are set at the project level:
  • project_collaboration
  • time_logging
  • financial
  • project_admin (default)

Most account-level permissions supercede project-level permissions. Therefore, Account Administrators are able to edit all Project, Resource, and Task custom fields and values across the account, regardless of project participation or write_access settings.

  • Editing Estimate, WorkspaceGroup (Group), and User custom fields are account-wide changes, so permissions are set at the account level:
  • account_collaboration
  • project_creator
  • project_lead
  • reports_viewer
  • reports_viewer_with_cost
  • account_admin (default).
Responses
200

Custom Field Value has been updated.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
object
object
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/custom_field_values/{id}
Request samples
application/json
{
  • "custom_field_value": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_values": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    },
  • "users": {
    },
  • "custom_field_choices": {
    },
  • "stories": {