Fetch Mobility Groups Top Level Summary
Fetch mobility groups top level summary
Fetch mobility groups top level summary
Request
URI
POST
https://{server}/hybridity/api/v2/mobility-groups/query
COPY
Request Body
Mobility Group Query Object
mobilityGroupsV2DefaultRequest
of type(s)
application/json
Required
{
"pageParameters": {
"pageSize": 0,
"pageNumber": 0
},
"filter": {
"pairingId": "string",
"mobilityGroupName": "string",
"sourceId": [
"string"
],
"destinationId": [
"string"
],
"mobilityGroupId": [
"string"
],
"migrationWaveId": [
"string"
],
"migrationWaveName": "string",
"mobilityGroupState": [
"string"
],
"configurationStatus": [
"string"
],
"vmName": "string",
"migrationId": [
"string"
],
"archiveScope": "string",
"includePermissions": false
}
}
object
pageParameters
Optional
pageParameters
object
filter
Optional
filter
Authentication
This operation uses the following authentication methods.
Responses
200
OK
Returns
mobilityGroupsV2DefaultResponse
of type(s)
application/json
{
"items": [
{
"info": {
"id": "string",
"migrationWaveId": "string",
"migrationWaveName": "string",
"name": "string",
"pairingId": "string",
"servicemeshId": "string",
"createdTimestamp": "string",
"lastUpdatedTimestamp": "string",
"migrationStartTimestamp": "string",
"username": "string"
},
"summary": {
"state": "string",
"configurationStatus": "string",
"isArchived": false
}
}
],
"pageParameters": {
"pageSize": 0,
"pageNumber": 0,
"totalPages": 0,
"totalElements": 0
},
"errors": [
{
"code": "string",
"message": "string"
}
]
}
array of
object
items
Optional
items
object
pageParameters
Optional
pageParameters
array of
object
errors
Optional
errors
400
Bad Request
Operation doesn't return any data structure
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
500
Internal Server Error
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/hybridity/api/v2/mobility-groups/query