Hoshinplan

API Docs

POST /areas/:area_id/objectives
Create an objective for the given area

Examples

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

Params

Param name Description
name
optional

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
obj_pos
optional

Used to sort the objectives in the hoshin view

Validations:

  • Must be a number.
parent_id
optional

The id of the parent objective in the parent hoshin

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this objective

Validations:

  • Must be a number.

Respuesta

Code: 201

Description:

The newly created objective

Param name Description
id
optional

Validations:

  • Must be a number.
name
optional

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
hoshin_id
optional

The id of the area this objective belongs to

Validations:

  • Must be a number.
area_id
optional

The id of the area this objective belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this objective belongs to

Validations:

  • Must be a number.
obj_pos
optional

Used to sort the objectives in the hoshin view

Validations:

  • Must be a number.
parent_id
optional

The id of the parent objective in the parent hoshin

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this objective

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this objective

Validations:

  • Must be a number.
neglected
optional

True if this objective has indicators below 100% and does not have any active tasks

Validations:

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

True if this objective does not have any indicators

Validations:

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

The date when this objective was deleted

Validations:

  • Must be Date.