ZeyOS Standard REST API API Reference

The ZeyOS Standard REST API provides access to almost all of your ZeyOS data and gives you a powerful tool to connect third-party applications and other systems with ZeyOS, without having to write a custom ZeyOS app.

You may access the ZeyOS Standard REST API via https://cloud.zeyos.com/{INSTANCE}/api/v1/, provided that you supply a valid token generated through the ZeyOS Authentication API via https://cloud.zeyos.com/{INSTANCE}/auth/v1/.

Return Values and Error Handling

The ZeyOS Standard REST API currently only returns JSON data and an HTTP status code indicating the outcome of a request.

HTTP status code 200 or 201 are used to indicate a successful response, and the result will be a JSON object.

When an error occurs, the HTTP status code will be 400 or greater, and the response will be a text message.

We recommend that you treat any HTTP status code greater than or equal to 400 as an error.

Data Retrieval

The ZeyOS Standard REST API allows you to execute complex queries, including simple joins and composite filters.

Let's take a look at the following example:

Query (query.json):

{
  "fields": {
    "Id": "ID",
    "Name": "lastname",
    "Nickname": "extdata.nickname"
    "Address": "contact.address",
    "Postalcode": "contact.postalcode",
    "Town": "contact.city",
    "SalesAgent": "assigneduser.name"
  },
  "filters": {
    "visibility": 0,
    "contact.country": {"IN": ["DE", "AT", "GB"]},
    2: [
      "OR",
      {"lastmodified": {">": 1524472045}},
      {"contact.lastmodified": {">": 1524472045}}
    ]
  },
  "sort": [
    "+lastname",
    "-contact.country"
  ],
  "limit": 3,
  "offset": 0
}

Request:

$ curl -X POST \
  -H 'Authorization: Bearer YourApiToken' \
  -H "Content-Type: application/json" \
  --data @./query.json \
  https://cloud.zeyos.com/demo/api/v1/accounts/

Response:

[{
    "Id": 2,
    "Name": "BEQ Building Equipment",
    "Nickname": null,
    "Address": "Queensstreet",
    "Postalcode": "12923",
    "Town": "London",
    "Country": "GB",
    "SalesAgent": "Max Mueller"
}, {
    "Id": 15,
    "Name": "CleanTexx",
    "Nickname": null,
    "Address": "Tower Bridge",
    "Postalcode": "12923",
    "Town": "London",
    "Country": "GB",
    "SalesAgent": null
}, {
    "Id": 1,
    "Name": "Lightexx AG",
    "Nickname": null,
    "Address": "Schmittstr. 4",
    "Postalcode": "80172",
    "Town": "Munich",
    "Country": "DE",
    "SalesAgent": null
}]

Field Selection

The field selection references all fields you want to have included in your query results. You can either specify your field selection as and array or as an object. Using an object is useful if you want to specify alias names. In the example above, we select the field lastname with an alias called name.

If you are not certain what fields are available for which entity, you can either check the entity reference in this document or the ZeyOS Schema Documentation.

Besides selecting the entity's own fields, you can also perform simple join operations within the entity's first degree relationships. In order to discover relationships, it's best to check the ZeyOS Schema Documentation, it also contains a graphical map of all entity relationships.

Besides related tables you can also select extdata fields. extdata is a concept in ZeyOS which allows for storing additional values for all entities in ZeyOS. Whenever you create a new form field in ZeyOS, the field's value is stored in extdata.

Filters

You can specify composite filters as you would in a regular SQL statement:

filters <array/json> = {
 "field": "value",
 "field2": {"=": "value"},
 "field3": {"<": "value1", ">": "value2"},
 "field4": {"IN": ["value1", "value2"]},
 ["AND/OR/NOT", {...}, {...}]
}

The following filter operators are supported:

=: Equals
!=, <>: Not equals
<: Less than
<=: Less than or equal to
>: Greater than
>=: Greater than or equal to
IN: Contains (e.g. "field": {"IN": ["value1", "value2"]})
!IN: Does not contain

For strings you can also use the following operators:

~: Matches regular expression
~*: Matches regular expression, case-insensitive
!~: Not matches regular expression
!~*: Not matches regular expression, case-insensitive
~~: Is like
~~*: Is like, case-insensitive
!~~: Not like
!~~*: Not like, case-insensitive

Search Queries

The query parameter allows to specify a search string, that will be applied to all searchable strings, such as name.

Sorting

You can sort by multiple columns by defining an array of column names.

sort <array/json> = {
 "field1",
 "+field2",
 "-field3"
}

Adding modifiers will set the sorting mode:

