Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

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 

ParentParametersTypeDescriptionPossible values

dateTimeFormatString
  • Format definition of dateTime fields returned in response.


dateFormatDate
  • Format definition of date fields returned in response.


cyclesObject

This object consists of details about each one of the cycles that are available in current UpRaise instance.


cyclesididObjective cycle id in UpRaise.1, 101, 12001 etc
cyclestitleStringUser facing objective cycle name.Q4 2020, Default objective cycle etc
cyclesdurationStringDuration of the cycle.
  • Monthly
  • Quarterly
  • Annual
  • Custom
cyclesstartDateDateObjective cycle start date.Will be returned in the format presented by dateFormat.
cyclesendDateDateObjective cycle end date.Will be returned in the format presented by dateFormat.
cyclesstatusObjectThis object consists of details about each cycle's status.
  • Id
  • Status
statusidNumberObjective cycle status id in UpRaise.
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
statusnameStringUser facing name of the objective cycle status.
  • Ready for grading
  • Active
  • Scheduled
  • Closed
  • Archived
  • Ready to close
cyclespermissionsObjectThis object consists of details about each cycle's permissions configuration.
  • Type
  • Values
permissionstypeStringThis 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
permissionsvaluesStringThis represents actual permission value for each of corresponding types.
cyclesgradingSettingsObjectThis object consists of details about each cycle's grading settings.
  • Type
  • Values
gradingSettingstypeStringType of grading setting for the given objective cycle.
  • Opinion scale
  • Radio buttons
  • None
gradingSettingsvaluesStringGrading setting value based on its type.
  • Not achieved, Achieved, size:10
  • Not achieved, Partially achieved, Achieved, size:3
cyclescreatedDateDate on which current objective cyle was created in UpRaise.08/Jan/18 8:36 PM
cyclescreatedByObjectObject
  • email address
  • display name
  • user key
  • etc
cyclesmodifiedDateDate on which current objective cyle was last modified in UpRaise.08/Jan/18 8:36 PM
cyclesmodifiedByObjectObject
  • email address
  • display name
  • user key
  • etc
  • No labels