Reference Guide

SupportAssist Enterprise
48 REST API Guide – SupportAssist Enterprise
Parameter
Description
Additional Details
caseId
The support request number provided by
the Dell EMC Technical support agent.
This parameter is optional.
uploadRequired
Defines whether SupportAssist Enterprise
should upload the collection after it is
complete. The possible values are “true”
or “false”.
This parameter is optional for a
single device collection.
emailId
Email address of the Dell EMC Technical
support agent.
This parameter is optional for a
single device collection.
purpose
Reason for the collection. The possible
values for purpose are:
• Technical Support
• Deployment
• System Maintenance
• Consulting
This parameter is mandatory for
multiple device collections.
projectId
Deployment project identifier.
This parameter is optional.
The following resource URI is used to collect system information:
https://<BASE_URI>/ SupportAssist /api/v1/Collections/Invoke
Method: POST
Headers:
Content-Type: application/json
Authorization: Bearer <Authentication_Token>
Request body:
{
"devices": [
{"id": "<device_id>"},
{"id": "<device_id>"}
],
"collectionName": "provided name of collection",
"caseId": "casenumber",
"uploadRequired": true,
"emailId": "[e-mail]",
"purpose":"Techsupport",
"projectId": "project_id"
}
Response format (Accepted – response code 202):
{
"operationId": "<operation_id>",
"operationType": "RunDiagnostics",
"status": "QUEUED",
"additionalInfo": null
}