Task Creation

Create simple or recurring tasks

Create a task (simple or recurring)

post

Creates a task linked to a submission model (submission_model_id) or to a list of submissions (submissions). For a recurring task, add the recurrency object; in that case due_date is not required.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/json

Body for creating a task. Provide either submission_model_id or submissions. Add recurrency for a recurring task (in which case due_date is optional).

start_dateinteger · int64Required

Task start date (UNIX timestamp)

due_dateinteger · int64Optional

Due date (UNIX timestamp). Optional for a recurring task.

submission_model_idstring · uuidOptional

Identifier of a submission model

submissionsstring · uuid[]Optional

List of submission identifiers

user_idinteger · nullableOptional

Identifier of the assigned user

durationintegerOptional

Task duration in seconds

delay_beforeintegerOptional

Indicative display delay in seconds before the task begins

delay_afterintegerOptional

Indicative display delay in seconds after the task's due time

Responses

200

Task created

application/json

idstring · uuidOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

start_dateinteger · int64Optional

Planned start date (Unix timestamp)

due_dateinteger · int64Optional

Due date (Unix timestamp)

durationintegerOptional

Expected duration in seconds

delay_beforeintegerOptional

Indicative display delay in seconds before the task begins

delay_afterintegerOptional

Indicative display delay in seconds after task completion time

user_idintegerOptional

post/{app_short}/tasks

HTTPcURLJavaScriptPython

POST /{app_short}/tasks HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 344

{
  "start_date": 1,
  "due_date": 1,
  "submission_model_id": "123e4567-e89b-12d3-a456-426614174000",
  "submissions": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "user_id": 1,
  "duration": 1,
  "delay_before": 1,
  "delay_after": 1,
  "recurrency": {
    "type": "daily",
    "interval": 1,
    "days": {
      "ANY_ADDITIONAL_PROPERTY": {
        "start": "text",
        "end": 1
      }
    },
    "end": {
      "type": "occurrence",
      "value": 1
    }
  }
}

200

Task created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": 1,
  "updated_at": 1,
  "start_date": 1,
  "due_date": 1,
  "duration": 1,
  "delay_before": 1,
  "delay_after": 1,
  "user_id": 1,
  "submission": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "structure_id": 1,
    "structure_version": 1,
    "created_at": 1,
    "updated_at": 1,
    "data_created_at": 1,
    "data_updated_at": 1,
    "user_id": 1,
    "channels": [
      "text"
    ],
    "items": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "submission_number": 1,
    "number_in_structure": 1,
    "latitude": 1,
    "longitude": 1,
    "last_updated_user_id": 1,
    "current_state": "123e4567-e89b-12d3-a456-426614174000",
    "assigned_user": {
      "id": 1,
      "email": "[e-mail]",
      "first_name": "text",
      "last_name": "text",
      "groups": [],
      "system_groups": []
    },
    "subscribers": [],
    "settings": []
  }
}