Fields

Basic Template operations

---

Field CRUD Operations

get

/prod/v0/fields/

Authorizations

Query parameters

namestring

typestring · enum

• str - String
• int - Integer
• flt - Float
• bln - Boolean
• rel - Relationship
• enm - Enum

Options: bln, enm, flt, int, rel, str

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/prod/v0/fields/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

[
  {
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  }
]

post

/prod/v0/fields/

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idinteger

namestring · max: 255required

descriptionstring · max: 255required

typestring · max: 3required

rel_template_idinteger | nullable

rel_templateintegerread-onlyrequired

enum_valuesstring[]

enum_manyboolean

sourcesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/prod/v0/fields/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  }'

201

201

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "text",
  "rel_template_id": 1,
  "rel_template": 1,
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "sources": [
    "text"
  ]
}

get

/prod/v0/fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this field.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/prod/v0/fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "text",
  "rel_template_id": 1,
  "rel_template": 1,
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "sources": [
    "text"
  ]
}

put

/prod/v0/fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this field.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idinteger

namestring · max: 255required

descriptionstring · max: 255required

typestring · max: 3required

rel_template_idinteger | nullable

rel_templateintegerread-onlyrequired

enum_valuesstring[]

enum_manyboolean

sourcesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/prod/v0/fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  }'

200

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "text",
  "rel_template_id": 1,
  "rel_template": 1,
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "sources": [
    "text"
  ]
}

patch

/prod/v0/fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this field.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idinteger

namestring · max: 255

descriptionstring · max: 255

typestring · max: 3

rel_template_idinteger | nullable

rel_templateintegerread-only

enum_valuesstring[]

enum_manyboolean

sourcesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/prod/v0/fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  }'

200

200

{
  "id": 1,
  "name": "text",
  "description": "text",
  "type": "text",
  "rel_template_id": 1,
  "rel_template": 1,
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "sources": [
    "text"
  ]
}

delete

/prod/v0/fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this field.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/prod/v0/fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No response body

Attach a field to a Template

post

/prod/v0/fields/{field_id}/template/

Authorizations

Path parameters

field_idstringrequired

Pattern: ^\d+$

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

template_idintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/prod/v0/fields/{field_id}/template/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "template_id": 1
  }'

201

201

{
  "template_id": 1
}

Created Field Operations

get

/prod/v0/created-fields/

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/prod/v0/created-fields/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

[
  {
    "id": 1,
    "name": "text",
    "specification": "text",
    "source_entity_type": "text",
    "description": "text",
    "type": "text",
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "rel_template": {
      "id": 1,
      "name": "text",
      "description": "text",
      "fields": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template_id": 1,
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        }
      ],
      "questions": [
        "text"
      ]
    },
    "field": {
      "id": 1,
      "name": "text",
      "description": "text",
      "type": "text",
      "rel_template_id": 1,
      "rel_template": 1,
      "enum_values": [
        "text"
      ],
      "enum_many": true,
      "sources": [
        "text"
      ]
    },
    "status": "text",
    "value": null,
    "sources": [
      "text"
    ]
  }
]

post

/prod/v0/created-fields/

Authorizations

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerread-onlyrequired

namestring · max: 255required

specificationstring · max: 255required

source_entity_typestring | nullable

descriptionstring · max: 255required

typestring · max: 3required

enum_valuesstring[]

enum_manyboolean

rel_templateall of

fieldall ofread-onlyrequired

statusstring · max: 1read-onlyrequired

valueanyread-onlyrequired

sourcesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/prod/v0/created-fields/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "name": "text",
    "specification": "text",
    "source_entity_type": "text",
    "description": "text",
    "type": "text",
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "rel_template": {
      "id": 1,
      "name": "text",
      "description": "text",
      "fields": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template_id": 1,
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        }
      ],
      "questions": [
        "text"
      ]
    },
    "field": {
      "id": 1,
      "name": "text",
      "description": "text",
      "type": "text",
      "rel_template_id": 1,
      "rel_template": 1,
      "enum_values": [
        "text"
      ],
      "enum_many": true,
      "sources": [
        "text"
      ]
    },
    "status": "text",
    "value": null,
    "sources": [
      "text"
    ]
  }'

201

201