+ for ascending
- for descending

Pagination

Sometimes the result size might be too large to be selected through one query. In such cases it makes sense to use pagination to page through the results.

Obviously, the first thing you need to know is the number or records in order to calculate the number of pages. This can be achived throuch the count modifier.

For example:

{
  "count": 1,
  "filters": {
    "visibility": 0,
    "contact.country": {"IN": ["DE", "AT", "GB"]},
    2: [
      "OR",
      {"lastmodified": {">": 1524472045}},
      {"contact.lastmodified": {">": 1524472045}}
    ]
  }
}

Result:

{
  "count":5
}

Now that you have the number of records, you can easily page through the result by using the limit and offset parameters.

Expanding JSON and Binary Data

Some table columns include JSON data or reference binary files. The expand parameter allows you to specify to load the columns content automatically.

For example:

{
  "fields": [
    "ID",
    "subject",
    "binfile"
  ],
  "expand": [
    "binfile"
  ],
  "limit": 1
}

Request:

$ curl -X POST \
  -H 'Authorization: Bearer YourApiToken' \
  -H "Content-Type: application/json" \
  --data @./query.json \
  https://cloud.zeyos.com/demo/api/v1/messages/

Result:

[{"ID":188,"subject":"Test","binfile":{"content":"UmV0dXJuLVBhdGg6IDx..."}}]

This example will return the entire e-mail message as RFC 822.

API Endpoint

https://cloud.zeyos.com/{INSTANCE}/api/v1

Terms of Service: https://www.zeyos.com/termsofservice

Contact: info@zeyos.com

Schemes: https

Version: v1

Authentication

The ZeyOS REST API is only usable for authenticated users. Authentication is achieved in two ways:

For interal apps - the ZeyOS session: If the user is already logged in to ZeyOS and you are using the REST API within a Weblet, the current ZeyOS session will be used.
For external apps - obtaining a session token

Token authentication relies on ZeyOS's token authentication mechanism, documented in the Auth API documentation.

Once a token has been obtained, you can then use the REST API by including the Authorization header in your request with the method indicator Bearer, a space, the obtained token string, e.g. Authorization: Bearer 2a3e4ec88e66138253a69da3406841fccb1c998e.

Example with CURL:

$ curl -X POST \
  -H 'Authorization: Bearer a749717494cf42aa2fcb7533a950e2a7350d1086' \
  -d "fields[]=ID&fields[]=lastname&fields[]=firstname&limit=3" \
  https://cloud.zeyos.com/demo/api/v1/contacts/

Response:

[{
    "ID": 12198,
    "lastname": "Morris",
    "firstname": "Steve"
}, {
    "ID": 12199,
    "lastname": "Schulz",
    "firstname": "Dirk"
}, {
    "ID": 12200,
    "lastname": "Charlott",
    "firstname": "Sophie"
}]

$ curl -X POST -i --data 'name=max.power&password=MySecretPwd&identifier=MyDevice&appsecret=ff55c5095a126d66faaa37cd71bc771672c56ec5' https://cloud.zeyos.com/demo/auth/v1/login

Response:

{
  "user": 2,
  "application": 345,
  "token": "a749717494cf42aa2fcb7533a950e2a7360d1086",
  "identifier": "MyDevice",
  "expdate": null
}

session

Session Cookie Authentication ( RFC 6265)

name

ZEYOSID

type

apiKey

token

HTTP Bearer Authentication ( RFC 6750); use the ZeyOS Authentication API 's POST /auth/v1/login to obtain a valid bearer token

scheme

bearer

type

http

general

Get system configuration

GET /config

Return the user-visible system configuration.

200 OK

type

object

401 Unauthorized

Unauthorized

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: text/plain

Response Example (200 OK)

{}

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

general

Get application settings

GET /settings

Return the settings of the application that was used for authentication.

200 OK

type

object

401 Unauthorized

Unauthorized

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

"object"

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

accounts

List accounts

POST /accounts

List selected data from all accounts that match the specified filter and search criteria in a specific sort order. Requires accounts permission.

count

in formData

boolean

Return number of results only (fields, sort, limit, offset and expand have no effect)

export

in formData

boolean

Export result as CSV file (type text/csv, delimiter ;) with unbounded limit (admin)

distinct

in formData

boolean

Return distinct result set

fields

in formData

object

Select specified fields only; use optional alias as object key

filter

in formData

object

Eliminate results that do not match specified filter criteria

query

in formData

string

Eliminate results that do not match specified query search pattern

sort

in formData

string[]

Return sorted results by specified order of fields; use the minus sign (-) as a prefix to sort by a field in descending instead of ascending order (default)

