Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Workpapers

Update Workpaper

Use this API to update the attributes of a specific workpaper.

Note: Things to Know

put/api/audit-management/v1/audit-workpapers/{workpaperId}

Path parameters

workpaperIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Workpaper identifier (UUID)

Request body

testingResultstring

Workpaper testing result

samplingResultstring

Workpaper sampling result

interviewResultstring

Workpaper interview result

namestring

Workpaper Name

attributesobject

Custom Attributes

Example request

{
  "testingResult": "Control is operating effectively",
  "samplingResult": "Sample of 25 records reviewed",
  "interviewResult": "Confirmed with security team",
  "name": "Updated Workpaper Name",
  "attributes": {
    "status": [
      {
        "value": "COMPLETED"
      }
    ]
  }
}

Response

OK

testingResultstring

Workpaper testing result

samplingResultstring

Workpaper sampling result

interviewResultstring

Workpaper interview result

attributesobject

Custom Attributes

Example response

{
  "testingResult": "Control is operating effectively as designed",
  "samplingResult": "Sample of 25 transactions were tested with no exceptions noted",
  "interviewResult": "Confirmed implementation with the security team",
  "auditors": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "John Doe"
    }
  ],
  "approvers": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "Jane Smith"
    }
  ],
  "entityDetail": {
    "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
    "name": "Emission Factor-1"
  },
  "attributes": {
    "status": [
      {
        "value": "Completed"
      }
    ],
    "priority": [
      {
        "value": "High"
      }
    ]
  }
}