KAkantata
Custom Field Values

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.

get/custom_field_values/{id}

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Path parameters

idinteger required

The ID of the Model.

Query parameters

includestring

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.

Response

The Custom Field Value has been retrieved.

countinteger
custom_field_valuesobject
external_referencesobject
custom_fieldsobject
usersobject
custom_field_choicesobject
storiesobject
workspacesobject
workspace_groupsobject

Changes

No recorded changes to this operation across all 1 revision of this API.