Templates
Basic Template operations
get
Authorizations
Query parameters
namestringOptional
Responses
200Success
application/json
get
GET /prod/v0/templates/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
{
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
}
]post
Authorizations
Body
idintegerRead-onlyRequired
namestring · max: 255Required
descriptionstring | nullableOptional
questionsstring[]Optional
Responses
201Success
application/json
post
POST /prod/v0/templates/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205
{
"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"
]
}201Success
{
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
}get
Authorizations
Path parameters
idintegerRequired
A unique integer value identifying this template.
Responses
200Success
application/json
get
GET /prod/v0/templates/{id}/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
}put
Authorizations
Path parameters
idintegerRequired
A unique integer value identifying this template.
Body
idintegerRead-onlyRequired
namestring · max: 255Required
descriptionstring | nullableOptional
questionsstring[]Optional
Responses
200Success
application/json
put
PUT /prod/v0/templates/{id}/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205
{
"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"
]
}200Success
{
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
}patch
Authorizations
Path parameters
idintegerRequired
A unique integer value identifying this template.
Body
idintegerRead-onlyOptional
namestring · max: 255Optional
descriptionstring | nullableOptional
questionsstring[]Optional
Responses
200Success
application/json
patch
PATCH /prod/v0/templates/{id}/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205
{
"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"
]
}200Success
{
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
}delete
Authorizations
Path parameters
idintegerRequired
A unique integer value identifying this template.
Responses
204
No response body
delete
DELETE /prod/v0/templates/{id}/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204
No response body
No content
get
Authorizations
Path parameters
template_idstringRequiredPattern:
^\d+$Responses
200Success
application/json
get
GET /prod/v0/templates/{template_id}/profiles/ HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
{
"id": 1,
"tags": [
{
"id": 1,
"name": "text",
"description": "text"
}
],
"specification": "text",
"template": {
"id": 1,
"name": "text",
"description": "text",
"fields": [
{
"id": 1,
"name": "text",
"description": "text",
"type": "text",
"rel_template": 1,
"enum_values": [
"text"
],
"enum_many": true,
"sources": [
"text"
]
}
],
"questions": [
"text"
]
},
"snapshots": [
{
"id": 1,
"status": "text",
"answers": [
{
"id": 1,
"answer": null
}
],
"fields": [
{
"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
}
],
"reports": [
{
"id": 1,
"outline": {
"id": 1,
"outline": null,
"perspective": "text"
},
"report": null
}
]
}
]
}
]Last updated