v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Workpapers

Get Workpaper Control Details

Use this API to retrieve the control details of a specific workpaper.

Note: Things to Know

Workpaper attributes can be retrieved using the Get Workpaper Results API.

get/api/audit-management/v1/audit-workpapers/{workpaperId}/control-details

Path parameters

workpaperIdstring uuid required

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

Workpaper identifier (UUID)

Response

workpaperIdstring uuid

Workpaper identifier

numberinteger

Workpaper Number

auditIdstring uuid

Audit Identifier

auditNamestring

Audit Name

Example response

{
  "workpaperId": "123e4567-e89b-12d3-a456-426614174000",
  "number": 12345,
  "auditId": "123e4567-e89b-12d3-a456-426614174001",
  "auditName": "Annual Security Audit",
  "stage": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "In Progress",
    "nameKey": "workflow.stage.in_progress"
  },
  "workflow": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "In Progress",
    "nameKey": "workflow.stage.in_progress"
  },
  "controlDetail": {
    "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "identifier": "A.5.1.1",
    "name": "Control Name",
    "description": "Test Controls for Privacy",
    "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "orgGroupName": "ABC Corp",
    "frameworkId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "frameworkName": "ISO/IEC 27017",
    "frameworkNameKey": "framework.key.iso",
    "categoryId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
    "categoryName": "Privacy",
    "categoryNameKey": "ControlName",
    "seedControlId": "123e4567-e89b-12d3-a456-426614174000",
    "otControlIdentifier": "123e4567-e89b-12d3-a456-426614174001",
    "status": "Active",
    "implementationGuidance": "Implementation guidance of the control requirement.",
    "contentVersion": "1.0"
  }
}