Skip to main content
POST
Error

Authorizations

​
X-API-Key
string
header
required

Headers

​
customer
string
required

Workspace identifier

Path Parameters

​
projectId
string
required
​
jobId
string
required

Body

application/json
​
clauses
object[]
required

The mapping clauses to preview, in precedence order, as the commit takes them.

​
base_branch_id
string

The branch the import would start from, which decides whether a row creates or updates an item. Omit or "master" for the base branch.

​
clause_id
string

The clause whose rows to return. Omit to return no rows.

​
include_counts
boolean

Also count, for every clause, the rows that would create and update items.

​
limit
number
default:50

Rows to return.

Required range: x <= 100
​
offset
number
default:0

Rows of the clause to skip, in document order.

Response

200 - application/json
​
has_more
boolean
required

Whether the clause has rows past this page.

​
rows
object[]
required
​
counts
object[]

Per-clause counts, when requested.

​
counts_complete
boolean

False when the counts stopped short of the whole document, so they are lower bounds.