Kantata Kantata OX Knowledge Base Release Notes Status Page
Kantata OX API Documentation

Custom Field Sets

Custom Field Sets contain custom fields and definitions of each fields' subject type. The supported subjects are currently Workspace, Story, User, and WorkspaceGroup.

Fetching a list of Custom Field Sets

This endpoint returns structured Custom Field Set 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_sets top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

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_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_fields (CustomField) - The custom fields that belonging to the custom field set.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
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:desc"

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

Valid values: alphabetical:asc, alphabetical:desc, created_at:asc, and created_at:desc.

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

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

with_subject_type
string

Set by a specific subject type: Workspace, Story, User or WorkspaceGroup.

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 Sets have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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_sets
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_sets": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    }
}
Creating a new Custom Field Set
To create a custom field, the current user must be the Account Administrator.


This endpoint returns structured Custom Field Set 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_sets 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_fields (CustomField) - The custom fields that belonging to the custom field set.
    • 

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 



 
Request Body schema: application/json
object
 
name
required
string
The name of the custom field set.


 
subject_type
required
string
The type of objects contained by the custom field set. The supported subjects
are currently Workspace, Story, User, and WorkspaceGroup.


 
Responses 
200
Custom Field Set has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
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_sets
Request samples 
application/json
{
  • "custom_field_set": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_sets": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    }
}
Fetching a single Custom Field Set
This endpoint returns structured Custom Field Set 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_sets 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_fields (CustomField) - The custom fields that belonging to the custom field set.
    • 

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 



 
Responses 
200
The Custom Field Set has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
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_sets/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_sets": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    }
}
Updating an existing Custom Field Set
To update a custom field, the current user must be the Account Administrator.


NOTE: subject_type cannot be changed.


This endpoint returns structured Custom Field Set 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_sets 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_fields (CustomField) - The custom fields that belonging to the custom field set.
    • 

  • external_references (ExternalReference) - Includes references to external integrations for this object.
    • 



 
Request Body schema: application/json
object
 
name
string
The name of the custom field set.


 
subject_type
string
Subject type cannot be changed.


 
Responses 
200
Custom Field Set has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
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_sets/{id}
Request samples 
application/json
{
  • "custom_field_set": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "custom_field_sets": {
    },
  • "external_references": {
    },
  • "custom_fields": {
    }
}
Deleting an existing Custom Field Set
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Custom Field Set 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_sets/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Custom Field Values