Templates

Basic Template operations

---

get

/prod/v0/templates/

Authorizations

Query parameters

namestring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

[
  {
    "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"
    ]
  }
]

post

/prod/v0/templates/

Authorizations

Body

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

idintegerread-onlyrequired

namestring · max: 255required

descriptionstring | nullable

fieldsobject[]required

questionsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/prod/v0/templates/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    ]
  }'

201

201

{
  "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"
  ]
}

get

/prod/v0/templates/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this template.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "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"
  ]
}

put

/prod/v0/templates/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this template.

Body

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

idintegerread-onlyrequired

namestring · max: 255required

descriptionstring | nullable

fieldsobject[]required

questionsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/prod/v0/templates/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    ]
  }'

200

200

{
  "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"
  ]
}

patch

/prod/v0/templates/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this template.

Body

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

idintegerread-only

namestring · max: 255

descriptionstring | nullable

fieldsobject[]

questionsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/prod/v0/templates/{id}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    ]
  }'

200

200

{
  "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"
  ]
}

delete

/prod/v0/templates/{id}//

Authorizations

Path parameters

idintegerrequired

A unique integer value identifying this template.

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

No response body

get

/prod/v0/templates/{template_id}/profiles/

Authorizations

Path parameters

template_idstringrequired

Pattern: ^\d+$

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/prod/v0/templates/{template_id}/profiles/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

[
  {
    "id": 1,
    "template_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_id": 1,
          "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,
            "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"
            ]
          }
        ],
        "reports": [
          {
            "id": 1,
            "profile_id": 1,
            "outline_id": 1,
            "outline": {
              "id": 1,
              "profile_id": 1,
              "report_title": "text",
              "section_titles": [
                "text"
              ],
              "outline": null,
              "perspective": "text"
            },
            "report": null
          }
        ]
      }
    ]
  }
]