{
  "id": 1,
  "name": "text",
  "specification": "text",
  "source_entity_type": "text",
  "description": "text",
  "type": "text",
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "rel_template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template_id": 1,
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "field": {
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  },
  "status": "text",
  "value": null,
  "sources": [
    "text"
  ]
}

get

/prod/v0/created-fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this created field.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/prod/v0/created-fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": 1,
  "name": "text",
  "specification": "text",
  "source_entity_type": "text",
  "description": "text",
  "type": "text",
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "rel_template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template_id": 1,
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "field": {
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  },
  "status": "text",
  "value": null,
  "sources": [
    "text"
  ]
}

put

/prod/v0/created-fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this created field.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerread-onlyrequired

namestring · max: 255required

specificationstring · max: 255required

source_entity_typestring | nullable

descriptionstring · max: 255required

typestring · max: 3required

enum_valuesstring[]

enum_manyboolean

rel_templateall of

fieldall ofread-onlyrequired

statusstring · max: 1read-onlyrequired

valueanyread-onlyrequired

sourcesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/prod/v0/created-fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "name": "text",
    "specification": "text",
    "source_entity_type": "text",
    "description": "text",
    "type": "text",
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "rel_template": {
      "id": 1,
      "name": "text",
      "description": "text",
      "fields": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template_id": 1,
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        }
      ],
      "questions": [
        "text"
      ]
    },
    "field": {
      "id": 1,
      "name": "text",
      "description": "text",
      "type": "text",
      "rel_template_id": 1,
      "rel_template": 1,
      "enum_values": [
        "text"
      ],
      "enum_many": true,
      "sources": [
        "text"
      ]
    },
    "status": "text",
    "value": null,
    "sources": [
      "text"
    ]
  }'

200

200

{
  "id": 1,
  "name": "text",
  "specification": "text",
  "source_entity_type": "text",
  "description": "text",
  "type": "text",
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "rel_template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template_id": 1,
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "field": {
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  },
  "status": "text",
  "value": null,
  "sources": [
    "text"
  ]
}

patch

/prod/v0/created-fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this created field.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerread-only

namestring · max: 255

specificationstring · max: 255

source_entity_typestring | nullable

descriptionstring · max: 255

typestring · max: 3

enum_valuesstring[]

enum_manyboolean

rel_templateall of

fieldall ofread-only

statusstring · max: 1read-only

valueanyread-only

sourcesstring[] | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/prod/v0/created-fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "name": "text",
    "specification": "text",
    "source_entity_type": "text",
    "description": "text",
    "type": "text",
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "rel_template": {
      "id": 1,
      "name": "text",
      "description": "text",
      "fields": [
        {
          "id": 1,
          "name": "text",
          "description": "text",
          "type": "text",
          "rel_template_id": 1,
          "rel_template": 1,
          "enum_values": [
            "text"
          ],
          "enum_many": true,
          "sources": [
            "text"
          ]
        }
      ],
      "questions": [
        "text"
      ]
    },
    "field": {
      "id": 1,
      "name": "text",
      "description": "text",
      "type": "text",
      "rel_template_id": 1,
      "rel_template": 1,
      "enum_values": [
        "text"
      ],
      "enum_many": true,
      "sources": [
        "text"
      ]
    },
    "status": "text",
    "value": null,
    "sources": [
      "text"
    ]
  }'

200

200

{
  "id": 1,
  "name": "text",
  "specification": "text",
  "source_entity_type": "text",
  "description": "text",
  "type": "text",
  "enum_values": [
    "text"
  ],
  "enum_many": true,
  "rel_template": {
    "id": 1,
    "name": "text",
    "description": "text",
    "fields": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "type": "text",
        "rel_template_id": 1,
        "rel_template": 1,
        "enum_values": [
          "text"
        ],
        "enum_many": true,
        "sources": [
          "text"
        ]
      }
    ],
    "questions": [
      "text"
    ]
  },
  "field": {
    "id": 1,
    "name": "text",
    "description": "text",
    "type": "text",
    "rel_template_id": 1,
    "rel_template": 1,
    "enum_values": [
      "text"
    ],
    "enum_many": true,
    "sources": [
      "text"
    ]
  },
  "status": "text",
  "value": null,
  "sources": [
    "text"
  ]
}

delete

/prod/v0/created-fields/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this created field.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/prod/v0/created-fields/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No response body