41 Object Endpoints

Object Endpoints

Generic CRUD endpoints for working with objects.

API

POST /api/v1/object/<action>

Where <action> is one of:

• count (Count)
• set (Set -- Add or Edit)
• get (Get)
• list (List)

Count

POST /api/v1/object/count

Returns the number of objects, with optional data filtering.

Request parameters: Common list request parameters

Set

POST /api/v1/object/set

Create or update an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required for Edit action. Object identifier.
parent	UUID		Optional. Parent object identifier.
type	STRING		Recommended. Object type code.
label	STRING		Recommended. Object label.
data	STRING		Optional. Object data.

NOTE: If the id key is not specified or is null, the action is treated as Add; otherwise it is treated as Edit.

NOTE: Omitted keys are treated as null.

NOTE: For the Edit action, you do not need to send all keys -- only those that need to be changed.

NOTE: The response will contain the data returned by the Get action.

Get

POST /api/v1/object/get

Retrieve object data.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.

Response format:

Field	Type	Description
id	UUID	Object identifier.
parent	UUID	Parent object identifier.
entity	UUID	Entity identifier.
entitycode	STRING	Entity code.
class	UUID	Class identifier.
classcode	STRING	Class code.
classlabel	STRING	Class label.
type	UUID	Type identifier.
typecode	STRING	Type code.
typename	STRING	Type name.
typedescription	STRING	Type description.
label	STRING	Label.
data	STRING	Data.
statetype	UUID	State type.
statetypecode	STRING	State type code.
statetypename	STRING	State type name.
state	UUID	State.
statecode	STRING	State code.
statelabel	STRING	State label.
lastupdate	TIMESTAMP	Last modification date.
owner	UUID	Owner account identifier.
ownercode	STRING	Owner account code (login).
ownername	STRING	Owner account name.
created	TIMESTAMP	Physical date (creation date).
oper	UUID	Operator account identifier.
opercode	STRING	Operator account code (login).
opername	STRING	Operator account name.
operdate	TIMESTAMP	Logical date (operation date).

List

POST /api/v1/object/list

Retrieve object data as a list, with optional data filtering.

Request parameters: Common list request parameters

Object Class

POST /api/v1/object/class

Returns the class of an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.

Object Type

POST /api/v1/object/type

Returns the type of an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
fields	JSON array		Optional. JSON array of field names to return. If omitted, the request returns all fields.

Object State

POST /api/v1/object/state

Returns the state of an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
fields	JSON array		Optional. JSON array of field names to return. If omitted, the request returns all fields.

Object Methods

POST /api/v1/object/method

Returns the methods available for an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.

Execute Method

POST /api/v1/object/method/execute

Execute a dynamic method on an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
method	UUID		Variant. Method identifier (takes priority over code).
code	STRING		Variant. Action code. Can be specified instead of the method identifier.
params	JSON		Optional. HTML form parameters in JSON format.

• Note that the code parameter accepts an action code, not a method code.

Execute Action

POST /api/v1/object/action/execute

Execute an action on an object.

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.
action	UUID		Variant. Action identifier (takes priority over code).
code	STRING		Variant. Action code. Can be specified instead of the action identifier.
params	JSON		Optional. HTML form parameters in JSON format.

Force Delete

POST /api/v1/object/delete/force

Forcibly "deletes" a document (bypassing workflow events).

Request parameters:

Name	Type	Value	Description
id	UUID		Required. Object identifier.