Api referenceWorkspaces
Get Discovery Profile
Reference for Get Discovery Profile in the Hyperoru v1 API, including request, response, and authentication details.
GET
/v1/workspaces/{workspace_id}/discoveryGet Discovery Profile. Returns a typed response and a request ID for operational support.
hyperoru_session<token>
Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.
In: cookie
Path Parameters
workspace_id*Workspace Id
Format
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/discovery"{
"completed_required_fields": 0,
"completion_percent": 0,
"contradictions": [
{
"created_at": "2019-08-24T14:15:22Z",
"field_key": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"left_revision_id": "fccb5dbc-bd51-445f-b092-2973a248c859",
"rationale": "string",
"resolved_at": "2019-08-24T14:15:22Z",
"resolved_by": "d0d57369-b08b-4db8-8952-8cdeedd9aebc",
"resolved_revision_id": "935a0c3a-5631-442d-aafb-19f8c751f8e2",
"right_revision_id": "99bff235-325f-4923-ade9-e0e32a946188",
"state": "string"
}
],
"dependencies": [
{
"crosses_trust_boundary": true,
"data_classification": "string",
"evidence_ids": [
"string"
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"relationship_kind": "string",
"source_group_id": "58d74375-43ee-4b76-86bc-674c69391672",
"state": "string",
"target_group_id": "efc47beb-e46d-465e-921d-3e02578ccf22"
}
],
"field_definitions": [
{
"category": "string",
"description": "string",
"high_impact": true,
"key": "string",
"label": "string",
"required": true,
"sensitive": true
}
],
"fields": [
{
"category": "string",
"confidence": "string",
"confirmation_state": "string",
"confirmed_at": "2019-08-24T14:15:22Z",
"confirmed_by": "41d52211-974d-4c1a-a696-959dc97cc570",
"created_at": "2019-08-24T14:15:22Z",
"evidence_ids": [
"string"
],
"field_key": "string",
"high_impact": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"observed_at": "2019-08-24T14:15:22Z",
"redacted": false,
"sensitive": true,
"source_kind": "string",
"source_ref": "string",
"supersedes_revision_id": "85575177-1836-4298-a833-e871ebd8a168",
"value": null,
"version": 0
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"published_snapshot_id": "3d89f9c6-07df-4ea0-bf20-ce2d5a657882",
"questions": [
{
"category": "string",
"deferred_until": "2019-08-24T14:15:22Z",
"field_key": "string",
"generated_from": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"priority": 0,
"prompt": "string",
"question_key": "string",
"state": "string",
"why_asked": "string"
}
],
"registered_sources": [
{
"display_name": "string",
"freshness_seconds": 0,
"group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_observed_at": "2019-08-24T14:15:22Z",
"metadata_json": {},
"owner_label": "string",
"source_kind": "string",
"source_ref": "string",
"status": "string"
}
],
"required_field_count": 0,
"source_groups": [
{
"created_at": "2019-08-24T14:15:22Z",
"criticality": "string",
"description": "string",
"group_key": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"owner_label": "string",
"status": "string",
"trust_boundary": "string",
"updated_at": "2019-08-24T14:15:22Z",
"version": 0
}
],
"status": "string",
"suggestions": [
{
"decided_at": "2019-08-24T14:15:22Z",
"decided_by": "4accc021-c0cc-4c2c-8a78-605a0ed6da31",
"decision_reason": "string",
"evidence_ids": [
"string"
],
"evidence_revision": "string",
"fingerprint": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"proposed_json": {},
"rationale": "string",
"source_group_id": "58d74375-43ee-4b76-86bc-674c69391672",
"state": "string",
"suggestion_kind": "string",
"target_group_id": "efc47beb-e46d-465e-921d-3e02578ccf22"
}
],
"version": 0
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}