Get objective cycles
Use below endpoint to get all the objective cycles.
Syntax - <Jira base URL>/rest/amoeboids-upraise/1.0/okr/objective-cycle
Example - jira.amoeboids.com/rest/amoeboids-upraise/1.0/okr/objective-cycle
This API returns data about all objective cycles within the instance.
Request
No inputs are expected as part of this request.
Response
Parent | Parameters | Type | Description | Possible values |
---|---|---|---|---|
dateTimeFormat | String |
| ||
dateFormat | Date |
| ||
cycles | Object | This object consists of details about each one of the cycles that are available in current UpRaise instance. | ||
cycles | id | id | Objective cycle id in UpRaise. | 1, 101, 12001 etc |
cycles | title | String | User facing objective cycle name. | Q4 2020, Default objective cycle etc |
cycles | duration | String | Duration of the cycle. |
|
cycles | startDate | Date | Objective cycle start date. | Will be returned in the format presented by dateFormat. |
cycles | endDate | Date | Objective cycle end date. | Will be returned in the format presented by dateFormat. |
cycles | status | Object | This object consists of details about each cycle's status. |
|
status | id | Number | Objective cycle status id in UpRaise. |
|
status | name | String | User facing name of the objective cycle status. |
|
cycles | permissions | Object | This object consists of details about each cycle's permissions configuration. |
|
permissions | type | String | This represents what kind of permission is being referred. |
|
permissions | values | String | This represents actual permission value for each of corresponding types. | |
cycles | gradingSettings | Object | This object consists of details about each cycle's grading settings. |
|
gradingSettings | type | String | Type of grading setting for the given objective cycle. |
|
gradingSettings | values | String | Grading setting value based on its type. |
|
cycles | created | Date | Date on which current objective cyle was created in UpRaise. | 08/Jan/18 8:36 PM |
cycles | createdBy | Object | Object |
|
cycles | modified | Date | Date on which current objective cyle was last modified in UpRaise. | 08/Jan/18 8:36 PM |
cycles | modifiedBy | Object | Object |
|
On this page
In this section
- Get objective details
- Get objective grades
- Get KR grades (metric & to do)
- Get KR grades (Jira issue & Jira issue via JQL)
- Get objective cycles
- Get KR details
- KR punch in
- Objective punch in
- Retrieve comments, their timestamps & creators from key result
- Retrieve comments, their timestamps & creators from objectives
- Search OKRs
Past versions