Get process variants

Get the variants defined for all Document Generators in the specified process. Variants will be retrieved for the latest versions of all Document Generators.

PATH PARAMETERS

KeyTypeDescription
teamsiteIdstringTeamSite ID
batchIdstringBatch Process ID

QUERY PARAMETERS

KeyTypeDescription
limitintLimit the return the specified number of results
offsetintSkip ahead in the return set by the offset value
orderBystringOrder the results by the specified property value
countOnlyboolReturn the result count instead of the result array
detailsboolInclude an array Document Generators for each process returned. This is a potentially long running process and should be restricted to small data sets
filterstringFilter the result set to those with matching property values
adhoc.filterstringFilter the result set to those with matching adhoc variables and values
Path Params
string
required
string
required
Query Params
string
Defaults to 10

Limit the return the specified number of results

string
Defaults to 10

Skip ahead in the return set by the offset value

string
Defaults to name

Order the results by the specified property value

boolean
Defaults to false

Return the result count instead of the result array

boolean
Defaults to false

Return the content property and adhoc arrays with the response

string
Defaults to name=variant1

Filter the result set to those with matching property values

string
Defaults to adhoc.account=1

Filter the result set to those with matching adhoc variables and values

Response

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json