limit

in formData

integer 1 ≤ x ≤ 10000 1000

Limit to total number of results (defaults to 1000, unless export is true)

offset

in formData

integer (int64) 0

Return results forward from specified offset only

expand

in formData

string[]

Expand content of composite fields (binfile, json or array)

200 OK

accounts

type

accounts

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: text/plain

Response Example (200 OK)

[
  {
    "ID": 1,
    "assigneduser": 6,
    "contact": 7,
    "creationdate": 872838840,
    "creator": 6,
    "currency": "EUR",
    "customernum": "C-123456",
    "description": "string",
    "excludetax": "integer",
    "firstname": "John",
    "lastmodified": 872838840,
    "lastname": "Doe",
    "locked": "integer",
    "ownergroup": "integer (int32)",
    "suppliernum": "S-123456",
    "taxid": "DE123456789",
    "type": "integer",
    "visibility": "integer"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

accounts

Create new account

PUT /accounts

Create a new account and return it's persistent data. Requires writable accounts permission.

body

in formData

object

(no description)

201 Created

accounts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

accounts

Delete account

DELETE /accounts/{ID}

Permanently delete an existing account by ID. Requires writable accounts permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

accounts

Get account

GET /accounts/{ID}

Return the data of an existing account by ID. Requires accounts permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

extdata

in query

integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags

in query

integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

accounts

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

accounts

Check if account exists

HEAD /accounts/{ID}

Check if an account with ID exists, but do not return it's data. Requires accounts permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

accounts

Update existing account

PATCH /accounts/{ID}

Update an existing account by ID and return it's persistent data. Requires writable accounts permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

accounts

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "assigneduser": 6,
  "contact": 7,
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "customernum": "C-123456",
  "description": "string",
  "excludetax": "integer",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "locked": "integer",
  "ownergroup": "integer (int32)",
  "suppliernum": "S-123456",
  "taxid": "DE123456789",
  "type": "integer",
  "visibility": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

actionsteps

List actionsteps

POST /actionsteps

List selected data from all action steps that match the specified filter and search criteria in a specific sort order. Requires actionsteps permission.

200 OK

actionsteps

type

actionsteps

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "account": "integer (int32)",
    "actionnum": "A-123456",
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "date": 872838840,
    "description": "string",
    "duedate": "integer (int64)",
    "effort": "number (int32)",
    "lastmodified": 872838840,
    "name": "My Action Step",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "status": "integer",
    "task": 7,
    "ticket": "integer (int32)",
    "transaction": "integer (int32)"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

actionsteps

Create new action step

PUT /actionsteps

Create a new action step and return it's persistent data. Requires writable actionsteps permission.

body

in formData

object

(no description)

201 Created

actionsteps

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

actionsteps

Delete action step

DELETE /actionsteps/{ID}

Permanently delete an existing action step by ID. Requires writable actionsteps permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

actionsteps

Get action step

GET /actionsteps/{ID}

Return the data of an existing action step by ID. Requires actionsteps permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

extdata

in query

integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags

in query

integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

actionsteps

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

actionsteps

Check if action step exists

HEAD /actionsteps/{ID}

Check if an action step with ID exists, but do not return it's data. Requires actionsteps permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

actionsteps

Update existing action step

PATCH /actionsteps/{ID}

Update an existing action step by ID and return it's persistent data. Requires writable actionsteps permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

actionsteps

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "account": "integer (int32)",
  "actionnum": "A-123456",
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "date": 872838840,
  "description": "string",
  "duedate": "integer (int64)",
  "effort": "number (int32)",
  "lastmodified": 872838840,
  "name": "My Action Step",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "status": "integer",
  "task": 7,
  "ticket": "integer (int32)",
  "transaction": "integer (int32)"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

addresses

List addresses

POST /addresses

List selected data from all addresses that match the specified filter and search criteria in a specific sort order. Requires accounts permission. Has dependency on account.

200 OK

addresses

type

addresses

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "account": 7,
    "contact": 13,
    "creationdate": 872838840,
    "creator": 6,
    "default": "integer",
    "lastmodified": 872838840,
    "type": "integer"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

addresses

Create new address

PUT /addresses

Create a new address and return it's persistent data. Requires writable accounts permission. Has dependency on account.

in formData

integer (int64)

Address ID

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified

in formData

integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

account

in formData

integer (int32)

Account ID ( dependency)

contact

in formData

integer (int32)

Contact ID

type

in formData

integer 0, 1, 2, 3, 4 0

Address type (0=BILLING_SHIPPING, 1=BILLING_BILLING, 2=PROCUREMENT_SHIPPING, 3=PROCUREMENT_BILLING, 4=COLLECTION)

default

in formData

integer 0, 1 0

Default for this address type

201 Created

addresses

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

addresses

Delete address

DELETE /addresses/{ID}

Permanently delete an existing address by ID. Requires writable accounts permission. Has dependency on account.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

addresses

Get address

GET /addresses/{ID}

Return the data of an existing address by ID. Requires accounts permission. Has dependency on account.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

addresses

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

addresses

Check if address exists

HEAD /addresses/{ID}

Check if an address with ID exists, but do not return it's data. Requires accounts permission. Has dependency on account.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

addresses

Update existing address

PATCH /addresses/{ID}

Update an existing address by ID and return it's persistent data. Requires writable accounts permission. Has dependency on account.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

addresses

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "account": 7,
  "contact": 13,
  "creationdate": 872838840,
  "creator": 6,
  "default": "integer",
  "lastmodified": 872838840,
  "type": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

applications

Please note: Applications are only read-only and can only be accessed by admin users

applications

List applications

POST /applications

List selected data from all applications that match the specified filter and search criteria in a specific sort order. Requires dev permission.

200 OK

applications

type

applications

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "activity": "integer",
    "creationdate": 872838840,
    "creator": 6,
    "identifier": "my_application",
    "lastmodified": 872838840,
    "name": "My Application",
    "vendor": "ZeyOS",
    "version": 10000
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

applications

Get application

GET /applications/{ID}

Return the data of an existing application by ID. Requires dev permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

extdata

in query

integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags

in query

integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

applications

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "activity": "integer",
  "creationdate": 872838840,
  "creator": 6,
  "identifier": "my_application",
  "lastmodified": 872838840,
  "name": "My Application",
  "vendor": "ZeyOS",
  "version": 10000
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

applications

Check if application exists

HEAD /applications/{ID}

Check if an application with ID exists, but do not return it's data. Requires dev permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

appointments

List appointments

POST /appointments

List selected data from all appointments that match the specified filter and search criteria in a specific sort order. Requires calendar permission.

200 OK

appointments

type

appointments

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "assigneduser": 6,
    "color": "string",
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": 872838840,
    "daterecurrence": "integer (int64)",
    "dateto": 872842440,
    "davserver": 7,
    "description": "string",
    "interval": "integer",
    "lastmodified": 872838840,
    "location": "Office",
    "name": "My Appointment",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "recurrence": "integer",
    "visibility": "integer"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

appointments

Create new appointment

PUT /appointments

Create a new appointment and return it's persistent data. Requires writable calendar permission.

body

in formData

object

(no description)

201 Created

appointments

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

appointments

Delete appointment

DELETE /appointments/{ID}

Permanently delete an existing appointment by ID. Requires writable calendar permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

appointments

Get appointment

GET /appointments/{ID}

Return the data of an existing appointment by ID. Requires calendar permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

extdata

in query

integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags

in query

integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

appointments

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

appointments

Check if appointment exists

HEAD /appointments/{ID}

Check if an appointment with ID exists, but do not return it's data. Requires calendar permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

appointments

Update existing appointment

PATCH /appointments/{ID}

Update an existing appointment by ID and return it's persistent data. Requires writable calendar permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

appointments

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "assigneduser": 6,
  "color": "string",
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": 872838840,
  "daterecurrence": "integer (int64)",
  "dateto": 872842440,
  "davserver": 7,
  "description": "string",
  "interval": "integer",
  "lastmodified": 872838840,
  "location": "Office",
  "name": "My Appointment",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "recurrence": "integer",
  "visibility": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

associations

List associations

POST /associations

List selected data from all associations that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK

associations

type

associations

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "entity1": "notes",
    "entity2": "tasks",
    "index1": 7,
    "index2": 13
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

associations

Create new association

PUT /associations

Create a new association and return it's persistent data. Requires no specific permission.

in formData

integer (int64)

Association ID

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

entity1

in formData

string accounts, actionsteps, applications, appointments, campaigns, contacts, contracts, coupons, davservers, devices, dunning, feedservers, groups, items, ledgers, links, mailinglists, mailservers, messages, notes, objects, opportunities, payments, pricelists, projects, resources, services, storages, tasks, tickets, transactions, users, weblets

First canonical entity

entity2

in formData

Second canonical entity

index1

in formData

integer (int32)

First entity ID

index2

in formData

integer (int32)

Second entity ID

(no description)

201 Created

associations

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

associations

Delete association

DELETE /associations/{ID}

Permanently delete an existing association by ID. Requires no specific permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

associations

Get association

GET /associations/{ID}

Return the data of an existing association by ID. Requires no specific permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

associations

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

associations

Check if association exists

HEAD /associations/{ID}

Check if an association with ID exists, but do not return it's data. Requires no specific permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

associations

Update existing association

PATCH /associations/{ID}

Update an existing association by ID and return it's persistent data. Requires no specific permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

associations

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity1": "notes",
  "entity2": "tasks",
  "index1": 7,
  "index2": 13
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

binfiles

List bin files

POST /binfiles

List selected data from all bin files that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK

users

type

users

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "activity": "integer",
    "apionly": "integer",
    "contact": 7,
    "creationdate": 872838840,
    "creator": 6,
    "email": "john.doe@company.com",
    "expdate": "integer (int64)",
    "lastlogin": 872838840,
    "lastmodified": 872838840,
    "name": "john.doe",
    "nopublic": "integer"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

binfiles

Get bin file

GET /binfiles/{ID}

Return the data of an existing bin file by ID. Requires no specific permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

binfiles

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "hash": "\\xed076287532e86365e841e92bfc50d8c",
  "size": 12
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

binfiles

Check if bin file exists

HEAD /binfiles/{ID}

Check if a bin file with ID exists, but do not return it's data. Requires no specific permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

campaigns

List campaigns

POST /campaigns

List selected data from all campaigns that match the specified filter and search criteria in a specific sort order. Requires campaigns permission.

200 OK

campaigns

type

campaigns

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "assigneduser": 6,
    "creationdate": 872838840,
    "creator": 6,
    "datefrom": "integer (int64)",
    "dateto": "integer (int64)",
    "description": "string",
    "lastmodified": 872838840,
    "name": "My Campaign",
    "ownergroup": "integer (int32)",
    "status": "integer",
    "visibility": "integer"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

campaigns

Create new campaign

PUT /campaigns

Create a new campaign and return it's persistent data. Requires writable campaigns permission.

body

in formData

object

(no description)

201 Created

campaigns

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

campaigns

Delete campaign

DELETE /campaigns/{ID}

Permanently delete an existing campaign by ID. Requires writable campaigns permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

campaigns

Get campaign

GET /campaigns/{ID}

Return the data of an existing campaign by ID. Requires campaigns permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

extdata

in query

integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags

in query

integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

campaigns

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

campaigns

Check if campaign exists

HEAD /campaigns/{ID}

Check if a campaign with ID exists, but do not return it's data. Requires campaigns permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

campaigns

Update existing campaign

PATCH /campaigns/{ID}

Update an existing campaign by ID and return it's persistent data. Requires writable campaigns permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

campaigns

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "assigneduser": 6,
  "creationdate": 872838840,
  "creator": 6,
  "datefrom": "integer (int64)",
  "dateto": "integer (int64)",
  "description": "string",
  "lastmodified": 872838840,
  "name": "My Campaign",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

categories

List categories

POST /categories

List selected data from all categories that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK

categories

type

categories

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "entity": "notes",
    "name": "My Category/My Subcategory",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

categories

Create new category

PUT /categories

Create a new category and return it's persistent data. Requires no specific permission.

in formData

integer (int32)

Category ID

owneruser

in formData

integer (int32)

Owner user ID (PUBLIC if owneruser=null and ownergroup=null)

ownergroup

in formData

integer (int32)

Owner group ID (PUBLIC if owneruser=null and ownergroup=null)

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

entity

in formData

string (at least 1 chars)

Canonical entity

name

in formData

string (at least 1 chars)

Name

201 Created

categories

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

categories

Delete category

DELETE /categories/{ID}

Permanently delete an existing category by ID. Requires no specific permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

categories

Get category

GET /categories/{ID}

Return the data of an existing category by ID. Requires no specific permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

categories

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

categories

Check if category exists

HEAD /categories/{ID}

Check if a category with ID exists, but do not return it's data. Requires no specific permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

categories

Update existing category

PATCH /categories/{ID}

Update an existing category by ID and return it's persistent data. Requires no specific permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

categories

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "entity": "notes",
  "name": "My Category/My Subcategory",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

channels

List channels

POST /channels

List selected data from all channels that match the specified filter and search criteria in a specific sort order. Requires no specific permission.

200 OK

channels

type

channels

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "name": "Channel"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

channels

Create new channel

PUT /channels

Create a new channel and return it's persistent data. Requires no specific permission.

in formData

integer (int32)

Channel ID

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

name

in formData

string (at least 1 chars)

Name (unique)

201 Created

channels

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

channels

Delete channel

DELETE /channels/{ID}

Permanently delete an existing channel by ID. Requires no specific permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

channels

Get channel

GET /channels/{ID}

Return the data of an existing channel by ID. Requires no specific permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

channels

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

channels

Check if channel exists

HEAD /channels/{ID}

Check if a channel with ID exists, but do not return it's data. Requires no specific permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

channels

Update existing channel

PATCH /channels/{ID}

Update an existing channel by ID and return it's persistent data. Requires no specific permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

channels

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "name": "Channel"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

comments

List comments

POST /comments

List selected data from all comments that match the specified filter and search criteria in a specific sort order. Requires no specific permission. Has dependency on record.

200 OK

comments

type

comments

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "creationdate": 872838840,
    "creator": 6,
    "record": 7,
    "sender": "John Doe",
    "text": "This is my comment!"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

comments

Create new comment

PUT /comments

Create a new comment and return it's persistent data. Requires the authenticated user to be the creator. Has dependency on record.

in formData

integer (int64)

Comment ID

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

record

in formData

integer (int64)

Record ID ( dependency)

sender

in formData

string

Sender

text

in formData

string

Comment text ( Markdown for rich text representation)

201 Created

comments

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

comments

Delete comment

DELETE /comments/{ID}

Permanently delete an existing comment by ID. Requires the authenticated user to be the creator. Has dependency on record.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

comments

Get comment

GET /comments/{ID}

Return the data of an existing comment by ID. Requires no specific permission. Has dependency on record.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

comments

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

comments

Check if comment exists

HEAD /comments/{ID}

Check if a comment with ID exists, but do not return it's data. Requires no specific permission. Has dependency on record.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

comments

Update existing comment

PATCH /comments/{ID}

Update an existing comment by ID and return it's persistent data. Requires the authenticated user to be the creator. Has dependency on record.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

comments

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "creationdate": 872838840,
  "creator": 6,
  "record": 7,
  "sender": "John Doe",
  "text": "This is my comment!"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

components

List components

POST /components

List selected data from all components that match the specified filter and search criteria in a specific sort order. Requires inventory permission. Has dependency on item.

200 OK

components

type

components

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "amount": "number (double)",
    "component": 13,
    "creationdate": 872838840,
    "creator": 6,
    "fixed": "integer",
    "item": 7,
    "lastmodified": 872838840,
    "price": "number (double)"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

components

Create new component

PUT /components

Create a new component and return it's persistent data. Requires writable inventory permission. Has dependency on item.

in formData

integer (int64)

Component ID

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

lastmodified

in formData

integer (int64)

Last modification date and time as a Unix time stamp (auto-reset on modification)

item

in formData

integer (int32)

Item ID ( dependency)

component

in formData

integer (int32)

Component item ID; must be distinct from item

amount

in formData

number (double) 1

Amount (quantity)

price

in formData

number (double)

Imputed price per unit

fixed

in formData

integer 0, 1 0

Fixed quantity

201 Created

components

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

components

Delete component

DELETE /components/{ID}

Permanently delete an existing component by ID. Requires writable inventory permission. Has dependency on item.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

components

Get component

GET /components/{ID}

Return the data of an existing component by ID. Requires inventory permission. Has dependency on item.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

components

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

components

Check if component exists

HEAD /components/{ID}

Check if a component with ID exists, but do not return it's data. Requires inventory permission. Has dependency on item.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

components

Update existing component

PATCH /components/{ID}

Update an existing component by ID and return it's persistent data. Requires writable inventory permission. Has dependency on item.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

components

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "amount": "number (double)",
  "component": 13,
  "creationdate": 872838840,
  "creator": 6,
  "fixed": "integer",
  "item": 7,
  "lastmodified": 872838840,
  "price": "number (double)"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts

List contacts

POST /contacts

List selected data from all contacts that match the specified filter and search criteria in a specific sort order. Requires contacts permission.

200 OK

contacts

type

contacts

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "address": "123 Main St.",
    "assigneduser": 6,
    "birthdate": "integer (int64)",
    "cell": "+1 123-456-7892",
    "city": "Anytown",
    "company": "Any Company, Inc.",
    "country": "US",
    "creationdate": 872838840,
    "creator": 6,
    "davserver": 7,
    "department": "Research & Development",
    "description": "string",
    "email": "john.doe@company.com",
    "email2": "johnny_d@personal.com",
    "fax": "+1 123-456-7893",
    "firstname": "John",
    "lastmodified": 872838840,
    "lastname": "Doe",
    "ownergroup": "integer (int32)",
    "owneruser": "integer (int32)",
    "phone": "+1 123-456-7890",
    "phone2": "+1 123-456-7891",
    "position": "CTO",
    "postalcode": "95060",
    "region": "CA",
    "title": "Dr.",
    "type": "integer",
    "visibility": "integer",
    "website": "http://www.company.com/about/john_doe"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts

Create new contact

PUT /contacts

Create a new contact and return it's persistent data. Requires writable contacts permission.

body

in formData

object

(no description)

201 Created

contacts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts

Delete contact

DELETE /contacts/{ID}

Permanently delete an existing contact by ID. Requires writable contacts permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts

Get contact

GET /contacts/{ID}

Return the data of an existing contact by ID. Requires contacts permission.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

extdata

in query

integer 0, 1

Return all extension data field and value pairs in pseudo field extdata

tags

in query

integer 0, 1

Return list of all tags in pseudo field tags

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

contacts

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts

Check if contact exists

HEAD /contacts/{ID}

Check if a contact with ID exists, but do not return it's data. Requires contacts permission.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts

Update existing contact

PATCH /contacts/{ID}

Update an existing contact by ID and return it's persistent data. Requires writable contacts permission.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

contacts

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "address": "123 Main St.",
  "assigneduser": 6,
  "birthdate": "integer (int64)",
  "cell": "+1 123-456-7892",
  "city": "Anytown",
  "company": "Any Company, Inc.",
  "country": "US",
  "creationdate": 872838840,
  "creator": 6,
  "davserver": 7,
  "department": "Research & Development",
  "description": "string",
  "email": "john.doe@company.com",
  "email2": "johnny_d@personal.com",
  "fax": "+1 123-456-7893",
  "firstname": "John",
  "lastmodified": 872838840,
  "lastname": "Doe",
  "ownergroup": "integer (int32)",
  "owneruser": "integer (int32)",
  "phone": "+1 123-456-7890",
  "phone2": "+1 123-456-7891",
  "position": "CTO",
  "postalcode": "95060",
  "region": "CA",
  "title": "Dr.",
  "type": "integer",
  "visibility": "integer",
  "website": "http://www.company.com/about/john_doe"
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts2contacts

List contacts-to-contacts

POST /contacts2contacts

List selected data from all contacts-to-contacts that match the specified filter and search criteria in a specific sort order. Requires contacts permission. Has dependencies on contact1 and contact2.

200 OK

contacts2contacts

type

contacts2contacts

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "contact1": 7,
    "contact2": 13,
    "creationdate": 872838840,
    "creator": 6
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts2contacts

Create new contact-to-contact

PUT /contacts2contacts

Create a new contact-to-contact and return it's persistent data. Requires writable contacts permission. Has dependencies on contact1 and contact2.

in formData

integer (int64)

Contact-to-contact ID

creator

in formData

integer (int32)

Creator user ID (defaults to authenticated user on creation)

creationdate

in formData

integer (int64)

Creation date and time as a Unix time stamp (defaults to current date and time on creation)

contact1

in formData

integer (int32)

First contact ID ( dependency)

contact2

in formData

integer (int32)

Second contact ID ( dependency)

201 Created

contacts2contacts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts2contacts

Delete contact-to-contact

DELETE /contacts2contacts/{ID}

Permanently delete an existing contact-to-contact by ID. Requires writable contacts permission. Has dependencies on contact1 and contact2.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

204 No Content

Successful Deletion (No Content)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts2contacts

Get contact-to-contact

GET /contacts2contacts/{ID}

Return the data of an existing contact-to-contact by ID. Requires contacts permission. Has dependencies on contact1 and contact2.

in path

integer

Unique ID

expand

in query

string[]

Expand content of composite fields (binfile, json or array)

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

200 OK

contacts2contacts

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts2contacts

Check if contact-to-contact exists

HEAD /contacts2contacts/{ID}

Check if a contact-to-contact with ID exists, but do not return it's data. Requires contacts permission. Has dependencies on contact1 and contact2.

in path

integer

Unique ID

If-None-Match

in header

string

Return status code 304 on matching entity tag ( RFC 7232)

204 No Content

Exists (No Content)

304 Not Modified

Not Modified

401 Unauthorized

Unauthorized

type

string

404 Not Found

Not Found

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Headers (204 No Content)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contacts2contacts

Update existing contact-to-contact

PATCH /contacts2contacts/{ID}

Update an existing contact-to-contact by ID and return it's persistent data. Requires writable contacts permission. Has dependencies on contact1 and contact2.

in path

integer

Unique ID

If-Match

in header

string

Return status code 412 on non-matching entity tag ( RFC 7232)

200 OK

contacts2contacts

Successful Update (OK)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

404 Not Found

Not Found

409 Conflict

Non-matching ID (Conflict)

410 Gone

Gone

412 Precondition Failed

Non-matching ETag (Precondition Failed)

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

{
  "ID": 1,
  "contact1": 7,
  "contact2": 13,
  "creationdate": 872838840,
  "creator": 6
}

Response Headers (200 OK)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contracts

List contracts

POST /contracts

List selected data from all contracts that match the specified filter and search criteria in a specific sort order. Requires contracts permission.

200 OK

contracts

type

contracts

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "ID": 1,
    "account": 7,
    "assigneduser": 6,
    "billingcycle": "integer",
    "calculation": "integer",
    "contractnum": "N-123456",
    "creationdate": 872838840,
    "creator": 6,
    "currency": "EUR",
    "datecancel": "integer (int64)",
    "datefrom": 872838840,
    "dateto": "integer (int64)",
    "description": "string",
    "exchangerate": "number (double)",
    "lastbilling": "integer (int64)",
    "lastmodified": 872838840,
    "name": "My Contract",
    "ownergroup": "integer (int32)",
    "status": "integer",
    "visibility": "integer"
  }
]

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

