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.
Returns all values for the specified set of Custom Fields.
This endpoint has its own rate limit. See the Knowledge Base for more information.
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.
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.
subject_type required | string You must specify which set of Custom Fields to return values for:
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
|
only | string Allows you to request one or more resources directly by ID. Multiple IDs can be supplied
in a comma separated list, like |
order | string Default: "created_at:asc" Supply Valid values: |
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. |
A list of Custom Field Values have been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}, - "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"
}
}, - "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
}
}, - "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",
- "manager_id": "string",
- "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",
- "manager_id": "string",
- "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"
}
}, - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "project_plan": true,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "project_plan": true,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "workspaces": {
- "property1": {
- "access_level": "string",
- "account_color_id": "string",
- "account_id": 0,
- "account_insights_mapping_ids": [
- "string"
], - "actual_fees_includes_additional_line_items": true,
- "actual_fees_includes_expenses": true,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_link": {
- "url": "string",
- "text": "string"
}, - "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "incoming_email_address": "string",
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_notes_on_time_entries": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "time_trackable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "access_level": "string",
- "account_color_id": "string",
- "account_id": 0,
- "account_insights_mapping_ids": [
- "string"
], - "actual_fees_includes_additional_line_items": true,
- "actual_fees_includes_expenses": true,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_link": {
- "url": "string",
- "text": "string"
}, - "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "incoming_email_address": "string",
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_notes_on_time_entries": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "time_trackable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "workspace_groups": {
- "property1": {
- "address": "string",
- "company": true,
- "contact_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "notes": "string",
- "phone_number": "string",
- "rate_card_set_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "website": "string",
- "workspace_ids": [
- "string"
]
}, - "property2": {
- "address": "string",
- "company": true,
- "contact_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "notes": "string",
- "phone_number": "string",
- "rate_card_set_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "website": "string",
- "workspace_ids": [
- "string"
]
}
}
}
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 has its own rate limit. See the Knowledge Base for more information.
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.
object | |||||||||||||||||||||||||||
|
Custom Field Value has been created.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "custom_field_value": {
- "subject_type": "string",
- "subject_id": 0,
- "custom_field_id": 0,
- "value": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}, - "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"
}
}, - "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
}
}, - "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",
- "manager_id": "string",
- "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",
- "manager_id": "string",
- "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"
}
}, - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "project_plan": true,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "project_plan": true,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "workspaces": {
- "property1": {
- "access_level": "string",
- "account_color_id": "string",
- "account_id": 0,
- "account_insights_mapping_ids": [
- "string"
], - "actual_fees_includes_additional_line_items": true,
- "actual_fees_includes_expenses": true,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_link": {
- "url": "string",
- "text": "string"
}, - "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "incoming_email_address": "string",
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_notes_on_time_entries": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "time_trackable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "access_level": "string",
- "account_color_id": "string",
- "account_id": 0,
- "account_insights_mapping_ids": [
- "string"
], - "actual_fees_includes_additional_line_items": true,
- "actual_fees_includes_expenses": true,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_link": {
- "url": "string",
- "text": "string"
}, - "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "incoming_email_address": "string",
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_notes_on_time_entries": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "time_trackable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "workspace_groups": {
- "property1": {
- "address": "string",
- "company": true,
- "contact_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "notes": "string",
- "phone_number": "string",
- "rate_card_set_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "website": "string",
- "workspace_ids": [
- "string"
]
}, - "property2": {
- "address": "string",
- "company": true,
- "contact_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "notes": "string",
- "phone_number": "string",
- "rate_card_set_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "website": "string",
- "workspace_ids": [
- "string"
]
}
}
}
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.
Custom Field Value has been deleted.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "errors": [
- {
- "type": "string",
- "message": "string"
}
]
}
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.
The Custom Field Value has been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}, - "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"
}
}, - "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
}
}, - "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",
- "manager_id": "string",
- "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",
- "manager_id": "string",
- "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"
}
}, - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "project_plan": true,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "project_plan": true,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "workspaces": {
- "property1": {
- "access_level": "string",
- "account_color_id": "string",
- "account_id": 0,
- "account_insights_mapping_ids": [
- "string"
], - "actual_fees_includes_additional_line_items": true,
- "actual_fees_includes_expenses": true,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_link": {
- "url": "string",
- "text": "string"
}, - "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "incoming_email_address": "string",
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_notes_on_time_entries": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "time_trackable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "access_level": "string",
- "account_color_id": "string",
- "account_id": 0,
- "account_insights_mapping_ids": [
- "string"
], - "actual_fees_includes_additional_line_items": true,
- "actual_fees_includes_expenses": true,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_link": {
- "url": "string",
- "text": "string"
}, - "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "incoming_email_address": "string",
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_notes_on_time_entries": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "time_trackable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "workspace_groups": {
- "property1": {
- "address": "string",
- "company": true,
- "contact_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "notes": "string",
- "phone_number": "string",
- "rate_card_set_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "website": "string",
- "workspace_ids": [
- "string"
]
}, - "property2": {
- "address": "string",
- "company": true,
- "contact_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "email": "string",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "notes": "string",
- "phone_number": "string",
- "rate_card_set_ids": [
- "string"
], - "updated_at": "2019-08-24T14:15:22Z",
- "website": "string",
- "workspace_ids": [
- "string"
]
}
}
}
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.
object | |||||||||||||||||||||
|
Custom Field Value has been updated.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "custom_field_value": {
- "value": "string"
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}, - "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"
}
}, - "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
}
}, - "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",
- "manager_id": "string",
- "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",
- "manager_id": "string",
- "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"
}
}, - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [