Cycles
Delivery cycles are used to organize objectives into time-bound groups. Delivery cycle is how we track performance and progress of your OKRs.
Attribute | Type | Description |
id | string | Unique delivery cycle identifier |
name | string | Name of the delivery cycle |
created_at | string | Time when the delivery cycle was created. RFC 3339 format. |
Example:
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "2019 Q1","created_at": "2018-02-20T12:32:56Z"}
postCreate Cycle
post
https://api.simpleokr.com/v1/cycles
Create a new Cycle object.
Request
Response
Request
Body Parameters
name
required
string
Name of the Cycle. E.g. 2019 Q1
Response
200: OK
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "2019 Q1","created_at": "2018-02-20T12:32:56Z"}
getList Cycles
get
https://api.simpleokr.com/v1/cycles
Retrieve a list of available Cycles.
Request
Response
Request
Query Parameters
page_token
optional
string
Page identifier.
Response
200: OK
{"next_page_token": null,"cycles": [{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "2019 Q1","created_at": "2018-02-20T12:32:56Z"},{...},{...}]}
getRetrieve Cycle
get
https://api.simpleokr.com/v1/cycles/:id
Retrieve details about an existing Cycle.
Request
Response
Request
Path Parameters
id
required
string
Cycle ID
Response
200: OK
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "2019 Q1","created_at": "2018-02-20T12:32:56Z"}
postUpdate Cycle
post
https://api.simpleokr.com/v1/cycles/:id
Update an existing Cycle object.
Request
Response
Request
Path Parameters
id
required
string
Cycle ID
Body Parameters
name
required
string
New Cycle name to be set
Response
200: OK
{"id": "16682617-f25d-4df2-9f51-3c38298996b8","name": "2019 Q1","created_at": "2018-02-20T12:32:56Z"}
deleteDelete Cycle
delete
https://api.simpleokr.com/v1/cycles/:id
Delete an existing Cycle object and all data associated with it.
Request
Response
Request
Path Parameters
id
required
string
Cycle ID
Response
200: OK
Last updated 2 years ago