...
Code Block |
---|
{ "asyncProcessStatus": { "uuid": "36466e69-bda1-43d3-9962-6f3a341720b9", "requestToken": "1231620fd0f8940c4bd03a866ef12cacd1599886073438", "contextId": "244934", "contectType": "DOMAIN", "processType": "DOMAIN_VULNERABILITIES", "userEmail": "adam.smith@whitesourcesoftware.com", "messageContentSha1": "b480c892e59a2f05954ce727bd3f2a4e882f9e13", "status": "PENDING", "created": "2022-4-15 11:45:20", "modified": "2022-4-15 11:45:20", } } |
The status of the requested report is checked using the getAsyncProcessStatus. The {{status}} parameter will contain one of these four values:
PENDING
IN_PROGRESS
FAILED
SUCCESS
...
Code Block |
---|
{ "asyncProcessStatus": { "uuid": "36466e69-bda1-43d3-9962-6f3a341720b9", "requestToken": "1231620fd0f8940c4bd03a866ef12cacd1599886073438", "contextId": "244934", "contectType": "DOMAIN", "processType": "DOMAIN_VULNERABILITIES", "userEmail": "adam.smith@whitesourcesoftware.com", "messageContentSha1": "b480c892e59a2f05954ce727bd3f2a4e882f9e13", "status": "SUCCESS", "created": "2022-4-15 11:45:20", "modified": "2022-4-15 11:45:20", } } |
Once SUCCESS is returned by getAsyncProcessStatusthe status of the report returns SUCCESS, the report is ready for download using the downloadAsyncReport API.
downloadAsyncReport
Parameter | Description | Type | Required |
requestType | downloadAsyncReport | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
reportStatusUUID | The UUID returned in the response from one of the “GenerateXXReportAsync” APIs | string | Yes |
...