Update entity rank position

Updates the display order (rank) of a task, request, or program by repositioning it relative to another item.
The rank determines the default sort order when viewing items in lists. This endpoint uses a lexicographic
ranking system that efficiently handles reordering without requiring updates to all other items in the list.

Key Features:

  • Reorder tasks, requests, or programs within their parent container or list view
  • Position items before the first item or after any specific item using nodeIdAfter
  • Uses efficient lexicographic ranking that doesn't require updating all items
  • Updates are immediately reflected in list views sorted by rank
  • Maintains rank consistency across all users viewing the same space

Authorization Logic:

  1. User must have a valid JWT token with management scopes
  2. Token must be valid for this operation (tenant tokens are not supported)
  3. User must have permission to update the entity being reordered

Usage Example:
Drag and drop a task to reorder it in a task list, move a program to prioritize it in the program view,
or reposition a request to organize workflow priorities.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

Body Params

Request body containing the rank and position data to update how a program, task, or request is ordered within its container. Includes numeric rank value for determining sort order and position information for list placement. The rank value determines the entity's position relative to other entities when sorted by rank—lower rank values appear first. Supports both absolute rank assignment and relative positioning. Must conform to RankItemPutRequest schema with valid rank and position properties. Used for manual reordering, priority sequencing, and custom sort arrangements in lists and hierarchies.

string

Unique identifier of the entity (program, task, or request) to reposition, represented as a stable base64url-encoded string (e.g., 'xH75yTE6xmz6MUvcTDxIRi'). This is the persistent ID of the item being moved, as returned from GET list endpoints such as /programs, /tasks, or /requests. The entity must exist in the specified space and the user must have permission to modify its rank. Required field that identifies which item's position is being changed in the ordered list. Use to specify the target entity for rank updates and position adjustments.

string | null

Unique identifier of the entity that the moved item should be positioned immediately after in the ordered list, represented as a stable base64url-encoded string (e.g., 'yT97zSH8tnz8OWxeVFzKTj'). When provided, the moved entity will be placed directly after this reference entity and its rank will be calculated accordingly. Optional field (nullable) that enables relative positioning—set to a valid entity ID to position after that entity, or set to null to move the item to the first position (rank 0 or lowest available rank). The reference entity must exist in the same space and container as the entity being moved. Use for intuitive drag-and-drop style reordering where position is specified relative to existing items.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json