Fields

Basic Template operations

---

Field CRUD Operations

get

Authorizations

Query parameters

namestringOptional

typestring · enumOptional

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

Possible values:

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /prod/v0/fields/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

post

Authorizations

Body

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

idintegerOptional

namestring · max: 255Required

descriptionstring · max: 255Required

typestring · max: 3Required

rel_template_idinteger | nullableWrite-onlyOptional

rel_templateintegerRead-onlyRequired

enum_valuesstring[]Optional

enum_manybooleanOptional

sourcesstring[] | nullableOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /prod/v0/fields/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

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

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

201Success

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

get

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this field.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /prod/v0/fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

put

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this field.

Body

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

idintegerOptional

namestring · max: 255Required

descriptionstring · max: 255Required

typestring · max: 3Required

rel_template_idinteger | nullableWrite-onlyOptional

rel_templateintegerRead-onlyRequired

enum_valuesstring[]Optional

enum_manybooleanOptional

sourcesstring[] | nullableOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /prod/v0/fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

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

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

200Success

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

patch

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this field.

Body

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

idintegerOptional

namestring · max: 255Optional

descriptionstring · max: 255Optional

typestring · max: 3Optional

rel_template_idinteger | nullableWrite-onlyOptional

rel_templateintegerRead-onlyOptional

enum_valuesstring[]Optional

enum_manybooleanOptional

sourcesstring[] | nullableOptional

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /prod/v0/fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

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

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

200Success

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

delete

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this field.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /prod/v0/fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

Attach a field to a Template

post

Authorizations

Path parameters

field_idstringRequiredPattern: ^\d+$

Body

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

template_idintegerWrite-onlyRequired

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /prod/v0/fields/{field_id}/template/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "template_id": 1
}

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

201Success

{}

Created Field Operations

get

Authorizations

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /prod/v0/created-fields/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

post

Authorizations

Body

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

idintegerRead-onlyRequired

namestring · max: 255Write-onlyRequired

specificationstring · max: 255Write-onlyRequired

source_entity_typestring | nullableWrite-onlyOptional

descriptionstring · max: 255Write-onlyRequired

typestring · max: 3Write-onlyRequired

enum_valuesstring[]Write-onlyOptional

enum_manybooleanWrite-onlyOptional

rel_templateall ofWrite-onlyOptional

fieldall ofRead-onlyRequired

statusstring · max: 1Read-onlyRequired

valueanyRead-onlyRequired

sourcesstring[] | nullableWrite-onlyOptional

Responses

201Success

application/json

post

HTTPcURLJavaScriptPython

POST /prod/v0/created-fields/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381

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

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

201Success

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

get

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this created field.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /prod/v0/created-fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

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

put

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: 255Write-onlyRequired

specificationstring · max: 255Write-onlyRequired

source_entity_typestring | nullableWrite-onlyOptional

descriptionstring · max: 255Write-onlyRequired

typestring · max: 3Write-onlyRequired

enum_valuesstring[]Write-onlyOptional

enum_manybooleanWrite-onlyOptional

rel_templateall ofWrite-onlyOptional

fieldall ofRead-onlyRequired

statusstring · max: 1Read-onlyRequired

valueanyRead-onlyRequired

sourcesstring[] | nullableWrite-onlyOptional

Responses

200Success

application/json

put

HTTPcURLJavaScriptPython

PUT /prod/v0/created-fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381

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

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

200Success

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

patch

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this created field.

Body

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

idintegerRead-onlyOptional

namestring · max: 255Write-onlyOptional

specificationstring · max: 255Write-onlyOptional

source_entity_typestring | nullableWrite-onlyOptional

descriptionstring · max: 255Write-onlyOptional

typestring · max: 3Write-onlyOptional

enum_valuesstring[]Write-onlyOptional

enum_manybooleanWrite-onlyOptional

rel_templateall ofWrite-onlyOptional

fieldall ofRead-onlyOptional

statusstring · max: 1Read-onlyOptional

valueanyRead-onlyOptional

sourcesstring[] | nullableWrite-onlyOptional

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /prod/v0/created-fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 381

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

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

200Success

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

delete

Authorizations

Path parameters

idintegerRequired

A unique integer value identifying this created field.

Responses

204

No response body

delete

HTTPcURLJavaScriptPython

DELETE /prod/v0/created-fields/{id}/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content