Get dataset scan

Returns the status and results for a previously started dataset scan.

Request

path Parameters

scanId

required

string <uuid>

The identifier of the scan to get results for.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/datasets/scans/{scanId}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"started": "2019-08-24T14:15:22Z",
"completed": "2019-08-24T14:15:22Z",
"type": "Sam",
"status": "Pending",
"providerId": "4834bcdc-4a64-444d-966b-1a6fe381da24",
"facilityId": "d7244f5b-52c1-4d27-b4f5-43b1113fc304",
"provider": null,
"trigger": "Manual",
"options": {"parameterSetId": "4da0bbf1-9705-456b-b2bc-910c426536c6",
"referenceId": "8502eb05-558d-4480-8511-c1011710b340"
},
"failureReason": {"messageTemplate": "string",
"messageParams": {"property1": "string",
"property2": "string"
}
},
"statusDescription": null,
"parameters": [{"addressType": "Unspecified",
"addressLine": "string",
"addressLine2": "string",
"city": "string",
"state": "AL",
"zipCode": "string",
"type": "Name"
}
],
"matches": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"datasetTimestamp": "2019-08-24T14:15:22Z",
"recordTimestamp": "2019-08-24T14:15:22Z",
"data": {"positiveParameters": [{"addressType": "Unspecified",
"addressLine": "string",
"addressLine2": "string",
"city": "string",
"state": "AL",
"zipCode": "string",
"type": "Name"
}
],
"negativeParameters": [{"addressType": "Unspecified",
"addressLine": "string",
"addressLine2": "string",
"city": "string",
"state": "AL",
"zipCode": "string",
"type": "Name"
}
],
"record": null
},
"scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
"scan": { },
"userActionNeeded": true,
"isIgnored": true,
"matchScore": {"score": 0,
"recommendation": "Mismatch"
},
"userActionResolution": "Accept",
"userActionResolutionNote": "string",
"matchRelevance": "Low",
"createdTimestamp": "2019-08-24T14:15:22Z",
"obsoleteTimestamp": "2019-08-24T14:15:22Z"
}
],
"monitoringMetadata": {"monitoringInterval": "Monthly",
"lastMonitoringDate": "2019-08-24T14:15:22Z",
"nextMonitoringDate": "2019-08-24T14:15:22Z",
"monitorId": "075fef10-8522-4c43-ac39-f1796133943e"
},
"verifiedAt": "2019-08-24T14:15:22Z"
}