Skip to content

Creating a new Custom Field Set

Request

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.

Query
includestring

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.
Bodyapplication/jsonrequired
custom_field_setobject
{
  "custom_field_set": {
    "name": "string",
    "subject_type": "string"
  }
}

Responses

Custom Field Set has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
custom_field_setsobject
external_referencesobject
custom_fieldsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "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"
    }
  },
  "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
    }
  }
}