Create a task document

Links the specified document to the specified task.

POST /tasks/{taskId}/documents

Create a task document

cURL

curl --request POST \
  --url https://api.smokeball.com/tasks/{taskId}/documents \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": 0,
  "documentId": "cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277"
}
'

import requests

url = "https://api.smokeball.com/tasks/{taskId}/documents"

payload = {
    "type": 0,
    "documentId": "cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277"
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({type: 0, documentId: 'cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277'})
};

fetch('https://api.smokeball.com/tasks/{taskId}/documents', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/tasks/{taskId}/documents",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 0,
    'documentId' => 'cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/tasks/{taskId}/documents"

	payload := strings.NewReader("{\n  \"type\": 0,\n  \"documentId\": \"cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.smokeball.com/tasks/{taskId}/documents")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"type\": 0,\n  \"documentId\": \"cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/tasks/{taskId}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"type\": 0,\n  \"documentId\": \"cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277\"\n}"

response = http.request(request)
puts response.read_body

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

taskId · string<uuid> · required

Body

application/json-patch+jsonapplication/jsonapplication/*+json

Data transfer object for a task document.

type · enum<integer> · required

The type of the document.

Possible values: File = 0, FormTemplate = 1, Memo = 2.

The FormTemplate (1) document type is not currently supported for task document creation.

Available options: 0, 1, 2

Example:

0

documentId · string | null

Unique identifier of the document (file or memo).

If a file, the type must be 0 (File).

If a memo, the type must be 2 (Memo).

The FormTemplate (1) document type is not currently supported for task document creation.

Example:

"cf666f06-3ff2-4a41-8c7f-ab5a8bc6a277"

Response

202

application/json

When request is accepted. Returns a hypermedia 'Link' object of the link to be created.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET