v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Evidence Task Implementations

Get Evidence Task Implementation

Use this API to retrieve a single evidence implementation by its unique identifier.

get/api/controls/v1/evidence-task-implementations/{evidenceTaskImplementationId}

Path parameters

evidenceTaskImplementationIdstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

The unique identifier (UUID) of the evidence task implementation.

Response

idstring uuid

GUID of Evidence Implementation.

numberinteger required

Numeric identifier for Evidence Implementation.

primaryEntityNamestring

Entity Details of the primary implementor.

evidenceTaskIdstring uuid

Master evidence task id.

namestring

Name of the evidence task.

descriptionstring

Description of the evidence task.

guidancestring

Guidance of the evidence task.

Entity Details of the primary implementor.

collectionStartDatestring date

Start of the collection.

lastCollectedstring date

Last evidence collected date.

currentIntervalStatus'NotCollected' | 'Collected' | 'OverDue' | 'InProgress'

Current interval status.

currentIntervalEndDatestring date

Current interval end date.

relatedControlsinteger

Number of related controls.

relatedinteger

Number of related entities.

canSplitboolean

Flag to indicate if evidence can be split.

evidenceTaskType'SYSTEM' | 'CUSTOM'

Evidence task type.

createdBystring uuid

The user or operation the control was created by.

createdDatestring date-time

The date the control implementation was created.

lastModifiedBystring uuid

The user or process the control was last modified by (GUID).

lastModifiedDatestring date-time

The date the control was last modified.

collectedEvidenceCountinteger

The count for collected evidences.

automaticCollection'CONFIGURED' | 'AVAILABLE' | 'NOT_AVAILABLE'

Status of the automatic collection configuration.

deleteTypestring

Evidence task implementation delete type.

duplicateboolean

If similar implementation is present from same master evidence for given control implementation.

dueDateOffsetinteger

Offset for the due date in days.

collectionStartMonthstring

Start month of the collection.

suggestedSystemAvailableboolean

Example response

{
  "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "number": 123,
  "orgGroup": {
    "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "name": "Entity Name"
  },
  "primaryEntity": {
    "id": "1ab2fff0-cb80-b560-99a1-4a3b527f61f5",
    "name": "Asset 305",
    "type": "Risks",
    "evidenceEntityType": {
      "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "label": "Assets",
      "translationKey": "Assets",
      "moduleName": "DataMapping",
      "seeded": true
    },
    "orgGroupId": "1ab2fff0-cb80-b560-99a1-4a3b527f61f5",
    "controlEntityType": {
      "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "label": "Assets",
      "translationKey": "Assets",
      "moduleName": "DataMapping",
      "seeded": true
    }
  },
  "primaryEntityName": "Asset124",
  "evidenceTaskId": "123e4567-e89b-12d3-a456-426614174123",
  "name": "Security Updates",
  "description": "i) Provide evidence to confirm that periodic security updates are published and communicated to employees and contractors.",
  "guidance": "For internal users, the security updates communication can be demonstrated by making these policies available to them through the corporate intranet.",
  "collectionInterval": "MONTHLY",
  "collectionStartDate": "2020-11-05",
  "lastCollected": "2020-11-10",
  "currentIntervalStatus": "InProgress",
  "currentIntervalEndDate": "2020-11-30",
  "assignee": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Entity Name",
      "nameKey": "EntityName"
    }
  ],
  "approver": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Entity Name",
      "nameKey": "EntityName"
    }
  ],
  "relatedControls": 2,
  "related": 2,
  "canSplit": true,
  "evidenceTaskType": "SYSTEM",
  "createdBy": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
  "createdDate": "2020-11-05T22:01:21.200+00:00",
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174001",
  "lastModifiedDate": "2020-11-05T22:01:21.200+00:0",
  "collectedEvidenceCount": 1,
  "automaticCollection": "AVAILABLE",
  "deleteType": "SOFT",
  "dueDateOffset": 5,
  "collectionStartMonth": "January"
}