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 toIN
: 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"
}]
Obtaining a login token with CURL
$ 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
}
token
HTTP Bearer Authentication (
RFC 6750); use the
ZeyOS Authentication API
's
POST /auth/v1/login
to obtain a valid bearer token
general
Get system configuration
Return the user-visible system configuration.
OK
Unauthorized
Runtime Error (Internal Server Error)
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!"
Get application settings
Return the settings of the application that was used for authentication.
OK
Unauthorized
Runtime Error (Internal Server Error)
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
List selected data from all accounts that match the specified filter and search criteria in a specific sort order. Requires accounts
permission.
Return number of results only (fields
, sort
, limit
, offset
and expand
have no effect)
Export result as CSV file (type text/csv
, delimiter ;
) with unbounded limit
(admin)
Return distinct result set
Select specified fields only; use optional alias as object key
Eliminate results that do not match specified filter criteria
Eliminate results that do not match specified query search pattern
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 to total number of results (defaults to 1000, unless export
is true)
Return results forward from specified offset only
Expand content of composite fields (binfile
, json
or array
)
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new account
Create a new account and return it's persistent data. Requires writable accounts
permission.
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Runtime Error (Internal Server Error)
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!"
Delete account
Permanently delete an existing account by
ID
. Requires writable accounts
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get account
Return the data of an existing account by
ID
. Requires accounts
permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return all extension data field and value pairs in pseudo field extdata
Return list of all tags in pseudo field tags
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if account exists
Check if an account with
ID
exists, but do not return it's data. Requires accounts
permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing account
Update an existing account by
ID
and return it's persistent data. Requires writable accounts
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all action steps that match the specified filter and search criteria in a specific sort order. Requires actionsteps
permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new action step
Create a new action step and return it's persistent data. Requires writable actionsteps
permission.
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete action step
Permanently delete an existing action step by
ID
. Requires writable actionsteps
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get action step
Return the data of an existing action step by
ID
. Requires actionsteps
permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return all extension data field and value pairs in pseudo field extdata
Return list of all tags in pseudo field tags
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if action step exists
Check if an action step with
ID
exists, but do not return it's data. Requires actionsteps
permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing action step
Update an existing action step by
ID
and return it's persistent data. Requires writable actionsteps
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
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
.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new address
Create a new address and return it's persistent data. Requires writable accounts
permission. Has dependency on account
.
Address ID
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
Last modification date and time as a Unix time stamp (auto-reset on modification)
Account ID ( dependency)
Contact ID
Address type (0
=BILLING_SHIPPING, 1
=BILLING_BILLING, 2
=PROCUREMENT_SHIPPING, 3
=PROCUREMENT_BILLING, 4
=COLLECTION)
Default for this address type
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete address
Permanently delete an existing address by
ID
. Requires writable accounts
permission. Has dependency on account
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get address
Return the data of an existing address by
ID
. Requires accounts
permission. Has dependency on account
.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if address exists
Check if an address with
ID
exists, but do not return it's data. Requires accounts
permission. Has dependency on account
.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing address
Update an existing address by
ID
and return it's persistent data. Requires writable accounts
permission. Has dependency on account
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List applications
List selected data from all applications that match the specified filter and search criteria in a specific sort order. Requires dev
permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Get application
Return the data of an existing application by
ID
. Requires dev
permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return all extension data field and value pairs in pseudo field extdata
Return list of all tags in pseudo field tags
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if application exists
Check if an application with
ID
exists, but do not return it's data. Requires dev
permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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
List selected data from all appointments that match the specified filter and search criteria in a specific sort order. Requires calendar
permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new appointment
Create a new appointment and return it's persistent data. Requires writable calendar
permission.
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete appointment
Permanently delete an existing appointment by
ID
. Requires writable calendar
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get appointment
Return the data of an existing appointment by
ID
. Requires calendar
permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return all extension data field and value pairs in pseudo field extdata
Return list of all tags in pseudo field tags
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if appointment exists
Check if an appointment with
ID
exists, but do not return it's data. Requires calendar
permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing appointment
Update an existing appointment by
ID
and return it's persistent data. Requires writable calendar
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all associations that match the specified filter and search criteria in a specific sort order. Requires no specific permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new association
Create a new association and return it's persistent data. Requires no specific permission.
Association ID
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
First canonical entity
Second canonical entity
First entity ID
Second entity ID
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete association
Permanently delete an existing association by
ID
. Requires no specific permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get association
Return the data of an existing association by
ID
. Requires no specific permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if association exists
Check if an association with
ID
exists, but do not return it's data. Requires no specific permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing association
Update an existing association by
ID
and return it's persistent data. Requires no specific permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all bin files that match the specified filter and search criteria in a specific sort order. Requires no specific permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Get bin file
Return the data of an existing bin file by
ID
. Requires no specific permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if bin file exists
Check if a bin file with
ID
exists, but do not return it's data. Requires no specific permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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
List selected data from all campaigns that match the specified filter and search criteria in a specific sort order. Requires campaigns
permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new campaign
Create a new campaign and return it's persistent data. Requires writable campaigns
permission.
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete campaign
Permanently delete an existing campaign by
ID
. Requires writable campaigns
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get campaign
Return the data of an existing campaign by
ID
. Requires campaigns
permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return all extension data field and value pairs in pseudo field extdata
Return list of all tags in pseudo field tags
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if campaign exists
Check if a campaign with
ID
exists, but do not return it's data. Requires campaigns
permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing campaign
Update an existing campaign by
ID
and return it's persistent data. Requires writable campaigns
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all categories that match the specified filter and search criteria in a specific sort order. Requires no specific permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new category
Create a new category and return it's persistent data. Requires no specific permission.
Category ID
Owner user ID (PUBLIC if owneruser
=null
and ownergroup
=null
)
Owner group ID (PUBLIC if owneruser
=null
and ownergroup
=null
)
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
Canonical entity
Name
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete category
Permanently delete an existing category by
ID
. Requires no specific permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get category
Return the data of an existing category by
ID
. Requires no specific permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if category exists
Check if a category with
ID
exists, but do not return it's data. Requires no specific permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing category
Update an existing category by
ID
and return it's persistent data. Requires no specific permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all channels that match the specified filter and search criteria in a specific sort order. Requires no specific permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new channel
Create a new channel and return it's persistent data. Requires no specific permission.
Channel ID
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
Name (unique)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete channel
Permanently delete an existing channel by
ID
. Requires no specific permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get channel
Return the data of an existing channel by
ID
. Requires no specific permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if channel exists
Check if a channel with
ID
exists, but do not return it's data. Requires no specific permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing channel
Update an existing channel by
ID
and return it's persistent data. Requires no specific permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
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
.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new comment
Create a new comment and return it's persistent data. Requires the authenticated user to be the creator
. Has dependency on record
.
Comment ID
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
Record ID ( dependency)
Sender
Comment text ( Markdown for rich text representation)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete comment
Permanently delete an existing comment by
ID
. Requires the authenticated user to be the creator
. Has dependency on record
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get comment
Return the data of an existing comment by
ID
. Requires no specific permission. Has dependency on record
.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if comment exists
Check if a comment with
ID
exists, but do not return it's data. Requires no specific permission. Has dependency on record
.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing comment
Update an existing comment by
ID
and return it's persistent data. Requires the authenticated user to be the creator
. Has dependency on record
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
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
.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new component
Create a new component and return it's persistent data. Requires writable inventory
permission. Has dependency on item
.
Component ID
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
Last modification date and time as a Unix time stamp (auto-reset on modification)
Item ID ( dependency)
Component item ID; must be distinct from item
Amount (quantity)
Imputed price per unit
Fixed quantity
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete component
Permanently delete an existing component by
ID
. Requires writable inventory
permission. Has dependency on item
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get component
Return the data of an existing component by
ID
. Requires inventory
permission. Has dependency on item
.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if component exists
Check if a component with
ID
exists, but do not return it's data. Requires inventory
permission. Has dependency on item
.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing component
Update an existing component by
ID
and return it's persistent data. Requires writable inventory
permission. Has dependency on item
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all contacts that match the specified filter and search criteria in a specific sort order. Requires contacts
permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new contact
Create a new contact and return it's persistent data. Requires writable contacts
permission.
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete contact
Permanently delete an existing contact by
ID
. Requires writable contacts
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get contact
Return the data of an existing contact by
ID
. Requires contacts
permission.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return all extension data field and value pairs in pseudo field extdata
Return list of all tags in pseudo field tags
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if contact exists
Check if a contact with
ID
exists, but do not return it's data. Requires contacts
permission.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing contact
Update an existing contact by
ID
and return it's persistent data. Requires writable contacts
permission.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
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
.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new contact-to-contact
Create a new contact-to-contact and return it's persistent data. Requires writable contacts
permission. Has dependencies on contact1
and contact2
.
Contact-to-contact ID
Creator user ID (defaults to authenticated user on creation)
Creation date and time as a Unix time stamp (defaults to current date and time on creation)
First contact ID ( dependency)
Second contact ID ( dependency)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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!"
Delete contact-to-contact
Permanently delete an existing contact-to-contact by
ID
. Requires writable contacts
permission. Has dependencies on contact1
and contact2
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Deletion (No Content)
Unauthorized
Forbidden
Not Found
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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!"
Get contact-to-contact
Return the data of an existing contact-to-contact by
ID
. Requires contacts
permission. Has dependencies on contact1
and contact2
.
Unique ID
Expand content of composite fields (binfile
, json
or array
)
Return status code
304
on matching entity tag (
RFC 7232)
OK
Not Modified
Unauthorized
Forbidden
Not Found
Runtime Error (Internal Server Error)
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!"
Check if contact-to-contact exists
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
.
Unique ID
Return status code
304
on matching entity tag (
RFC 7232)
Exists (No Content)
Not Modified
Unauthorized
Not Found
Runtime Error (Internal Server Error)
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!"
Update existing contact-to-contact
Update an existing contact-to-contact by
ID
and return it's persistent data. Requires writable contacts
permission. Has dependencies on contact1
and contact2
.
Unique ID
Return status code
412
on non-matching entity tag (
RFC 7232)
Successful Update (OK)
Unauthorized
Forbidden
Not Found
Non-matching ID (Conflict)
Gone
Non-matching ETag (Precondition Failed)
Runtime Error (Internal Server Error)
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
List selected data from all contracts that match the specified filter and search criteria in a specific sort order. Requires contracts
permission.
OK
Unauthorized
Forbidden
Runtime Error (Internal Server Error)
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!"
Create new contract
Create a new contract and return it's persistent data. Requires writable contracts
permission.
(no description)
Successful Creation (Created)
Unauthorized
Forbidden
ID Present (Conflict)
Gone
Runtime Error (Internal Server Error)
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"