Skip to content
Omniglass Omniglass Omniglass

Exchange two occupants' positions within a role

POST
/systems/{name}/roles/{role}:swapPositions
 
curl --request POST \
  --url https://example.com/api/v1/systems/example/roles/example:swapPositions \
  --header 'Content-Type: application/json' \
  --data '{ "position": 1, "with": 1 }'

Exchanges the positions of whichever components currently hold position and with within this role: an ordering change only, it does not affect who is assigned or the system’s health. Either position missing an occupant is a 404. Gated by system:update; read and update scopes drive the 404 versus 403 split.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

string

The system’s name, or a dotted address (e.g. boi.17c.$sys.av)

role
required

The role name

string

The role name

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
position
required

One of the two positions to exchange

integer format: int64
>= 1
with
required

The other position to exchange with

integer format: int64
>= 1

Responses

Section titled “ Responses ”

204

Section titled “204 ”

No Content

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}