Tasks API

List tasks

GET /task
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • finish_date

The following scopes are needed:

  • task_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 1059
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "finish_date": null,
    "subject": "Unterlagen versenden",
    "place": null,
    "info": "so schnell wie möglich.",
    "contact_id": 1,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "todo_status_id": 1,
    "todo_priority_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "communication_kind_id": null
  },
  {
    "id": 2,
    "user_id": 1,
    "finish_date": "2013-02-03 12:11:20",
    "subject": "Zeiten erfassen",
    "place": null,
    "info": "",
    "contact_id": null,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "todo_status_id": 1,
    "todo_priority_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "communication_kind_id": null
  },
  {
    "id": 3,
    "user_id": 1,
    "finish_date": "2013-02-25 10:00:00",
    "subject": "Planning my vacation with Beatrice",
    "place": null,
    "info": "",
    "contact_id": null,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "todo_status_id": 1,
    "todo_priority_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "communication_kind_id": null
  }
]

Search tasks

POST /task/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "subject",
    "value": "Unterlagen"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • finish_date
  • id
Name Required Type Description
updated_at optional string
user_id optional string
contact_id optional string
todo_status_id optional string
module_id optional string
entry_id optional string
subject optional string

The following scopes are needed:

  • task_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 356
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "finish_date": null,
    "subject": "Unterlagen versenden",
    "place": null,
    "info": "so schnell wie möglich.",
    "contact_id": 1,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "todo_status_id": 1,
    "todo_priority_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "communication_kind_id": null
  }
]

Show task

GET /task/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • task_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 90800e9b9633589030348d0d26c02fd7
Content-Length: 360
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "finish_date": "2013-02-25 10:00:00",
  "subject": "Planning my vacation with Beatrice",
  "place": null,
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "todo_status_id": 1,
  "todo_priority_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "communication_kind_id": null
}

Create task

POST /task
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "subject": "Planning my vacation with Beatrice",
  "finish_date": "2013-02-25 10:00:00"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
remember_time_id required Resource remember_time Is required if have_remember is set to true.
remember_type_id required Resource remember_type Is required if have_remember is set to true.
subject required string (150)
user_id required Resource user
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
finish_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
have_remember optional boolean
info optional string (10000)
module_id optional Resource module
pr_project_id optional Resource pr_project
sub_contact_id optional Resource contact
todo_priority_id optional Resource todo_priority
todo_status_id optional Resource todo_status

The following scopes are needed:

  • task_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 90800e9b9633589030348d0d26c02fd7
Content-Length: 360
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "finish_date": "2013-02-25 10:00:00",
  "subject": "Planning my vacation with Beatrice",
  "place": null,
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "todo_status_id": 1,
  "todo_priority_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "communication_kind_id": null
}

Overwrite task

PUT /task/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "subject": "Planning my vacation with Beatrice",
  "finish_date": "2013-02-25 10:00:00"
}
Name Required Type Description
callback optional string
Name Required Type Description
remember_time_id required Resource remember_time Is required if have_remember is set to true.
remember_type_id required Resource remember_type Is required if have_remember is set to true.
subject required string (150)
user_id required Resource user
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
finish_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
have_remember optional boolean
info optional string (10000)
module_id optional Resource module
pr_project_id optional Resource pr_project
sub_contact_id optional Resource contact
todo_priority_id optional Resource todo_priority
todo_status_id optional Resource todo_status

The following scopes are needed:

  • task_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 90800e9b9633589030348d0d26c02fd7
Content-Length: 360
Content-Type: application/json
{
  "id": 3,
  "user_id": 1,
  "finish_date": "2013-02-25 10:00:00",
  "subject": "Planning my vacation with Beatrice",
  "place": null,
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "todo_status_id": 1,
  "todo_priority_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "communication_kind_id": null
}

Edit task

POST /task/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 2,
  "subject": "Planning my vacation with Alex",
  "finish_date": "2013-02-25 10:00:00"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
finish_date optional datetime (Format yyyy-mm-dd hh:ii:ss)
have_remember optional boolean
info optional string (10000)
module_id optional Resource module
pr_project_id optional Resource pr_project
remember_time_id optional Resource remember_time Is required if have_remember is set to true.
remember_type_id optional Resource remember_type Is required if have_remember is set to true.
sub_contact_id optional Resource contact
subject optional string (150)
todo_priority_id optional Resource todo_priority
todo_status_id optional Resource todo_status
user_id optional Resource user

The following scopes are needed:

  • task_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 90800e9b9633589030348d0d26c02fd7
Content-Length: 356
Content-Type: application/json
{
  "id": 3,
  "user_id": 2,
  "finish_date": "2013-02-25 10:00:00",
  "subject": "Planning my vacation with Alex",
  "place": null,
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "todo_status_id": 1,
  "todo_priority_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "communication_kind_id": null
}

Delete task

DELETE /task/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • task_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}