Move policy assignment within ranks

Relative path: /v2/policy-assignments/{assignmentUuid}:updateRanking

Request body

Display Schema instead of an Example or vice-versa

Type	Required	Example	Schema
application/json	No	{ "rank": 0 }	{ "$ref": "PolicyAssignmentsUpdatePolicyAssignmentRankingBody", "rank": { "type": "integer", "description": "New ranking of the policy assignment. Cannot be 0, otherwise 400 BAD REQUEST is thrown. If the ranking is set to that of already existing assignment, all the rankings are shifted to keep the mutual priorities. If the ranking is set to impossible value, the closest possible value is assigned and the lower ranks are shifted. After successful update all the other assignments are reordered with given policy being ranked as desired.", "format": "int64" } }

Type

Required

Example

Schema

application/json

{
  "rank": 0
}

{
  "$ref": "PolicyAssignmentsUpdatePolicyAssignmentRankingBody",
  "rank": {
    "type": "integer",
    "description": "New ranking of the policy assignment. Cannot be 0, otherwise 400 BAD REQUEST is thrown. If the ranking is set to that of already existing assignment, all the rankings are shifted to keep the mutual priorities. If the ranking is set to impossible value, the closest possible value is assigned and the lower ranks are shifted. After successful update all the other assignments are reordered with given policy being ranked as desired.",
    "format": "int64"
  }
}

Parameters in path

Name	Type	Required	Description
assignmentUuid	string	Yes	type: PolicyAssignment

Responses

Display Schema instead of an Example or vice-versa

Code	Description	Example	Schema
200	Successful response.	{}	{ "$ref": "v2UpdatePolicyAssignmentRankingResponse", "title": "empty", "type": "object" }
202	Response took too long; request cached. Response can be retrieved later using the response-id header.	null	[]
400	One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.	null	[]
401	Token has expired or is invalid.	null	[]
403	Access denied. Check permissions.	null	[]
404	Requested resource not found.	null	[]
429	Rate limit reached. Try again later.	null	[]
500	Internal server failure. Try again later.	null	[]
502	Internal server failure. Try again later.	null	[]
503	Environment under maintenance. Try again later.	null	[]
504	Action took too long; timeout reached	null	[]

˄˅