Skip to main content

Upload Coverage

Invoke a coverage refresh for a particular review definition or review result. This is equivalent to the coverage upload functionality when editing a review definition or review result that the UI supports today.

POST https://instance.securid.com/aveksa/command.submit?cmd=uploadCoverage

Request

Parameters

uploadCoverage
format

properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.

json - Useful format for parsing into javascript or other languages. See www.json.org for details.

The name of the review result or review definition. The name parameter is mutually exclusive with the id parameter.
The id of the review result or review definition. The id parameter is mutually exclusive with the name parameter.
Indicates the type of coverage file. Valid values :
  • monitor
  • reviewer
  • altmanager
altManagerResolvesTo The user attribute used to resolve entries in the alternate managers file.
filename

The filename in the import directory on the G&L server. The import directory is specified on the web services configuration page. Alternatively, the data can be sent as part of the request body.

This option is not recommended and file should be passed using the POST body

Headers

Bearer token
Acceptapplication/json
Content-Typeapplication/json

Body

Base64 encoded PNG image.

Response

Parameters

typeExecuted command name
statussuccess, failure
messageOptional message to return along with the status.

Examples

Request

curl -L -X POST "https://instance.securid.com/aveksa/command.submit?cmd=uploadCoverage&id=1" \
"&type=monitor" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token>" \
-d "user_id='lbelkin'|user|1=1|app-role|name='Datadog'|
user_id='mcastro'|user|1=1|ent|name='Dynatrace'|"

Response

{
"data": {
"type": "uploadCoverage",
"status": "success"
}
}