Supported Formats

json

POST /api/projects/:project_id/tasks
Creates task for project.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
422 Unprocessable Project Task.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String

template_id
optional

Template ID

Validations:

  • Must be a String

external_id
optional

External ID

Validations:

  • Must be a String

keyword_url
optional

Keyword Url

Validations:

  • Must be a String

keywords
optional

Task parameter container

Validations:

  • Must be an Array of nested elements

keywords[keyword]
optional

Validations:

  • Must be a String

keywords[substitute]
optional

Validations:

  • Must be a String


PUT /api/tasks/:id
Accepts writer's content.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

task
required

Task parameter container

Validations:

  • Must be an Array of nested elements

task[content]
required

Task content

Validations:

  • Must be a String

task[meta_description]
required

Meta Description

Validations:

  • Must be a String


DELETE /api/projects/:project_id/tasks/:id
Delete project task

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found.
404 Project Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
project_id
required

Project ID

Validations:

  • Must be a String

id
required

Task ID

Validations:

  • Must be a String


GET /api/tasks
Lists tasks.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Examples

GET /api/tasks?page=2&per_page=4
GET /api/tasks
200

Params

Param name Description
page
optional

For pagination. Default is 1

Validations:

  • Must be a Integer

per_page
optional

For pagination. Default is 1

Validations:

  • Must be a Integer

after_id
optional

This is for returning next record after given record id.

Validations:

  • Must be a String

before_id
optional

This is for returning prev record after given record id.

Validations:

  • Must be a String


GET /api/tasks/:id/activities
Get task activity history

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String


GET /api/tasks/:id
Returns the given task detail.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String


PATCH /api/tasks/:id/approve
Approve Project Task.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

content
optional

Task content

Validations:

  • Must be a String


PATCH /api/tasks/:id/disapprove
Disapprove Project Task.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

reject_reason
required

Reason for rejecting a task.

Validations:

  • Must be a String

rejection_comment
optional

Comment for rejecting a task

Validations:

  • Must be a String


PATCH /api/tasks/:id/takeover
Takeover or refresh taking over.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Examples

PATCH /api/tasks/59c24192a83dc1219d4ee8ec/takeover
{
  "task": {}
}
200

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

manage
optional

Manager wants to edit the task content.

Validations:

  • Must be a String


PATCH /api/tasks/:id/release
Release the task from someone.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
422 Unprocessable Project Task.
404 Task Not Found.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

reason
optional

Drop reason

Validations:

  • Must be a String


PATCH /api/tasks/:id/flag_task
Flag Project Task.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

reject_comment
optional

Comment for flagging a task

Validations:

  • Must be a String


PATCH /api/tasks/:id/send_back
Send back a flagged task.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

reject_comment
optional

Comment for sending task back

Validations:

  • Must be a String


PATCH /api/tasks/:id/pause
Send back a flagged task.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String

reject_comment
optional

Comment for sending task back

Validations:

  • Must be a String


PATCH /api/tasks/:id/toggle_published
Toggles between approved and published states

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found.
422 Unprocessable Project Task.

Params

Param name Description
id
required

Task ID

Validations:

  • Must be a String


PATCH /api/tasks/:id/select_template
Changes Task template ID.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found
422 Unprocessable Task.

Examples

PATCH /api/tasks/59c241e5a83dc1219d4f3150/select_template
{
  "task": {}
}
403

Params

Param name Description
id
optional

Task ID.

Validations:

  • Must be a String

template_id
optional

Template ID.

Validations:

  • Must be a String


PATCH /api/tasks/:id/update_template
Updates Task template. Please see library_templates/update for more information.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found
422 Unprocessable Task.

Params

Param name Description
id
optional

Task ID.

Validations:

  • Must be a String


DELETE /api/tasks/:id/remove_template
Removes Task template

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found
422 Unprocessable Task.

Params

Param name Description
id
optional

Task ID.

Validations:

  • Must be a String


GET /api/tasks/:id/plagiarism_data
Returns plagiarism_data.

Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Task Not Found
422 Unprocessable Task.

Params

Param name Description
id
optional

Task ID.

Validations:

  • Must be a String