Hoshinplan

API Docs

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

Ejemplos

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
}'

Parámetros

Nombre del parámetro Descripción
name
opcional

Validations:

  • Must be a String
description
opcional

Validations:

  • Must be a String
obj_pos
opcional

Used to sort the objectives in the hoshin view

Validations:

  • Must be a number.
parent_id
opcional

The id of the parent objective in the parent hoshin

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this objective

Validations:

  • Must be a number.

Respuesta

Código HTTP: 201

Descripción:

The newly created objective

Nombre del parámetro Descripción
id
opcional

Validations:

  • Must be a number.
name
opcional

Validations:

  • Must be a String
description
opcional

Validations:

  • Must be a String
created_at
opcional

Validations:

  • Must be Date.
updated_at
opcional

Validations:

  • Must be Date.
hoshin_id
opcional

The id of the area this objective belongs to

Validations:

  • Must be a number.
area_id
opcional

The id of the area this objective belongs to

Validations:

  • Must be a number.
company_id
opcional

The id of the company this objective belongs to

Validations:

  • Must be a number.
obj_pos
opcional

Used to sort the objectives in the hoshin view

Validations:

  • Must be a number.
parent_id
opcional

The id of the parent objective in the parent hoshin

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this objective

Validations:

  • Must be a number.
creator_id
opcional

The id of the user that created this objective

Validations:

  • Must be a number.
neglected
opcional

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
opcional

True if this objective does not have any indicators

Validations:

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

The date when this objective was deleted

Validations:

  • Must be Date.