Hoshinplan

API Docs

Goals

>>>

GET /goals/:id
Get a long term goal

Examples

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


Response:
{
    "id": 21344,
    "name": "My goal",
    "created_at": "2021-01-28T18:28:23.492Z",
    "updated_at": "2021-01-29T09:21:33.533Z",
    "hoshin_id": 1234,
    "position": 1,
    "company_id": 2345234,
    "creator_id": 234234,
    "deleted_at": null
}

Respuesta

Code: 200

Description:

OK

Param name Description
id
optional

Validations:

  • Must be a number.
name
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 goal belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this objective belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the goals in the hoshin view

Validations:

  • Must be a number.
>>>

PUT /goals/:id
Update a long term goal

Supported Formats

json, xml

Examples

curl -X PUT "https://www.hoshinplan.com/goals/45544?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "name": "This is the new name"
}'

Params

Param name Description
name
optional

Validations:

  • Must be a String
position
optional

Used to sort the goals in the hoshin view

Validations:

  • Must be a number.

Respuesta

Code: 200

Description:

The updated long term goal

Param name Description
id
optional

Validations:

  • Must be a number.
name
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 goal belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this objective belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the goals in the hoshin view

Validations:

  • Must be a number.
>>>

POST /hoshins/:hoshin_id/goals
Create a long term goal for the given hoshin

Supported Formats

json, xml

Examples

curl -X POST "https://www.hoshinplan.com/hoshins/12312/goals?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "name": "My new goal"
}'

Params

Param name Description
name
required

Validations:

  • Must be a String
position
optional

Used to sort the goals in the hoshin view

Validations:

  • Must be a number.

Respuesta

Code: 201

Description:

The newly created goal

Param name Description
id
optional

Validations:

  • Must be a number.
name
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 goal belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this objective belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the goals in the hoshin view

Validations:

  • Must be a number.
>>>

DELETE /goals/:id
Delete a long term goal

Examples

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

Respuesta

Code: 204

Description:

No Content

Param name Description