Response Example (500 Internal Server Error)

"I am afraid I can't do that Dave!"

contracts

Create new contract

PUT /contracts

Create a new contract and return it's persistent data. Requires writable contracts permission.

body

in formData

object

(no description)

201 Created

contracts

Successful Creation (Created)

401 Unauthorized

Unauthorized

type

string

403 Forbidden

Forbidden

type

string

409 Conflict

ID Present (Conflict)

410 Gone

Gone

500 Internal Server Error

Runtime Error (Internal Server Error)

type

string

Response Content-Types: application/json

Response Example (201 Created)

{
  "ID": 1,
  "account": 7,
  "assigneduser": 6,
  "billingcycle": "integer",
  "calculation": "integer",
  "contractnum": "N-123456",
  "creationdate": 872838840,
  "creator": 6,
  "currency": "EUR",
  "datecancel": "integer (int64)",
  "datefrom": 872838840,
  "dateto": "integer (int64)",
  "description": "string",
  "exchangerate": "number (double)",
  "lastbilling": "integer (int64)",
  "lastmodified": 872838840,
  "name": "My Contract",
  "ownergroup": "integer (int32)",
  "status": "integer",
  "visibility": "integer"
}

Response Headers (201 Created)


ETag	Entity tag ( RFC 7232)	object

