Hoshinplan

API Docs

POST /objectives/:objective_id/indicators
Create an indicator for the given objective

Supported Formats

json, xml

Examples

curl -X POST "https://www.hoshinplan.com/objectives/23423/indicators?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "name": "My new indicator",
  "description": "This is my indicator created through the API",
  "responsible_id": 213312,
  "goal": "100",
  "worst_value": "0",
  "frequency": "weekly",
  "next_update": "2021-07-08T18:20:01.530Z"
}'

Params

Param name Description
name
optional

Validations:

  • Must be a String
value
optional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
optional

Validations:

  • Must be a String
ind_pos
optional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
optional

The update frequency for this indicator

Validations:

  • Must be one of: weekly, monthly, quarterly.
next_update
optional

The date of the next desired update

Validations:

  • Must be Date.
goal
optional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
optional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
optional

Send email reminders to the owner when the next update date comes

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.

Respuesta

Code: 201

Description:

The newly created indicator

Param name Description
name
optional

Validations:

  • Must be a String
value
optional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
optional

Validations:

  • Must be a String
ind_pos
optional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
optional

The update frequency for this indicator

Validations:

  • Must be one of: weekly, monthly, quarterly.
next_update
optional

The date of the next desired update

Validations:

  • Must be Date.
goal
optional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
optional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
optional

Send email reminders to the owner when the next update date comes

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the area this indicator belongs to

Validations:

  • Must be a number.
area_id
optional

The id of the area this indicator belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this indicator belongs to

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this indicator

Validations:

  • Must be a number.
objective_id
optional

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
optional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.
last_update
optional

The timestamp of the last time this indicator was updated

Validations:

  • Must be Date.
last_value
optional

The previous value for this indicator

Validations:

  • Must be a decimal number.
created_at
optional

Validations:

  • Must be Date.
updated_at
optional

Validations:

  • Must be Date.
parent_objective_id
optional

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

Validations:

  • Must be a number.
parent_area_id
optional

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

Validations:

  • Must be a number.
deleted_at
optional

The date when this indicator was deleted

Validations:

  • Must be Date.