Search OKRs

  • Add this link ↓ to search field at the left corner.

    • amoeboids-upraise/1.0/okr/search

  • Enter inputs and click on 'send' to request data.

 

Once you click on send, System returns you the data shown as below.



Request  parameters

Parent

Parameters

Type

Description

Possible values



objectiveCycleIds

Number

Objective cycle id

1, 2, 3, 4, etc



owner

String

Objective owner's user name 

Objective owner's user name



statuses

Number

Objective status id in UpRaise

Below are the possible objective status ids associated with UpRaise objective statuses - 

0- READY 
1- IN_PROGRESS 
2- SCHEDULED
3- CLOSED 
4- ABANDONED 
5- READY_FOR_GRADING 
6- CARRIED_FORWARD 
7- READY_TO_CLOSE 



dueFromDate

String

Any date to specify objective due date range. 

31/October/2019 (DD/MM/YYYY)



dueToDate

String

Any date to specify objective due date range

31/October/2019 (DD/MM/YYYY)



labels

String

Any objective label/s names from UpRaise

Labels names can be different in every UpRaise instance, below mentioned are a few examples - 

  • Teamwork

  • Strategy

  • Skill improvements



objectiveLevels

String

Objective levels in Upraise

  • Company

  • Team

  • Individual

  • Above are the default objective level display names, UpRaise admins can add their own display names in their Upraise instances. 



teamLevels

String

Team types in UpRaise

1, 2, 3, 4, etc



teamIds

String

Team id

1, 2, 3, 4, etc



sortBy

String

This is to sort objective with different request parameters

  • title

  • owner

  • progress_percent

  • team

  • due_date

  • start_date

  • created_date

  • modified_date

  • created_by

  • modified_by

  • status(default if not provided)



sortOrder

String

This is to request what should be the order of objectives in response. You can add below request parameters-

  • ASC

  • DESC





startAt

Number

To get paginated result 

0, 20, 40, etc



maxResults

Number

Maximum number of results to be displayed on one page. Default max results are 20. 

5,10,20, etc



Response parameters

Parent

Parametere

Type

Description

Possible values



objectiveCycleIds

Number

This returns all objectives from the objective cycle associated with objective cycle id added in the request

This API returns data of all objectives within given objective cycle. The response is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



owner

String

This returns all objectives owned by the given user

This API returns data of all objectives owned by given user. In the response, you'd get all data points related to objectives owned by the given user, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



statuses

Number

This returns all objectives from the given status. 

This API returns data of all objectives in given objective status. In the response, you'll get all data points related to objectives with the given objective status, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



dueFromDate

String

This returns all objectives those are due from given date

This API returns all objectives that are due from given date. In the response, you'll get all data points related to objectives that are due from given date, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



labels

String

This returns all objectives that are associated with requested label/s

This API returns all objectives that are associated with requested label/s. In the response, you'll get all data points related to objectives that are associated with requested label/s, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



objectiveLevels



This returns all objectives that are associated with requested objective level/s

This API returns all objectives that are associated with requested objective level/s. In the response, you'll get all data points related to objectives that are associated with requested objective level/s, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



teamLevels



This returns all objectives that are associated with requested team level/s or type/s

This API returns all objectives that are associated with requested team level/s or type/s. In the response, you'll get all data points related to objectives that are associated with team level/s or type/s, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



teamIds



This returns all team objectives that are associated with requested team id/s

This API returns all team objectives that are associated with requested team id/s. In the response, you'll get all data points related to team objectives that are associated with team id/s, which is similar to what we get in get objectives API. Please refer this document to see an example of one objective in Get objective details



sortBy



This returns all objectives sorted alphabetically





sortOrder



This returns all objectives sorted in ascending or descending order





startAt



Use this parameter to define starting index for the search results





maxResults



Use this parameter to define max results on each page