Skip to main content

Deactivate document or record

Motivation

Deactivate CDoc/WDoc/CRecord/WRecord using API

Functional Design

DELETE /api/v2/apps/{owner}/{app}/workspaces/{wsid}/docs/{pkg}.{table}/{id}

Headers

KeyValue
AuthorizationBearer {PrincipalToken}

Parameters

ParameterTypeDescription
ownerstringname of a user who owns the application
appstringname of an application
wsidint64the ID of workspace
pkg, tablestringidentifies a table (document or record)
idint64ID of a document or record

Result

CodeDescriptionBody
200OKcurrent WLog offset, see example below
401Unauthorizederror object
403Forbiddenerror object
404Table Not Founderror object
405Method Not Allowed, table is an ODoc/ORecorderror object

Example Result 200:

{
"currentWLogOffset":114,
}