Get objective cycles

Owned by Annu
Last updated: Oct 01, 2020
2 min read

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

  • Format definition of dateTime fields returned in response.





dateFormat

Date

  • Format definition of date fields returned in response.





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.

  • Monthly

  • Quarterly

  • Annual

  • Custom

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.

  • Id

  • Status

status

id

Number

Objective cycle status id in UpRaise.

  • 0

  • 1

  • 2

  • 3

  • 4

  • 5

status

name

String

User facing name of the objective cycle status.

  • Ready for grading

  • Active

  • Scheduled

  • Closed

  • Archived

  • Ready to close

cycles

permissions

Object

This object consists of details about each cycle's permissions configuration.

  • Type

  • Values

permissions

type

String

This represents what kind of permission is being referred.

  • Individual objectives can be added by

  • Individual objectives can be edited by

  • Team objectives can be added by

  • Team objectives can be edited by

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.

  • Type

  • Values

gradingSettings

type

String

Type of grading setting for the given objective cycle.

  • Opinion scale

  • Radio buttons

  • None

gradingSettings

values

String

Grading setting value based on its type.

  • Not achieved, Achieved, size:10

  • Not achieved, Partially achieved, Achieved, size:3

cycles

created

Date

Date on which current objective cyle was created in UpRaise.

08/Jan/18 8:36 PM

cycles

createdBy

Object

Object

  • email address

  • display name

  • user key

  • etc

cycles

modified

Date

Date on which current objective cyle was last modified in UpRaise.

08/Jan/18 8:36 PM

cycles

modifiedBy

Object

Object

  • email address

  • display name

  • user key

  • etc



On this page

In this section



Past versions