Archive flag behavior in the API

When posting or updating documents by using the Document Management APIs, the archive field is optional. If the request does not include the archive field, the system sets the value to false. This default behavior ensures that existing integrations continue to function without modification.

To retrieve archived documents, use the GET /api/v1/rpa/exception/usecasetypes/{id}/documents endpoint with the query parameter archive=true. To retrieve non-archived documents, set archive=false. If the archive parameter is not specified, the response includes all documents regardless of archive status.

The following example lists how to archive a document by using the API:

PATCH /api/v1/rpa/exception/documents/{docId}

Content-Type: application/json

{

"reprocess": false,

"visibility": false,

"archive": true

}