Handle Get 8

Handle Get 8

Query for onboarding plan executions in the current organization

Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/relocation/api/wo/execute-plan
COPY
Query Parameters
boolean
$expand
Optional

Expand document contents

Default value : false

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

Example : 10

string
$tenantLinks
Optional

Comma-separated list

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns ServiceDocumentQueryResult of type(s) application/json 
{
    "documentCount": 0,
    "documentLinks": [
        "string"
    ],
    "documents": {
        "documents": {}
    },
    "nextPageLink": "string",
    "nextPageLinksPerGroup": {
        "nextPageLinksPerGroup": "string"
    },
    "prevPageLink": "string",
    "selectedDocuments": {
        "selectedDocuments": {}
    },
    "selectedLinks": [
        "string"
    ],
    "selectedLinksPerDocument": {
        "selectedLinksPerDocument": {
            "selectedLinksPerDocument": "string"
        }
    },
    "queryTimeMicros": 0
}
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

object
selectedDocuments
Optional

selectedDocuments

array of string
selectedLinks
Optional

selectedLinks

object
selectedLinksPerDocument
Optional

selectedLinksPerDocument

integer As int64 As int64
queryTimeMicros
Optional

queryTimeMicros


401

Unauthorized

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/relocation/api/wo/execute-plan
On This Page
Onboarding Plan Execution Operations
GET
Handle Get 8
POST
Handle Create 4
GET
Handle Get 7
DELETE
Handle Delete 4