Reference Guide

SupportAssist Enterprise
47 REST API Guide – SupportAssist Enterprise
2.9 Collection
A collection contains the system information collected by SupportAssist Enterprise from a device. The collection is
used by Technical Support to troubleshoot and provide a resolution to issues. You can perform a single or
multiple device collection.
Note: To collect system information from multiple devices, the purpose parameter is mandatory
The following is the JSON schema for performing a single or multiple device collection.
{
"type":"object",
"id":"CollectionInput",
"properties":{
"devices":{
"type":"array",
"items":{
"type":"object",
"id":"Device",
"properties":{
"id":{
"type":"string"
}
}
}
},
"collectionName":{
"type":"string"
},
"caseId":{
"type":"string"
},
"uploadRequired":{
"type":"boolean"
},
"emailId":{
"type":"string"
},
"purpose":{
"type":"string"
"enum":["Technical Support","Deployment","System
Maintenance","Consulting"]
},
"projectId":{
"type":"string"
}
}
}
Parameters required for collecting system information
Parameter
Description
Additional Details
devices
A collection of devices; only the id property
is consumed in this object.
This parameter is required.
collectionName
A name that you want to assign to the
collection.
This parameter is optional.