Hoshinplan

API Docs

Tasks

>>>

GET /tasks/:id
Get a task

Examples

curl "https://www.hoshinplan.com/tasks/45544?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Accept: application/json"


Response:
{
    "id": 45544,
    "name": "My task",
    "description": "This is my task created through the API",
    "deadline": "2021-01-03",
    "original_deadline": "2021-01-03",
    "created_at": "2010-10-02T09:47:59.186Z",
    "updated_at": "2010-10-02T10:33:42.326Z",
    "objective_id": 9400,
    "status": "backlog",
    "key_timestamp": null,
    "tsk_pos": 9,
    "area_id": 448231,
    "show_on_parent": null,
    "responsible_id": 253123,
    "company_id": 120,
    "reminder": true,
    "creator_id": null,
    "hoshin_id": 1545,
    "lane_pos": 0,
    "parent_area_id": null,
    "parent_objective_id": null,
    "feeling": "wondering"
}

Respuesta

Code: 200

Description:

OK

Param name Description
id
optional

Validations:

  • Must be a number.
name
optional

Validations:

  • Must be a String
original_deadline
optional

Validations:

  • Must be Date.
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
hoshin_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
area_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this task belongs to

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this task

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
parent_objective_id
optional

The id of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
parent_area_id
optional

The id of the area of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.
deleted_at
optional

The date when this task was deleted

Validations:

  • Must be Date.
>>>

POST /objectives/:objective_id/tasks
Create a task for the given objective

Supported Formats

json, xml

Examples

curl -X POST "https://www.hoshinplan.com/objectives/23423/tasks?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "name": "My new task",
  "description": "This is my task created through the API",
  "responsible_id": 213312,
  "status": "active"
}'

Params

Param name Description
name
required

Validations:

  • Must be a String
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.

Respuesta

Code: 201

Description:

The newly created task

Param name Description
id
optional

Validations:

  • Must be a number.
name
optional

Validations:

  • Must be a String
original_deadline
optional

Validations:

  • Must be Date.
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
hoshin_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
area_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this task belongs to

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this task

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
parent_objective_id
optional

The id of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
parent_area_id
optional

The id of the area of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.
deleted_at
optional

The date when this task was deleted

Validations:

  • Must be Date.
>>>

DELETE /tasks/:id
Delete a task

Examples

curl -X DELETE "https://www.hoshinplan.com/tasks/45544?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Accept: application/json"

Respuesta

Code: 204

Description:

No Content

Param name Description
>>>

PUT /tasks/:id
Update a task

Supported Formats

json, xml

Examples

curl -X PUT "https://www.hoshinplan.com/tasks/45544?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "status": "completed"
}'

Params

Param name Description
name
optional

Validations:

  • Must be a String
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.

Respuesta

Code: 200

Description:

The updated task

Param name Description
id
optional

Validations:

  • Must be a number.
name
optional

Validations:

  • Must be a String
original_deadline
optional

Validations:

  • Must be Date.
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
tsk_pos
optional

Used to sort the tasks in the hoshin view

Validations:

  • Must be a number.
lane_pos
optional

Used to sort the tasks in the kanban view

Validations:

  • Must be a number.
hoshin_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
area_id
optional

The id of the area this task belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this task belongs to

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this task

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this task belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this task

Validations:

  • Must be a number.
description
optional

Validations:

  • Must be a String
deadline
optional

Validations:

  • Must be Date.
show_on_parent
optional

Show this task in the parent Hoshin

Validations:

  • Must be one of: true, false, 1, 0.
parent_objective_id
optional

The id of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
parent_area_id
optional

The id of the area of the parent objective of the objective this task belongs to

Validations:

  • Must be a number.
reminder
optional

Send email reminders to the owner when the deadline comes

Validations:

  • Must be one of: true, false, 1, 0.
feeling
optional

How you are feeling about completing this task as planned

Validations:

  • Must be one of: smile, wondering, sad.
status
optional

Validations:

  • Must be one of: backlog, active, completed, discarded, deleted.
deleted_at
optional

The date when this task was deleted

Validations:

  • Must be Date.