Create document or record

Motivation

Create a new CDoc, WDoc, CRecord or WRecord using API

Functional Design

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

Headers

Key
Value

Authorization

Bearer {PrincipalToken}

Content-Type

application/json

Parameters

Parameter
Type
Description

owner

string

name of a user who owns the application

app

string

name of an application

wsid

int64

the ID of workspace

pkg, table

string

identifies a table (document or record)

Body

JSON object: CDoc/WDoc/CRecord/WRecord

Result

Code
Description
Body

201

Created

current WLog offset and the new IDs, see below

400

Bad Request, e.g. Record requires sys.ParentID

401

Unauthorized

403

Forbidden

404

Table Not Found

405

Method Not Allowed, table is an ODoc/ORecord

Example result 201:

{
    "currentWLogOffset":114,
    "newIDs": {
        "1":322685000131212
    }
}

Last updated

Was this helpful?