Unicat API Reference

Up - API Reference - Home

Records - tree and product information

Fetch records

/api/p/<project gid>/records/get get one or more records
/api/p/<project gid>/records/root get the root of the tree
/api/p/<project gid>/records/children get the children of a record
/api/p/<project gid>/records/tree get the tree, paginated
/api/p/<project gid>/records/worksheet get a worksheet, paginated children

Search for records

/api/p/<project gid>/records/search search for records

Mutate the record tree

/api/p/<project gid>/records/create create a new record in the tree
/api/p/<project gid>/records/move move a record along with its subtree
/api/p/<project gid>/records/copy copy a record and its subtree
/api/p/<project gid>/records/shallow_copy copy a record without its subtree
/api/p/<project gid>/records/duplicate copy a record without its subtree, in the same location
/api/p/<project gid>/records/link copy and link a record
/api/p/<project gid>/records/unlink break a record's link
/api/p/<project gid>/records/delete delete a record
/api/p/<project gid>/records/undelete undelete a deleted record
/api/p/<project gid>/records/permanent_delete permanently delete a deleted record

Update records

/api/p/<project gid>/records/update update a record's user defined fields

Excel export and import

/api/p/<project gid>/records/excel/children download an Excel worksheet with a record's children
/api/p/<project gid>/records/excel/update upload a downloaded and edited Excel worksheet to update records

Generate previews for fields

/api/p/<project gid>/records/fields/preview generate a preview for a field's value

Update channels

/api/p/<project gid>/records/channels/set toggle a record's channels
/api/p/<project gid>/records/channels/copy_from_parent copy some record's channels from its parent
/api/p/<project gid>/records/channels/copy_down copy some record's channels to its subtree
/api/p/<project gid>/records/channels/copy_up copy some record's channels to its ancestors

Update a record's definition

/api/p/<project gid>/records/definition/set set a record's definition
/api/p/<project gid>/records/definition/revert revert a record's definition
/api/p/<project gid>/records/definition/copy_to_siblings copy the record's definition to its siblings

A record's definition's extra fields

/api/p/<project gid>/records/definition/fields/add add an extra field to the record's definition
/api/p/<project gid>/records/definition/fields/move move a field inside the record's definition's fields
/api/p/<project gid>/records/definition/fields/remove remove an extra field from the record's definition

A record's definition's extra classes

/api/p/<project gid>/records/definition/classes/add add an extra class to the record's definition
/api/p/<project gid>/records/definition/classes/move move a class inside the record's definition's classes
/api/p/<project gid>/records/definition/classes/remove remove an extra class from the record's definition

A record's definition's fieldlist

/api/p/<project gid>/records/definition/fieldlists/fields/add add a field to the record's definition's fieldlist
/api/p/<project gid>/records/definition/fieldlists/fields/move change the order of fields inside the record's definition's fieldlist
/api/p/<project gid>/records/definition/fieldlists/fields/remove remove a field from the record's definition's fieldlist

A record's definition's layout

/api/p/<project gid>/records/definition/layouts/modify modify a layout
/api/p/<project gid>/records/definition/layouts/revert revert a layout

/api/p/<project gid>/records/definition/layouts/components/create modify a layout by adding a new component
/api/p/<project gid>/records/definition/layouts/components/modify modify a layout by modifying a component
/api/p/<project gid>/records/definition/layouts/components/move modify a layout by moving a component
/api/p/<project gid>/records/definition/layouts/components/delete modify a layout by deleting a component

Bulk operations on records

Bulk requests/responses explained

/api/p/<project gid>/records/bulk/get get bulk records
/api/p/<project gid>/records/bulk/move bulk move records
/api/p/<project gid>/records/bulk/copy bulk copy records with their subtrees
/api/p/<project gid>/records/bulk/shallow_copy bulk copy records without their subtrees
/api/p/<project gid>/records/bulk/duplicate bulk duplicate records
/api/p/<project gid>/records/bulk/link bulk link records
/api/p/<project gid>/records/bulk/delete bulk delete records
/api/p/<project gid>/records/bulk/undelete bulk undelete deleted records
/api/p/<project gid>/records/bulk/permanent_delete permanently delete deleted records in bulk