Response Example (401 Unauthorized)

"Unauthorized: Invalid token for bearer authentication"

Response Headers (401 Unauthorized)


WWW-Authenticate	Preferred authentication scheme ( RFC 7235)	object

Response Example (403 Forbidden)

"Forbidden: Lacking access permission"

ZeyOS Standard REST API API Reference

Return Values and Error Handling

Data Retrieval

Field Selection

Filters

Search Queries

Sorting

Pagination

Expanding JSON and Binary Data

API Endpoint

Terms of Service: https://www.zeyos.com/termsofservice

Contact: info@zeyos.com

Schemes: https

Version: v1

Authentication

Obtaining a login token with CURL

session

token

general

Get system configuration

Response Content-Types: text/plain

Response Example (200 OK)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (500 Internal Server Error)

Get application settings

Response Content-Types: application/json

Response Example (200 OK)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (500 Internal Server Error)

accounts

List accounts

Response Content-Types: text/plain

Response Example (200 OK)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (403 Forbidden)

Response Example (500 Internal Server Error)

Create new account

Response Content-Types: application/json

Response Example (201 Created)

Response Headers (201 Created)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (403 Forbidden)

Response Example (500 Internal Server Error)

Delete account

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (403 Forbidden)

Response Example (500 Internal Server Error)

Get account

Response Content-Types: application/json

Response Example (200 OK)

Response Headers (200 OK)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (403 Forbidden)

Response Example (500 Internal Server Error)

Check if account exists

Response Headers (204 No Content)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (500 Internal Server Error)

Update existing account

Response Content-Types: application/json

Response Example (200 OK)

Response Headers (200 OK)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (403 Forbidden)

Response Example (500 Internal Server Error)

actionsteps

List actionsteps

Response Content-Types: application/json

Response Example (200 OK)

Response Example (401 Unauthorized)

Response Headers (401 Unauthorized)

Response Example (403 Forbidden)