Sign in
latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

21de3aa0b170

Workpapers

Get List of Workpapers

Use this API to retrieve a list of all workpapers by key terms and filters. The response will include details for each workpaper along with the associated audit, findings, and attributes.

post/api/audit-management/v1/audit-workpapers/pages

Query parameters

pageinteger

Results page to be retrieved (0..N)

sizeinteger
Example:20

Number of records per page (1..50)

sort'number,asc' | 'number,desc' | 'name,asc' | 'name,desc'
Example:number,asc

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.

Request body

SearchCriteriaRequest required— unresolved $ref

Response

OK

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.

Example response

{
  "content": [
    {
      "workpaperId": "123e4567-e89b-12d3-a456-426614174000",
      "number": 1001,
      "auditId": "123e4567-e89b-12d3-a456-426614174001",
      "auditName": "Annual Security Compliance Audit",
      "scopeId": "123e4567-e89b-12d3-a456-426614174002",
      "orgGroup": {
        "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
        "name": "Emission Factor-1"
      },
      "entityType": "CONTROL",
      "entityDetail": {
        "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
        "name": "Emission Factor-1"
      },
      "auditors": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174005",
          "name": "John Doe"
        }
      ],
      "approvers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174006",
          "name": "Jane Smith"
        }
      ],
      "stage": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Security Entity",
        "nameKey": "workflow.stage.in_progress",
        "badgeColor": "blue"
      },
      "workflow": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "In Progress",
        "nameKey": "workflow.stage.in_progress"
      },
      "countOfFindings": 3,
      "attributes": {
        "priority": [
          {
            "value": "High"
          }
        ],
        "status": [
          {
            "value": "In Progress"
          }
        ]
      }
    }
  ],
  "first": true,
  "numberOfElements": 20,
  "pageable": {
    "offset": 3,
    "pageNumber": 3,
    "pageSize": 23,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true
    }
  },
  "sort": {
    "empty": true,
    "sorted": true
  },
  "totalPages": 5,
  "totalElements": 50,
  "size": 20
}