Get /relocation/onboarding/plan
Query service instances
Request
URI
GET
https://{api_host}/relocation/onboarding/plan
COPY
Query Parameters
boolean
$expand
Optional
Expand document contents
string
$filter
Optional
OData filter expression
string
$select
Optional
Comma-separated list of fields to populate in query result
integer
$limit
Optional
Set maximum number of documents to return in this query
$limit example
10
string
$tenantLinks
Optional
Comma-separated list
Responses
200
Success
Returns ServiceDocumentQueryResult of type(s) application/json
{
"continuousResults": {
"documentCountAdded": 0,
"documentCountDeleted": 0,
"documentCountUpdated": 0
},
"documentCount": 0,
"documentLinks": [
"string"
],
"nextPageLink": "string",
"prevPageLink": "string",
"queryTimeMicros": 0,
"selectedLinks": [
"string"
]
}
integer As int64 As int64
documentCount
Optional
documentCount
array of string
documentLinks
Optional
documentLinks
object
documents
Optional
documents
string
nextPageLink
Optional
nextPageLink
object
nextPageLinksPerGroup
Optional
nextPageLinksPerGroup
string
prevPageLink
Optional
prevPageLink
integer As int64 As int64
queryTimeMicros
Optional
queryTimeMicros
object
selectedDocuments
Optional
selectedDocuments
array of string
selectedLinks
Optional
selectedLinks
object
selectedLinksPerDocument
Optional
selectedLinksPerDocument