The Custom Fields object allows you to view, create, update, and delete extra fields for additional Estimate, Project, Group, Resource, Task, and User information. If Custom Fields represent the fields themselves, Custom Field Values represent the values in/of those fields.
Returns all Custom Fields, unless filter parameters have been applied.
This endpoint returns structured Custom Field 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_fields
top-level JSON key.
Please see our Response Format section for more information.
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_fields": {
- "property1": {
- "choice_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "custom_field_set_id": "string",
- "default_text": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "read_access": 0,
- "unique_constraint": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "value_type": "string",
- "write_access": 0
}, - "property2": {
- "choice_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "custom_field_set_id": "string",
- "default_text": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "read_access": 0,
- "unique_constraint": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "value_type": "string",
- "write_access": 0
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "custom_field_choices": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "external_reference_ids": [
- "string"
], - "label": "string",
- "position": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "external_reference_ids": [
- "string"
], - "label": "string",
- "position": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "custom_field_sets": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
This endpoint returns structured Custom Field 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_fields
top-level JSON key.
Please see our Response Format section for more information.
object | |||||||||||||||||||||||||||||||||||
|
{- "custom_field": {
- "name": "string",
- "value_type": "string",
- "default_text": "string",
- "unique_constraint": true,
- "choices": [
- {
- "label": "string"
}
], - "custom_field_set_id": 0,
- "write_access": "string",
- "read_access": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_fields": {
- "property1": {
- "choice_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "custom_field_set_id": "string",
- "default_text": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "read_access": 0,
- "unique_constraint": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "value_type": "string",
- "write_access": 0
}, - "property2": {
- "choice_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "custom_field_set_id": "string",
- "default_text": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "read_access": 0,
- "unique_constraint": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "value_type": "string",
- "write_access": 0
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "custom_field_choices": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "external_reference_ids": [
- "string"
], - "label": "string",
- "position": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "external_reference_ids": [
- "string"
], - "label": "string",
- "position": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "custom_field_sets": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Updates an existing custom field. Note that the unique_constraint
and value_type
parameters cannot be updated.
They are set during the process of creating a custom field.
This endpoint also allows you to update the list of choices for a custom field with single or multiple choices.
Note: Kantata OX allows different choices to have the same label
.
When updating a field's choices, make sure to specify the ID
of each choice.
ID
of the existing choice.ID
of an existing choice, a new choice with a unique, new ID
is generated instead.For example:
custom_field_choices: {
....
choices: [
{ "label": "Choice A", "id": "180291" },
{ "label": "Choice B", "id": "180301" },
{ "label": "Choice C" }
]
....
}
The 1st choice is an existing choice with an ID of 180291
, and is either staying or being updated to Choice A
.
The 2nd choice is an existing choice with an ID of 180301
, and is either staying or being updated to Choice B
.
The 3rd choice is a brand new choice, Choice C
, and its unique ID will be returned in the response.
This endpoint returns structured Custom Field 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_fields
top-level JSON key.
Please see our Response Format section for more information.
object | |||||||||||||
|
{- "custom_field": {
- "name": "string",
- "default_text": "string",
- "choices": [
- {
- "label": "string",
- "id": 0
}
], - "custom_field_set_id": 0,
- "write_access": "string",
- "read_access": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_fields": {
- "property1": {
- "choice_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "custom_field_set_id": "string",
- "default_text": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "read_access": 0,
- "unique_constraint": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "value_type": "string",
- "write_access": 0
}, - "property2": {
- "choice_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "custom_field_set_id": "string",
- "default_text": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "read_access": 0,
- "unique_constraint": true,
- "updated_at": "2019-08-24T14:15:22Z",
- "value_type": "string",
- "write_access": 0
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "custom_field_choices": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "external_reference_ids": [
- "string"
], - "label": "string",
- "position": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "external_reference_ids": [
- "string"
], - "label": "string",
- "position": 0,
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "custom_field_sets": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_ids": [
- "string"
], - "external_reference_ids": [
- "string"
], - "name": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
Deletes a custom field. Custom field values are deleted with their custom fields.
The response will contain no content and an HTTP 204 status code if the request was successful, or a standard Kantata OX error message explaining why the object could not be deleted.
Custom Field has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}