Hoshinplan

API Docs

Indicators

>>>

GET /indicators/:id
Get an indicator

Ejemplos

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


Response:
{
    "id": 45544,
    "name": "My indicator",
    "description": "This is my indicator created through the API",
    "value": "33.74",
    "frequency": "weekly",
    "next_update": "2021-08-08",
    "goal": "50.0",
    "created_at": "2021-07-08T18:20:01.530Z",
    "updated_at": "2021-07-30T11:19:33.893Z",
    "objective_id": 8786,
    "area_id": 4364,
    "ind_pos": 1,
    "last_update": "2021-08-01",
    "last_value": "39.6",
    "responsible_id": 252433,
    "company_id": 123420,
    "reminder": true,
    "worst_value": "30.0",
    "show_on_parent": false,
    "creator_id": 223553,
    "hoshin_id": 1235545,
    "show_on_charts": true,
    "parent_area_id": null,
    "parent_objective_id": null,
    "deleted_at": null
}

Respuesta

Código HTTP: 200

Descripción:

OK

Nombre del parámetro Descripción
name
opcional

Validations:

  • Must be a String
value
opcional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
opcional

Validations:

  • Must be a String
ind_pos
opcional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
opcional

The update frequency for this indicator

Validations:

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

The date of the next desired update

Validations:

  • Must be Date.
goal
opcional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
opcional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
opcional

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

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the area this indicator belongs to

Validations:

  • Must be a number.
area_id
opcional

The id of the area this indicator belongs to

Validations:

  • Must be a number.
company_id
opcional

The id of the company this indicator belongs to

Validations:

  • Must be a number.
creator_id
opcional

The id of the user that created this indicator

Validations:

  • Must be a number.
objective_id
opcional

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.
last_update
opcional

The timestamp of the last time this indicator was updated

Validations:

  • Must be Date.
last_value
opcional

The previous value for this indicator

Validations:

  • Must be a decimal number.
created_at
opcional

Validations:

  • Must be Date.
updated_at
opcional

Validations:

  • Must be Date.
parent_objective_id
opcional

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

Validations:

  • Must be a number.
parent_area_id
opcional

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

Validations:

  • Must be a number.
deleted_at
opcional

The date when this indicator was deleted

Validations:

  • Must be Date.
>>>

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

Formatos soportados

json, xml

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
name
opcional

Validations:

  • Must be a String
value
opcional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
opcional

Validations:

  • Must be a String
ind_pos
opcional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
opcional

The update frequency for this indicator

Validations:

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

The date of the next desired update

Validations:

  • Must be Date.
goal
opcional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
opcional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
opcional

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

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.

Respuesta

Código HTTP: 201

Descripción:

The newly created indicator

Nombre del parámetro Descripción
name
opcional

Validations:

  • Must be a String
value
opcional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
opcional

Validations:

  • Must be a String
ind_pos
opcional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
opcional

The update frequency for this indicator

Validations:

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

The date of the next desired update

Validations:

  • Must be Date.
goal
opcional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
opcional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
opcional

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

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the area this indicator belongs to

Validations:

  • Must be a number.
area_id
opcional

The id of the area this indicator belongs to

Validations:

  • Must be a number.
company_id
opcional

The id of the company this indicator belongs to

Validations:

  • Must be a number.
creator_id
opcional

The id of the user that created this indicator

Validations:

  • Must be a number.
objective_id
opcional

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.
last_update
opcional

The timestamp of the last time this indicator was updated

Validations:

  • Must be Date.
last_value
opcional

The previous value for this indicator

Validations:

  • Must be a decimal number.
created_at
opcional

Validations:

  • Must be Date.
updated_at
opcional

Validations:

  • Must be Date.
parent_objective_id
opcional

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

Validations:

  • Must be a number.
parent_area_id
opcional

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

Validations:

  • Must be a number.
deleted_at
opcional

The date when this indicator was deleted

Validations:

  • Must be Date.
>>>

DELETE /indicators/:id
Delete an indicator

Ejemplos

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

Respuesta

Código HTTP: 204

Descripción:

No Content

Nombre del parámetro Descripción
>>>

PUT /indicators/:id
Update an indicator

Formatos soportados

json, xml

Ejemplos

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

Parámetros

Nombre del parámetro Descripción
name
opcional

Validations:

  • Must be a String
value
opcional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
opcional

Validations:

  • Must be a String
ind_pos
opcional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
opcional

The update frequency for this indicator

Validations:

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

The date of the next desired update

Validations:

  • Must be Date.
goal
opcional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
opcional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
opcional

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

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.

Respuesta

Código HTTP: 200

Descripción:

The updated indicator

Nombre del parámetro Descripción
name
opcional

Validations:

  • Must be a String
value
opcional

The current value for this indicator

Validations:

  • Must be a decimal number.
description
opcional

Validations:

  • Must be a String
ind_pos
opcional

Used to sort the indicators in the hoshin view

Validations:

  • Must be a number.
frequency
opcional

The update frequency for this indicator

Validations:

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

The date of the next desired update

Validations:

  • Must be Date.
goal
opcional

The value that would set this indicator to 100%

Validations:

  • Must be a decimal number.
worst_value
opcional

The value that would set this indicator to 0%

Validations:

  • Must be a decimal number.
reminder
opcional

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

Validations:

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

Show this indicator in the parent Hoshin

Validations:

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

Show this indicator in the Hoshin charts view

Validations:

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

The id of the area this indicator belongs to

Validations:

  • Must be a number.
area_id
opcional

The id of the area this indicator belongs to

Validations:

  • Must be a number.
company_id
opcional

The id of the company this indicator belongs to

Validations:

  • Must be a number.
creator_id
opcional

The id of the user that created this indicator

Validations:

  • Must be a number.
objective_id
opcional

The id of the objective this indicator belongs to

Validations:

  • Must be a number.
responsible_id
opcional

The id of the user that is responsible for this indicator

Validations:

  • Must be a number.
last_update
opcional

The timestamp of the last time this indicator was updated

Validations:

  • Must be Date.
last_value
opcional

The previous value for this indicator

Validations:

  • Must be a decimal number.
created_at
opcional

Validations:

  • Must be Date.
updated_at
opcional

Validations:

  • Must be Date.
parent_objective_id
opcional

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

Validations:

  • Must be a number.
parent_area_id
opcional

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

Validations:

  • Must be a number.
deleted_at
opcional

The date when this indicator was deleted

Validations:

  • Must be Date.