Hoshinplan

API Docs

Areas

>>>

POST /hoshins/:hoshin_id/areas
Create an area for the given Hoshin

Examples

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

Params

Param name Description
name
optional

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String

Respuesta

Code: 201

Description:

The newly created area

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 area belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this area belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this area

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String
>>>

PUT /areas/:id
Edit an area

Supported Formats

json, xml

Examples

curl -X PUT "https://www.hoshinplan.com/areas/32423?app_key=<APP_KEY>&timestamp=<TIMESTAMP>&signature=<SIGNATURE>" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
  "description": "The new description"
}'

Params

Param name Description
name
optional

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String

Respuesta

Code: 200

Description:

The updated area

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 area belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this area belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this area

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String
>>>

DELETE /areas/:id
Delete an area

Examples

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

Respuesta

Code: 204

Description:

No Content

Param name Description
>>>

GET /areas/:id
Get an area

Examples

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


Response:
{
    "id": 31234,
    "name": "My area",
    "description": "",
    "created_at": "2021-01-28T18:28:23.492Z",
    "updated_at": "2021-01-29T09:21:33.533Z",
    "hoshin_id": 1234,
    "position": 1,
    "company_id": 2345234,
    "color": "#DAF3F8",
    "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
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 area belongs to

Validations:

  • Must be a number.
company_id
optional

The id of the company this area belongs to

Validations:

  • Must be a number.
position
optional

Used to sort the areas in the hoshin view

Validations:

  • Must be a number.
creator_id
optional

The id of the user that created this area

Validations:

  • Must be a number.
color
optional

The color of the postits for this area in the kanban view

Validations:

  • Must be a String