Introduction
This pages describes the HTTP API of the OX Middleware.
Low level protocol
The client accesses the server through HTTP GET, POST and PUT requests. HTTP cookies are used for authentication and must therefore be processed and sent back by the client as
specified by RFC 6265. The HTTP API is accessible at URIs starting with /ajax
. Each server module has a unique name and its own sub-namespace with
that name below /ajax
, e. g. all access to the module "tasks" is via URIs starting with /ajax/tasks
.
Text encoding is always UTF-8. Data is sent from the server to the client as application/json
and interpreted by the client to obtain an ECMAScript object.
The HTTP API uses only a small subset of the ECMAScript syntax. This subset is roughly described by the following BNF:
Value ::= "null" | Boolean | Number | String | Array | Object
Boolean ::= "true" | "false"
Number ::= see NumericLiteral in ECMA 262 3rd edition
String ::= \"([^"\n\\]|\\["\n\\])*\"
Array ::= "[]" | "[" Value ("," Value)* "]"
Object ::= "{}" | "{" Name ":" Value ("," Name ":" Value)* "}"
Name ::= [A-Fa-f][0-9A-Fa-f_]*
Numbers are the standard signed integer and floating point numbers. Strings can contain any character, except double quotes, newlines and backslashes, which must be escaped by a backslash. Control characters in strings (other than newline) are not supported. Whitespace is allowed between any two tokens. See JSON and ECMA 262, 3rd edition for the formal definition.
The response body consists of an object, which contains up to four fields as described in Response body. The field data contains the actual payload which is described in following chapters.
The fields timestamp
, error
and error_params
are present when data objects are returned, if an error occurred and if the error message contains conversion specifiers, respectively.
Following sections describe the contents of these fields in more detail.
Name | Type | Value |
---|---|---|
data | Value | Payload of the response. |
timestamp | Timestamp | The latest timestamp of the returned data (see Updates). |
error | String | The translated error message. Present in case of errors. |
error_params | Array | As of 7.4.2: Empty JSON array. Before that: Parameters for the error message that would need to be replaced in the error string (in a printf-format style). |
error_id | String | Unique error identifier to help finding this error instance in the server logs. |
error_desc | String | The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available |
code | String | Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012" |
error_stack | Array | If configured (see "com.openexchange.ajax.response.includeStackTraceOnError" in 'server.properties') this field provides the stack trace of associated Java exception represented as a JSON array |
categories | String OR Array | Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs. |
category | Number | Maintained for legacy reasons: The numeric representation of the first category. |
The following table shows the different category identifiers:
Name | Description |
---|---|
USER_INPUT | An error resulting from wrong or missing input from front-end (e.g. mandatory field missing). |
CONFIGURATION | An error related to user/system configuration which denies requested operation. |
PERMISSION_DENIED | An error related to insufficient permission settings. |
TRY_AGAIN | A requested operation could not be accomplished because a needed resource is temporary down or missing (e.g. imap server rejects connection because of too many established connections). |
SERVICE_DOWN | A subsystem or third party service is down and therefore does not respond (e.g. database is down). |
CONNECTIVITY | The underlying socket connection is corrupt, empty or closed. Only a temporary error that does not affect the whole system. |
ERROR | A programming error which was caused by incorrect program code. |
CONFLICT | A concurrent modification. |
CAPACITY | The requested operation could not be performed cause an underlying resource is full or busy (e.g. IMAP folder exceeds quota). |
TRUNCATED | The given data could not be stored into the database because an attribute contains a too long value. |
WARNING | Action was at least partially successful, but a condition occurred that merited a warning |
Data from the client to the server can be sent in several formats. Small amounts of data are sent as application/x-www-urlencoded
in query parameters in the request URI.
For POST requests, some or all parameters may be sent in the request body instead of in the URI using any valid encoding for POST requests.
Alternatively, some requests specify that data is sent as text/javascript
in the body of a PUT request. The format of the request body for PUT requests is the same as for sending
data from the server to the client, except that the payload is sent directly, without being wrapped in another object.
When updating existing data, the client sends only fields that were modified. To explicitly delete a field, the field is sent with the value null.
For fields of type String
, the empty string "" is equivalent to null
.
Error handling
If the session of the user times out, if the client doesn't send a session ID or if the session for the specified session ID can not be found then the server returns the above described response object, that contains an error code and an error message. If the request URI or the request body is malformed or incomplete then the server returns the reponse object with an error message, too. In case of internal server errors, especially Java exceptions, or if the server is down, it returns the HTTP status code 503, Service Unavailable. Other severe errors may return other HTTP status values.
Application errors, which can be caused by a user and are therefore expected during the operation of the groupware, are reported by setting the field error in the returned object, as described in
the Response body. Since the error messages are translated by the client, they can not be composed of multiple variable parts. Instead, the error message can contain simplified printf()-style
conversion specifications, which are replaced by elements from the array in the field error_params
. If error_params
is not present, no replacement occurs, even if parts of the error message
match the syntax of a conversion specification.
A simplified conversion specification, as used for error messages, is either of the form %s or %n$s, where n is a 1-based decimal parameter index.
The conversion specifications are replaced from left to right by elements from error_params
, starting at the first element. %s is replaced by the current element
and the current index is incremented. %n$s is replaced by the n'th element and the current index is set to the (n + 1)'th element.
Some error message contain data sizes which must be expressed in Bytes or Kilobytes etc., depending on the actual value. Since the unit must be translated, this conversion is performed by the client. Unfortunately, standard printf()-style formatting does not have a specifier for this kind of translation. Therefore, the conversion specification for sizes is the same as for normal strings, and the client has to determine which parameters to translate based on the error code. The current error codes and the corresponding size parameters are listed below:
Error code | Parameter indices |
---|---|
CON-0101 | 2, 3 |
FLS-0003 | 1, 2, 3 |
MSG-0065 | 1, 3 |
MSG-0066 | 1 |
NON-0005 | 1, 2 |
Date and time
Dates without time are transmitted as the number of milliseconds between 00:00 UTC on that date and 1970-01-01 00:00 UTC. Leap seconds are ignored, therefore this number is always an integer multiple of 8.64e7.
Because ECMAScript Date objects have no way to explicitly specify a timezone for calculations, timezone correction must be performed on the server.
Dates with time are transmitted as the number of milliseconds since 1970-01-01 00:00 UTC (again, ignoring leap seconds) plus the offset between the user's timezone and UTC at the time in question.
(See the Java method java.util.TimeZone.getOffset(long)). Unless optional URL parameter timezone
is present.
Then dates with time are transmitted as the number of milliseconds since 1970-01-01 00:00 UTC (again, ignoring leap seconds) plus the offset between the specified timezone and
UTC at the time in question.
To prevent the timezone offset getting applied implicitly on the server for dates with time, e.g. because the client handles timezones on his own, requests should be decorated with the URL parameter timezone
set to UTC
statically.
For some date and time values, especially timestamps, monotonicity is more important than the actual value. Such values are transmitted as the number of milliseconds since 1970-01-01 00:00 UTC, ignoring leap seconds and without timezone correction. If possible, a unique strictly monotonic increasing value should be used instead, as it avoids some race conditions described below.
This specification refers to these three interpretations of the type Number as separate data types.
Type | Time | Timezone | Comment |
---|---|---|---|
Date | No | UTC | Date without time. |
Time | Yes | User | Date and time. |
Timestamp | Yes | UTC | Timestamp or unique sequence number. |
Updates
To allow efficient synchronization of a client with changes made by other clients and to detect conflicts, the server stores a timestamp of the last modification for each object.
Whenever the server transmits data objects to the client, the response object described in Response body includes the field timestamp
.
This field contains a timestamp value which is computed as the maximum of the timestamps of all transmitted objects.
When requesting updates to a previously retrieved set of objects, the client sends the last timestamp which belongs to that set of objects. The response contains all updates with timestamps greater than the one specified by the client. The field timestamp of the response contains the new maximum timestamp value.
If multiple different objects may have the same timestamp values, then a race condition exists when an update is processed between two such objects being modified. The first, already modified object will be included in the update response and its timestamp will be the maximum timestamp value sent in the timestamp field of the response. If the second object is modified later but gets the same timestamp, the client will never see the update to that object because the next update request from the client supplies the same timestamp value, but only modifications with greater timestamp values are returned.
If unique sequence numbers can't be used as timestamps, then the risk of the race condition can be at least minimized by storing timestamps in the most precise format and/or limiting update results to changes with timestamp values which are measurably smaller than the current timestamp value.
Editing
Editing objects is performed one object at a time. There may be multiple objects being edited by the same client simulataneously, but this is achieved by repeating the steps required for editing a single object. There is no batch edit or upload command.
To edit an object, a client first requests the entire object from the server. The server response contains the timestamp
field described in the previous section.
For in-place editing inside a view of multiple objects, where only already retrieved fields can be changed, retrieving the entire object is not necessary, and the last timestamp
of the view is used as the timestamp of each object in it.
When sending the modified object back to the server, only modified fields need to be included in the sent object. The request also includes the timestamp of the edited object. The timestamp is used by the server to ensure that the object was not edited by another client in the meantime. If the current timestamp of the object is greater than the timestamp supplied by the client, then a conflict is detected and the field error is set in the response. Otherwise, the object gets a new timestamp and the response to the client is empty.
If the client displays the edited object in a view together with other objects, then the client will need to perform an update of that view immediately after successfully uploading an edited object.
File uploads
File uploads are made by sending a POST request that submits both the file and the needed fields as parts of a request of content-type “multipart/form-data” or “multipart/mixed”.
The file metadata are stored in a form field “file” (much like an <input type=”file” name=”file” />
would do). In general a call that allows file uploads via POST will have a corresponding
call using PUT to send object data. The JSON-encoded object-data that is send as the body of a corresponding PUT call is, when performed as a POST with file uploads, put into
the request parameter “json”.
Since the upload is performed directly by the browser and is not an Ajax call, the normal callback mechanism for asynchronous Javascript calls cannot be used to obtain the result. For this reason the server responds to these POST calls with a complete HTML page that performs the callback and should not be displayed to the user. The HTML response is functionally equivalent to:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<META http-equiv="Content-Type" content=\"text/html; charset=UTF-8\">
<script type="text/javascript">
(parent["callback_action"] || window.opener && window.opener["callback_action"])
({json})
</script>
</head>
</html>
The placeholders {json}
is replaced by the response with the timestamp that would be expected from the corresponding PUT method. The placeholder action
is replaced by the value of the
parameter action
of the request (except for the import bundle, which is named "import" instead of the action name for legacy purposes). The content-type of the answer is text/html
.
Non-browser clients don't need to interpret HTML or JavaScript. The JSON data can be recognized by the outermost ({
and })
, where the inner braces are part of the JSON value.
For example, the regular expression \((\{.*\})\)
captures the entire JSON value in its first capturing group.
The client can also send the force_json_response
parameter to get errors in form of a normal json responses instead of html.
Authentication
session
The default security scheme which uses a session ID previously obtained from the login module. Used in combination with a session cookie.
oauth
The security scheme for oauth enabled modules of the middleware
Authorization grant | Available scopes |
authorization-code |
write_userconfig
|
OX HTTP API
Documentation of the Open-Xchange HTTP API which is used by the new AJAX GUI.
Results
Test-
Addressbooks
The addressbooks module is used to access contact information. In contrast to its legacy pendant "contacts", it can also be used to access data stored in external contact provider plugins.-
Finds contacts based on a prefix, usually used to auto-complete e-mail recipients while the user is typing.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string query (empty) The query to search for.
query string email (empty) Whether to only include contacts with at least one e-mail address. Defaults to `true`.
query boolean folder (empty) Object ID of the parent folder that is searched. If not set, all visible folders are used.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. If this parameter is missing, response is sorted by a user-specific use count of contacts, ID of contacts' parent folder and display name.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string left_hand_limit (empty) A positive integer number to specify the "left-hand" limit of the range to return.
query integer right_hand_limit (empty) A positive integer number to specify the "right-hand" limit of the range to return.
query integer Responses:
200:
A JSON object containing the contact data. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested contact.
query string folder (empty) Object ID of the folder who contains the contacts.
query string Responses:
200:
An object containing all data of the requested contact. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactResponse
{- data ( ContactData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Body:
Description:No description available
Content-type: application/json-
advancedSearchBody
{- filter ( string ): A JSON object describing the search term as introducted in Advanced search. If not specified, all contacts contained in the specified folders are returned. Example: `["and",["=", {"field":"last_name"},"Mustermann"],["=",{"field":"first_name"},"Max"]]` which represents 'last_name = "Mustermann" AND first_name = "Max"'. Valid fields are the ones specified in Contact data model. The field 'folder' is not allowed as operand.
- folders ( array[string] ): The identifiers of the folders to restrict the search to. If not defined, all visible folders (optionally filtered through to "folderTypes"]) are considered.
- folderTypes ( contactsSearchFolderTypes ): The kind of folders to perform the search in, if no folders are defined through "folders" explicitly.
-
contactsSearchFolderTypes - The kind of folders to perform the search in, if no folders are defined through "folders" explicitly.
{- includeUnsubscribed ( string ): Controls whether also unsubscribed folders (i.e. not visible in the tree) are considered.
- pickerOnly ( string ): Configures if only folders that are explicitly marked for usage in the picker are considered.
Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Finds contacts whose anniversary falls into a specified time range.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string start (empty) The lower (inclusive) limit of the requested time range.
query long end (empty) The upper (exclusive) limit of the requested time range.
query long folder (empty) Object ID of the parent folder that is searched. If not set, all visible folders are used.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Updates a contact's data. This request cannot change or add contact images. Therefore it is necessary to use the
POST
method.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string id (empty) Object ID of the contact that shall be updated.
query string timestamp (empty) Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.
query long Body:
Description:A JSON object containing the contact's data. Only modified fields must be specified. To remove some contact image send the image attribute set to null.
Content-type: application/json-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
A JSON object with a timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactUpdateResponse
{- data ( ContactUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactUpdateData
{- id ( string ): ID of a newly created contact.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string Body:
Description:A JSON array of JSON objects with the id and folder of the contacts.
Content-type: application/json-
ContactListElement
{- id ( string , required ): The object ID of the contact.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
A JSON object containing an array with data for the requested contacts. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Responses:
200:
A JSON object containing an array with data for all contacts. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Creates a new contact. This request cannot add contact images. Therefor it is necessary to use the
POST
method.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Body:
Description:A JSON object containing the contact's data. The field id is not included.
Content-type: application/json-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
A JSON object containing the ID of the newly created contact. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactUpdateResponse
{- data ( ContactUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactUpdateData
{- id ( string ): ID of a newly created contact.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the deleted contacts.
query long Body:
Description:A JSON array of JSON objects with the id and folder of the contacts.
Content-type: application/json-
ContactListElement
{- id ( string , required ): The object ID of the contact.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
A JSON array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactDeletionsResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Finds contacts whose birthday falls into a specified time range.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string start (empty) The lower (inclusive) limit of the requested time range.
query long end (empty) The upper (exclusive) limit of the requested time range.
query long folder (empty) Object ID of the parent folder that is searched. If not set, all visible folders are used.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string timestamp (empty) Timestamp of the last update of the requested contacts.
query long ignore Which kinds of updates should be ignored. Omit this parameter or set it to "deleted" to not have deleted tasks identifier in the response. Set this parameter to `false` and the response contains deleted tasks identifier.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted contacts (should the ignore parameter be ever implemented) would be identified by their object IDs as integers, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactUpdatesResponse
{- data ( data ): Array of contacts.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
Advertisement
Via the advertisement module the client can retrieve the advertisement configuration-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
'The configuration as a JSON object or in case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
Unknown
-
-
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
Application Data
{- uuid ( string ): Type uuid of the password to remove
Responses:
200:
A JSON object containing the result, which should be OK, otherwise error. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppPasswordRemovalResponse
{- data ( data ): Registration response data
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data - Registration response data
{- result ( string ): Result of the operation
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the existing password list. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppPasswordListResponse
{- data ( array[AppPassword] ): Array of application specific passwords.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppPassword
{- UUID ( string ): The id of the password
- Scope ( string ): The application type that defines the scope
- Name ( string ): The user defined name of the password
- LastDevice ( string ): The last device that logged in using the password
- LastLogin ( string ): The last date and time the password was used for login
- IP ( string ): The IP address of the device used to login
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the list of available applications. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppPasswordGetAppsResponse
{- data ( array[AppPasswordApplication] ): Array of application type available.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppPasswordApplication
{- name ( string ): The name of the scope
- displayName ( string ): The display name of the scope to be shown to user
- sort ( integer ): Optional sort order
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
Application Data
{- appScope ( string ): The scope name of the application
- appName ( string ): The user chosen name for the application password
Responses:
200:
A JSON object containing the username and password to use in login. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppPasswordRegistrationResponse
{- data ( data ): Registration response data
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data - Registration response data
{- password ( string ): Password to use for the application login
- login ( string ): The username to use for login
- newLogin ( boolean ): Login may not be same as used by the user to login to appsuite.
-
-
-
Attachments
The module attachments allows file attachments to arbitrary objects. An attachment always belongs to an object (called 'attached') in a certain folder of a certain module.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer Body:
Description:A JSON array with the identifiers of the attachments that shall be deleted.
Content-type: application/json
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks Name Scopes oauth
read_calendar Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested infoitem.
query string attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer Responses:
200:
A JSON object containing all data of the requested attachment. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AttachmentResponse
{- data ( AttachmentData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AttachmentData
{- folder ( integer ): The ID of the first folder in which the attached object resides.
- attached ( integer ): The ID of the object this attachment is attached to.
-
module
(
integer
, possibleValues:
1
4
7
137
* 1 (appointment),
* 4 (task),
* 7 (contact),
* 137 (infostore) - filename ( string ): The filename of the attached file.
- file_size ( integer ): The file size (in bytes) of the attached file.
- file_mimetype ( string ): The MIME type of the attached file.
- rft_flag ( boolean ): If the attachment is a RTF attachment of outlook (outlook descriptions can be stored as RTF documents).
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer Body:
Description:A JSON array with the identifiers of the attachments, which shall be put into ZIP archive
Content-type: application/json
Responses:
200:
The raw byte data of the ZIP archive.
Content-type: application/zip-
Unknown
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks Name Scopes oauth
read_calendar Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer columns (empty) A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Common object data and Attachment data.
query string Body:
Description:A JSON array with the identifiers of the requested attachments.
Content-type: application/json
Responses:
200:
A JSON object containing an array with data for the requested infoitems. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer columns (empty) A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Common object data and Attachment data.
query string module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer timestamp (empty) Timestamp of the last update of the requested infoitems.
query long ignore Which kinds of updates should be ignored. Currently, the only valid value – "deleted" – causes deleted object IDs not to be returned.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
An array with new and deleted attachments. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted attachments would be identified by their object IDs as integer, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AttachmentUpdatesResponse
{- data ( data ): Array of attachments.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Note
It is possible to create multiple attachments at once. Therefor add additional form fields and replace "[index]" in
json_[index]
andfile_[index]
with the appropriate index, likejson_1
,file_1
. The index always starts with 0 (mandatory attachment object).Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Body:
Description:No description available
Content-type: multipart/form-data-
createAttachmentBody
{- json_0 ( string , required ): A JSON string representing an attachment object as described in AttachmentData model with at least the fields `folder`, `attached` and `module`.
- file_0 ( string , required ): The attachment file as per ``.
Responses:
200:
A HTML page as described in File uploads containing a JSON array of object IDs of the newly created attachments or errors if some occurred.
Content-type: text/html-
Unknown
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks Name Scopes oauth
read_calendar Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer columns (empty) A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Common object data and Attachment data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
A JSON object containing an array with data for all attachments. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AttachmentsResponse
{- data ( data ): Array of attachments. Each attachment is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
It is possible to add a filename to the request's URI like
/attachment/{filename}?action=document
. The filename may be added to the customary attachment path to suggest a filename to a Save-As dialog.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer id (empty) Object ID of the requested attachment.
query string content_type (empty) If present the response declares the given `content_type` in the Content-Type header and not the attachments file MIME type.
query string scan (empty) Flag to request an Anti-Virus scan for the specified attachment before downloading it.
query boolean Responses:
200:
The raw byte data of the document. The response type for the HTTP request is set accordingly to the defined MIME type for this attachment or the content_type given.
Content-type: application/octet-stream-
Unknown
-
-
-
Autoconfig
The module autoconfig can be used to request the best available settings for an appropriate mail server.-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
autoConfigBody
{- email ( string , required ): The email address for which a mail configuration will be discovered.
- password ( string , required ): The corresponding password for the mail account.
- force_secure ( boolean ): Enforces a secure connection for configured mail account, default is `true`.
- oauth ( integer ): The optional identifier of the OAuth account to use for authentication.
Responses:
200:
A JSON object containing the best available settings for an appropriate mail server for the given email address. The data may be incomplete or empty. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AutoConfigResponse
{- data ( MailAccountData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
-
-
-
Calendar
The calendar module is used to access calendar data.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type start (empty) Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.
query long end (empty) Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.
query long Responses:
200:
A JSON object containing an array with the length of the number of days between `start` and `end`. Meaning, each element corresponds with one day in the range that was queried, explaining whether there is an appointment on this day (true) or not (false). In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentInfoResponse
{- data ( array[boolean] ): Array with elements that correspond with days in the time range, explaining whether a day has appointments or not.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the appointment series.
query string folder (empty) Object ID of the folder who contains the appointments.
query string columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.
query string Responses:
200:
A JSON object containing an array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentsResponse
{- data ( data ): Array of appointments. Each appointment is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested appointment.
query string ignore_conflicts (empty) Flag indicating whether conflicts should be ignored or not.
query boolean folder (empty) Object ID of the folder who contains the appointments.
query string timezone (empty) The timezone which should be used
query string Body:
Description:A JSON object containing the new destination folder id.
Content-type: application/json-
CalendarCopyBody
{- folder_id ( string ): ID of the destination folder.
Responses:
200:
'A JSON object containing the id of the newly created appointment if it was created successfully. If the appointment could not be created due to conflicts, the response body is an object with the field `conflicts`, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field `hard_conflict` with the Boolean value `true`. If the user does not have read access to a conflicting appointment, only the fields `id`, `start_date`, `end_date`, `shown_as` and `participants` are present and the field `participants` contains only the participants which caused the conflict. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
AppointmentCreationResponse
{- data ( AppointmentCreationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentCreationData
{- id ( string ): ID of the appointment.
- conflicts ( array[AppointmentCreationConflict] ): An array of appointments which cause conflicts.
-
AppointmentCreationConflict
{- hard_conflicts ( boolean ): `true` if appointment represents a resource conflict.
- recurrence_id ( integer ): Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.
- recurrence_position ( integer ): 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- recurrence_date_position ( integer ): Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- change_exceptions ( array[integer] , read only ): An array of Dates, representing all change exceptions of a sequence.
- delete_exceptions ( array[integer] , read only ): An array of Dates, representing all delete exceptions of a sequence.
- location ( string ): The location of the appointment.
-
shown_as
(
integer
, possibleValues:
1
2
3
4
* 1 (reserved),
* 2 (temporary),
* 3 (absent),
* 4 (free) - timezone ( string ): The timezone of the appointment.
- recurrence_start ( integer ): Start of a sequence without time.
- ignore_conflicts ( boolean ): Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Body:
Description:A JSON object containing the appointment's data.
Content-type: application/json-
AppointmentData
{- recurrence_id ( integer ): Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.
- recurrence_position ( integer ): 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- recurrence_date_position ( integer ): Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- change_exceptions ( array[integer] , read only ): An array of Dates, representing all change exceptions of a sequence.
- delete_exceptions ( array[integer] , read only ): An array of Dates, representing all delete exceptions of a sequence.
- location ( string ): The location of the appointment.
-
shown_as
(
integer
, possibleValues:
1
2
3
4
* 1 (reserved),
* 2 (temporary),
* 3 (absent),
* 4 (free) - timezone ( string ): The timezone of the appointment.
- recurrence_start ( integer ): Start of a sequence without time.
- ignore_conflicts ( boolean ): Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
Responses:
200:
'A JSON object containing the id of the newly created appointment if it was created successfully. If the appointment could not be created due to conflicts, the response body is an object with the field `conflicts`, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field `hard_conflict` with the Boolean value `true`. If the user does not have read access to a conflicting appointment, only the fields `id`, `start_date`, `end_date`, `shown_as` and `participants` are present and the field `participants` contains only the participants which caused the conflict. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
AppointmentCreationResponse
{- data ( AppointmentCreationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentCreationData
{- id ( string ): ID of the appointment.
- conflicts ( array[AppointmentCreationConflict] ): An array of appointments which cause conflicts.
-
AppointmentCreationConflict
{- hard_conflicts ( boolean ): `true` if appointment represents a resource conflict.
- recurrence_id ( integer ): Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.
- recurrence_position ( integer ): 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- recurrence_date_position ( integer ): Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- change_exceptions ( array[integer] , read only ): An array of Dates, representing all change exceptions of a sequence.
- delete_exceptions ( array[integer] , read only ): An array of Dates, representing all delete exceptions of a sequence.
- location ( string ): The location of the appointment.
-
shown_as
(
integer
, possibleValues:
1
2
3
4
* 1 (reserved),
* 2 (temporary),
* 3 (absent),
* 4 (free) - timezone ( string ): The timezone of the appointment.
- recurrence_start ( integer ): Start of a sequence without time.
- ignore_conflicts ( boolean ): Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.
query string start (empty) Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.
query long end (empty) Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.
query long folder (empty) Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.
query string recurrence_master (empty) Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.
query boolean Responses:
200:
A JSON object containing an array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field `start_date`. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentsResponse
{- data ( data ): Array of appointments. Each appointment is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the deleted appointments.
query long Body:
Description:A JSON array of JSON objects with the id, folder and optionally the recurrence position (if present in an appointment to fully identify it) of the appointments.
Content-type: application/json-
AppointmentDeletionsElement
{- id ( string , required ): The object ID of the appointment.
- folder ( string , required ): The object ID of the related folder.
- pos ( integer ): Value of the field recurrence_position, if present in the appointment.
Responses:
200:
A JSON array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentDeletionsResponse
{- data ( array[AppointmentDeletionsElement] ): An array with object IDs of appointments which were modified after the specified timestamp and were therefore not deleted.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentDeletionsElement
{- id ( string , required ): The object ID of the appointment.
- folder ( string , required ): The object ID of the related folder.
- pos ( integer ): Value of the field recurrence_position, if present in the appointment.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.
query string timestamp (empty) Timestamp of the last update of the requested appointments.
query long folder (empty) Object ID of the folder, whose contents are queried. That parameter may be absent in case ignore is set to "deleted", which means all accessible calendar folders are considered. If ignore is not set to "deleted", that parameter is mandatory.
query string start (empty) Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned. This parameter is optional in case a certain folder is queried, but mandatory if all accessible calendar folders are supposed to be considered (folder not specified).
query long end (empty) Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned. This parameter is optional in case a certain folder is queried, but mandatory if all accessible calendar folders are supposed to be considered (folder not specified).
query long ignore Which kinds of updates should be ignored. Currently, the only valid value – "deleted" – causes deleted object IDs not to be returned.
query string recurrence_master (empty) Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.
query boolean Responses:
200:
An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted appointments (should the ignore parameter be ever implemented) would be identified by their object IDs as integers, without being part of a nested array. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentUpdatesResponse
{- data ( data ): Array of appointments.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.
query string recurrence_master (empty) Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.
query boolean Body:
Description:A JSON array of JSON objects with the id, folder and optionally either recurrence_position or recurrence_date_position of the requested appointments.
Content-type: application/json-
AppointmentListElement
{- id ( string , required ): The object ID of the appointment.
- folder ( string , required ): The object ID of the related folder.
- recurrence_position ( integer ): 1-based position of an individual appointment in a sequence.
- recurrence_date_position ( integer ): Date of an individual appointment in a sequence.
Responses:
200:
A JSON object containing an array with data for the requested appointments. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentsResponse
{- data ( data ): Array of appointments. Each appointment is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Internal user id. Must be obtained from the contact module.
query integer start (empty) Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.
query long end (empty) Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.
query long type Constant for user or resource (1 for users, 3 for resources).
query integer Responses:
200:
An array of objects identifying the appointments which lie between start and end as described. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentFreeBusyResponse
{- data ( array[AppointmentFreeBusyItem] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentFreeBusyItem
{- full_time ( boolean ): True if the event is a whole day appointment or task, false otherwise.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
-
shown_as
(
integer
, possibleValues:
1
2
3
4
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested appointment.
query string folder (empty) Object ID of the folder who contains the appointments.
query string timestamp (empty) Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.
query long Body:
Description:A JSON object containing the appointment's data. The field `recurrence_id` is always present if it is present in the original appointment. The field `recurrence_position` is present if it is present in the original appointment and only this single appointment should be modified. The field `id` is not present because it is already included as a parameter. Other fields are present only if modified.
Content-type: application/json-
AppointmentData
{- recurrence_id ( integer ): Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.
- recurrence_position ( integer ): 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- recurrence_date_position ( integer ): Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- change_exceptions ( array[integer] , read only ): An array of Dates, representing all change exceptions of a sequence.
- delete_exceptions ( array[integer] , read only ): An array of Dates, representing all delete exceptions of a sequence.
- location ( string ): The location of the appointment.
-
shown_as
(
integer
, possibleValues:
1
2
3
4
* 1 (reserved),
* 2 (temporary),
* 3 (absent),
* 4 (free) - timezone ( string ): The timezone of the appointment.
- recurrence_start ( integer ): Start of a sequence without time.
- ignore_conflicts ( boolean ): Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
Responses:
200:
A JSON object containing the id of the updated appointment. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentUpdateResponse
{- data ( AppointmentUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentUpdateData
{- id ( string ): ID of the appointment.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the appointment that shall be confirmed.
query string folder (empty) Object ID of the folder who contains the appointments.
query string timestamp (empty) Timestamp of the last update of the appointment.
query long occurrence (empty) The numeric identifier of the occurrence to which the confirmation applies (in case `id` denotes a series appointment).
query integer Body:
Description:A JSON object with the fields `confirmation`, `confirmmessage` and optionally `id`.
Content-type: application/json-
AppointmentConfirmationBody
{-
confirmation
(
integer
,
required
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string , required ): The confirmation message or comment.
- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
-
confirmation
(
integer
,
required
, possibleValues:
Responses:
200:
Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated appointment, and maybe errors. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.
query string Body:
Description:A JSON object containing search parameters.
Content-type: application/json-
AppointmentSearchBody
{- pattern ( string ): Search pattern to find appointments. In the pattern, the character "*" matches zero or more characters and the character "?" matches exactly one character. All other characters match only themselves.
- startletter ( string ): Search appointments with the given starting letter.
Responses:
200:
A JSON object containing an array with matching appointments. Appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentsResponse
{- data ( data ): Array of appointments. Each appointment is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.
query string start (empty) Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.
query long end (empty) Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.
query long limit (empty) Limits the number of returned objects to the given value.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified and holds a column number, then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
A JSON object containing an array with appointment data. Appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentsResponse
{- data ( data ): Array of appointments. Each appointment is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested appointment.
query string folder (empty) Object ID of the folder who contains the appointments.
query string recurrence_position (empty) Recurrence position of requested appointment.
query integer Responses:
200:
An object containing all data of the requested appointment. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentResponse
{- data ( AppointmentData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentData
{- recurrence_id ( integer ): Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.
- recurrence_position ( integer ): 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- recurrence_date_position ( integer ): Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
- change_exceptions ( array[integer] , read only ): An array of Dates, representing all change exceptions of a sequence.
- delete_exceptions ( array[integer] , read only ): An array of Dates, representing all delete exceptions of a sequence.
- location ( string ): The location of the appointment.
-
shown_as
(
integer
, possibleValues:
1
2
3
4
* 1 (reserved),
* 2 (temporary),
* 3 (absent),
* 4 (free) - timezone ( string ): The timezone of the appointment.
- recurrence_start ( integer ): Start of a sequence without time.
- ignore_conflicts ( boolean ): Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type uid (empty) The UID that shall be resolved.
query string Responses:
200:
A JSON object containing the related object ID in the field `id`. If no object exists with the specified UID or in case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AppointmentUpdateResponse
{- data ( AppointmentUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
AppointmentUpdateData
{- id ( string ): ID of the appointment.
-
-
-
Capabilities
Provides access to capabilities, i.e. modules or features that are available on the backend and the user has access to.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the capability
query string Responses:
200:
A JSON object containing the data of the capability or an empty result, if capability not available. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CapabilityResponse
{- data ( CapabilityData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CapabilityData
{- id ( string ): The identifier of the capability.
- attributes ( attributes ): A JSON object holding properties of the capability.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array with data for all capabilities. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CapabilitiesResponse
{- data ( array[CapabilityData] ): An array of JSON objects each describing one capability.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CapabilityData
{- id ( string ): The identifier of the capability.
- attributes ( attributes ): A JSON object holding properties of the capability.
-
-
-
-
Deletes the fingerprint/hostname combination
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type fingerprint (empty) The fingerprint of the SSL certificate
query string hostname (empty) The hostname for which the SSL certificate is trusted/not trusted. If absent, then all entries for the specified fingerprint will be deleted
query string Responses:
200:
An empty JSON object. In case of errors the responsible fields in the response are filled (see Error handling).
-
Returns all trusted and untrusted SSL certificates
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array with data for all certificates. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CertificatesAllResponse
{- data ( array[CertificateStoreData] ): An array of certificate objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CertificateStoreData
{- fingerprint ( string ): The fingerprint of the SSL certificate
- hostname ( string ): The hostname which the endpoint call was done, or the hostname for which the exception is valid
- trusted ( boolean ): Whether the SSL certificate is trusted by the user
-
-
Examines an untrusted SSL certificate from a previous endpoint call. The SSL certificate is cached for a brief amount of time by the middleware (2 minutes).
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type fingerprint (empty) The fingerprint of the SSL certificate
query string Responses:
200:
A JSON object containing the data of the certificate. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CertificateExamineResponse
{- data ( CertificateExamineData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CertificateExamineData
{- fingerprint ( string ): The fingerprint of the SSL certificate
- issuedOn ( integer ): The timestamp of the date when the SSL certificate was issued
- expiresOn ( integer ): The timestamp of the date when the SSL certificate expires
- hostname ( string ): The hostname which the endpoint call was done, or the hostname for which the exception is valid
- commonName ( string ): The hostname for which the SSL certificate is valid (Comon Name)
- issuedBy ( string ): Information on the authority that issued the SSL certificate
- signature ( string ): The signature of the SSL certificate
- serialNumber ( string ): The serial number of the SSL certificate
- failureReason ( string ): The reason why the SSL certificate is not trusted
- expired ( boolean ): Whether the SSL certificate is expired
- trusted ( boolean ): Whether the SSL certificate is trusted by the user
-
-
Stores the fingerprint of an SSL certificate in combination with a hostname as either trusted or untrusted. This API call also accepts a JSONObject.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type fingerprint (empty) The fingerprint of the SSL certificate
query string hostname (empty) The hostname for which to trust/untrust the SSL certificate
query string trust (empty) Whether the combination of the SSL certificate and the hostname is to be trusted
query boolean Body:
Description:A JSON object describing the SSL certificate.
Content-type: application/json-
CertificateStoreData
{- fingerprint ( string ): The fingerprint of the SSL certificate
- hostname ( string ): The hostname which the endpoint call was done, or the hostname for which the exception is valid
- trusted ( boolean ): Whether the SSL certificate is trusted by the user
Responses:
200:
An empty JSON object. In case of errors the responsible fields in the response are filled (see Error handling).
-
-
Deletes all fingerprint/hostname combinations for the user
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
An empty JSON object. In case of errors the responsible fields in the response are filled (see Error handling).
-
Updates the exception for an SSL certificate in combination with a hostname as either trusted or untrusted
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type fingerprint (empty) The fingerprint of the SSL certificate
query string hostname (empty) The hostname for which to trust/untrust the SSL certificate
query string trust (empty) Whether the combination of the SSL certificate and the hostname is to be trusted
query boolean Responses:
200:
An empty JSON object. In case of errors the responsible fields in the response are filled (see Error handling).
-
Gets a specific or all SSL certificates
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type fingerprint (empty) The fingerprint of the SSL certificate
query string hostname (empty) The hostname for which the SSL certificate is trusted/not trusted. If absent, then all entries for the specified fingerprint will be returned
query string Responses:
200:
A JSON object containing an array with data for all certificates. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CertificatesAllResponse
{- data ( array[CertificateStoreData] ): An array of certificate objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CertificateStoreData
{- fingerprint ( string ): The fingerprint of the SSL certificate
- hostname ( string ): The hostname which the endpoint call was done, or the hostname for which the exception is valid
- trusted ( boolean ): Whether the SSL certificate is trusted by the user
-
-
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the event.
query string folder (empty) ID of the folder who contains the events.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string fields (empty) A comma-separated list of field identifiers.
query string alarmId (empty) The id of the alarm which shall be acknowledged.
query integer Responses:
200:
A JSON object containing containing the result of the acknowledge operation. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
An object containing all data of the requested availability. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GetAvailabilityResponse
{- data ( array[Available] ): Array of Available blocks
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Available
{- id ( integer ): The identifier of the available block.
- user ( integer ): The user identifier of the available block.
- uid ( string ): The unique identifier of the available block.
- created ( integer ): The creation date.
- modified ( integer ): The last modification time.
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- start ( DateTime ): No description available
- end ( DateTime ): No description available
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type query (empty) The query
query string language (empty) The language/locale to translate the results to. If none is provided then the locale of the user's session will be used. If that one is not available then falls back to 'en'.
query string maxRows (empty) Specifies the maximum amount of results to return. If not specified, then it will fall back to '20'
query integer Responses:
200:
A JSON object containing the result of the browse operation. The structure of the returned JSON object can be found here (https://github.com/schedjoules/calendar-store-api/blob/master/details/pages.md)
Content-type: application/json-
SearchResponse
{- data ( SearchData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
SearchData
{- item_id ( string ): For search will always be 'nil'
- name ( string ): The query that was used to search
- page_sections ( array[PageSectionsData] ): No description available
-
PageSectionsData
{- items ( array[object] ): No description available
- name ( string ): The section's name
-
-
(DEPRECATED) Updates an event based on an update sent by the organizer or a reply sent to the organizer.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An array of Events that were newly created or changed.
Content-type: application/json-
ActionResponse
{- data ( array[EventData] ): The created or updated event.
- timestamp ( integer , read only ): The timestamp of the event.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the event.
query string folder (empty) ID of the folder who contains the events.
query string managedId (empty) The identifier of the attachment.
query integer Responses:
200:
The attachment's raw data. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
Unknown
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string id (empty) ID of the event.
query string recurrenceId (empty) The recurrence identifier.
query string recurrenceRange (empty) The targeted range specified with the recurrence id.
query string checkConflicts (empty) Whether to check for conflicts or not.
query boolean scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string fields (empty) A comma-separated list of field identifiers.
query string rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string expand (empty) Defines if event series should be extended or not.
query boolean usedGroups (empty) In case the client resolves groups into single attendees the client can provide the ids of the groups he used (resolved) as a comma separated list. This way the usecount of those groups will be increased.
query string timestamp (empty) Timestamp of the last update of the event.
query long Body:
Description:A JSON object containing the event's data.
Content-type: application/json-
updateEventBody
{- event ( EventData ): No description available
- comment ( string ): Optional comment for the user to provide information about the update of the event. This will not be peristed and is just used to inform the attendees via notifications and invitation mails
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Note:
It is possible to update multiple attachments at once. Therefore add additional form fields and replace "[index]" in
file_[index]
with the appropriate index, likefile_1
. The index always starts with 0 (mandatory attachment object). There can only be one json payload describing the EventData, the rest json payloads (if present) will simply be ignored. If the event already has attachments, then for each of those attachments their valid manageId must be provided as part of the attachment metadata. The absense of an already existing attachment for the event will result in the deletion of that attachment.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string id (empty) ID of the event.
query string recurrenceId (empty) The recurrence identifier.
query string checkConflicts (empty) Whether to check for conflicts or not.
query boolean scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean usedGroups (empty) In case the client resolves groups into single attendees the client can provide the ids of the groups he used (resolved) as a comma separated list. This way the usecount of those groups will be increased.
query string timestamp (empty) Timestamp of the last update of the event.
query long Body:
Description:No description available
Content-type: multipart/form-data-
UpdateRequestBody
{- json_0 ( string , required ): A JSON object containing an optional comment for the user to provide information about the update of the event under the key 'comment' and the event's data as described in EventData under the key 'data'.
- file_0 ( string , required ): The attachment file as per ``.
Responses:
200:
A HTML page containing the result of the update or in case of errors an error object (see File uploads as an example).
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the event.
query string folder (empty) ID of the folder who contains the events.
query string recurrenceId (empty) The recurrence identifier.
query string fields (empty) A comma-separated list of field identifiers.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean Responses:
200:
An object containing all data of the requested event. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
EventResponse
{- data ( EventData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type rangeStart (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in RFC 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in RFC 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string fields (empty) A comma-separated list of field identifiers.
query string order (empty) The sort order to apply, either
ASC
for ascending, orDESC
for descending.query string sort (empty) Specifies the field for sorting the results.
query string expand (empty) Defines if event series should be extended or not.
query boolean extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean Body:
Description:A JSON object describing the search term as introducted in Advanced search. Example: `{"filter":["and",["=", {"field":"summary"},"FooBar Meeting"],["=",{"field":"createdBy"},"1337"]]}` which represents 'summary = "FooBar Meeting" AND createdBy = "1337"'. Valid fields are the following ones specified in Event data model: `summary`, `location`, `description`, `organizer`, `attendees`, `url`, `uid`, `timestamp`, `created`, `createdBy`, `lastModified`, `modifiedBy`, `sequence`, `categories`, `color`, `rrule`, `transp`, `status`, `class`. Calendar users in `organizer` / `attendees` can either be matched by their internal entity identifier, or based on their email address. The fields `startDate` and `endDate` can be defined with the `rangeStart` and `rangeEnd` URL parameters.
Content-type: application/json-
Unknown
Responses:
200:
A JSON object containing an array with events. The events are sorted in ascending order by the field `start_date`. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultipleFolderEventsResponse
{- data ( array[MultipleEventData] ): No description available
-
MultipleEventData
{- error ( error ): No description available
- folder ( string ): No description available
- events ( array[EventData] ): No description available
- timestamp ( integer , read only ): The timestamp of the event.
-
error
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the events.
query long rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string expand (empty) Defines if event series should be extended or not.
query boolean extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean fields (empty) A comma-separated list of field identifiers.
query string pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string Body:
Description:A JSON array of JSON objects with the id and optionally the recurrence position of the event.
Content-type: application/json-
deleteEventBody
{- events ( array[EventId] ): No description available
- comment ( string ): Optional comment for the user to provide information about the deletion of the event. This will not be peristed and is just used to inform the attendees via notifications and invitation mails.
-
EventId
{- folder ( string , required ): The identifier of the folder.
- id ( string , required ): The identifier of the event.
- recurrenceId ( string ): The recurrence id of this recurrence.
- recurrenceRange ( string ): The targeted range specified with the recurrence id.
Responses:
200:
An json object containing the deleted event if the deletion was successful. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosMultipleCalendarResultResponse
{- data ( CalendarResults ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- folderId ( string ): The folder id.
- id ( string ): The event id.
- recurrenceId ( string ): The recurrence id.
- error ( Error ): In case an error occurs this field contains error relevant data.
- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
Error - In case an error occurs this field contains error relevant data.
{- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): An array of error params.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type message (empty) The comment the attendee wants to transmit
query string timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An array of Events that were newly created or changed.
Content-type: application/json-
ActionResponse
{- data ( array[EventData] ): The created or updated event.
- timestamp ( integer , read only ): The timestamp of the event.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type message (empty) The comment the attendee wants to transmit
query string timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An array of Events that were newly created or changed.
Content-type: application/json-
ActionResponse
{- data ( array[EventData] ): The created or updated event.
- timestamp ( integer , read only ): The timestamp of the event.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type rangeStart (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only alarms that should trigger on or after this date are returned.
query string rangeEnd (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only alarms that should trigger on or after this date are returned.
query string actions (empty) A comma separated list of alarm actions. Only this actions will be returned.
query string Responses:
200:
An array of alarm trigger objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AlarmTriggerResponse
{- data ( array[object] ): An array of alarm trigger objects
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string id (empty) ID of the event.
query string recurrenceId (empty) The recurrence identifier.
query string recurrenceRange (empty) The targeted range specified with the recurrence id.
query string expand (empty) Defines if event series should be extended or not.
query boolean fields (empty) A comma-separated list of field identifiers.
query string pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string timestamp (empty) Timestamp of the last update of the event.
query long rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string Body:
Description:A JSON object containing the new organizer and an optional comment.
Content-type: application/json-
changeOrganizerBody
{- organizer ( CalendarUser ): No description available
- comment ( string ): Optional comment for the acting organizer to provide information about the reason of transmitting the event to an new organizer. This will not be peristed and is just used to inform the attendees via notification mails
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string timestamp (empty) Timestamp of the last update of the requested events.
query long rangeStart (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string fields (empty) A comma-separated list of field identifiers.
query string order (empty) The sort order to apply, either
ASC
for ascending, orDESC
for descending.query string sort (empty) Specifies the field for sorting the results.
query string expand (empty) Defines if event series should be extended or not.
query boolean extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean Responses:
200:
A JSON object containing two arrays. One with new and updated events and another one with deleted events. The events are sorted in ascending order by the field `start_date`. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosUpdatesResponse
{- data ( UpdatesResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
UpdatesResult
{- newAndModified ( array[EventData] ): The new and updated events.
- deleted ( array ): The deleted events.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string id (empty) ID of the event.
query string recurrenceId (empty) The recurrence identifier.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string fields (empty) A comma-separated list of field identifiers.
query string timestamp (empty) Timestamp of the last update of the event.
query long expand (empty) Defines if event series should be extended or not.
query boolean scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string Body:
Description:A JSON array containing the alarms.
Content-type: application/json-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Removes an an event based on an iMIP CANCEL mail by the organizer.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type message (empty) The comment the attendee wants to transmit
query string timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An array of Events that were newly created or changed.
Content-type: application/json-
ActionResponse
{- data ( array[EventData] ): The created or updated event.
- timestamp ( integer , read only ): The timestamp of the event.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Body:
Description:The properties to check.
Content-type: application/json-
CalendarAccountProbeData
{- com.openexchange.calendar.extendedProperties ( CalendarAccountProbeExtendedProperties ): Contains the extended properties for calendar folders
- com.openexchange.calendar.config ( CalendarAccountProbeConfig ): Holds arbitrary, provider-specific configuration data for calendar accounts.
- com.openexchange.calendar.provider ( string ): Denotes the identifier of the underlying calendar provider.
- title ( string ): The title of the calendar
-
CalendarAccountProbeExtendedProperties - Contains the extended properties for calendar folders
{- description ( description ): The description of the folder
- usedForSync ( usedForSync ): Indicates whether the folder should be considered for synchronization with external clients or not.
- color ( color ): Indicates the color the folder should be displayed with
- scheduleTransp ( scheduleTransp ): Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
-
description - The description of the folder
{- value ( string ): No description available
-
usedForSync - Indicates whether the folder should be considered for synchronization with external clients or not.
{- value ( string ): No description available
-
color - Indicates the color the folder should be displayed with
{- value ( string ): No description available
-
scheduleTransp - Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
{- value ( string ): No description available
-
CalendarAccountProbeConfig - Holds arbitrary, provider-specific configuration data for calendar accounts.
{- uri ( string ): (ical provider only) The URI of the ICal feed that should be subscribed.
- refreshInterval ( integer ): (ical provider only) Defines the refresh interval used for the subscribed ICal feed.
- login ( string ): (ical provider only) Defines an optional login for the subscribed ICal feed.
- password ( string ): (ical provider only) An optional password for the subscribed ICal feed.
Responses:
200:
A JSON object describing the possible calendar accounts. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CalendarAccountProbeResponse
{- data ( CalendarAccountProbeData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarAccountProbeData
{- com.openexchange.calendar.extendedProperties ( CalendarAccountProbeExtendedProperties ): Contains the extended properties for calendar folders
- com.openexchange.calendar.config ( CalendarAccountProbeConfig ): Holds arbitrary, provider-specific configuration data for calendar accounts.
- com.openexchange.calendar.provider ( string ): Denotes the identifier of the underlying calendar provider.
- title ( string ): The title of the calendar
-
CalendarAccountProbeExtendedProperties - Contains the extended properties for calendar folders
{- description ( description ): The description of the folder
- usedForSync ( usedForSync ): Indicates whether the folder should be considered for synchronization with external clients or not.
- color ( color ): Indicates the color the folder should be displayed with
- scheduleTransp ( scheduleTransp ): Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
-
description - The description of the folder
{- value ( string ): No description available
-
usedForSync - Indicates whether the folder should be considered for synchronization with external clients or not.
{- value ( string ): No description available
-
color - Indicates the color the folder should be displayed with
{- value ( string ): No description available
-
scheduleTransp - Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
{- value ( string ): No description available
-
CalendarAccountProbeConfig - Holds arbitrary, provider-specific configuration data for calendar accounts.
{- uri ( string ): (ical provider only) The URI of the ICal feed that should be subscribed.
- refreshInterval ( integer ): (ical provider only) Defines the refresh interval used for the subscribed ICal feed.
- login ( string ): (ical provider only) Defines an optional login for the subscribed ICal feed.
- password ( string ): (ical provider only) An optional password for the subscribed ICal feed.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Creates new appointment(s) in the calendar based on the iMIP REQUEST mail by the organizer.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Gets all events where the session userattendee's participation status equals "NEEDS-ACTION".
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type rangeStart (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string fields (empty) A comma-separated list of field identifiers.
query string order (empty) The sort order to apply, either
ASC
for ascending, orDESC
for descending.query string sort (empty) Specifies the field for sorting the results.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean Responses:
200:
A JSON object containing an array with events. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
EventsResponse
{- data ( array[EventData] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Updates appointment(s) in the calendar based on the iMIP REQUEST mail by the organizer.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Marks an messages as processed, thus getting rid of potential harmeful iMIP messages
Security:
This security scheme must be used:Name Scopes session
Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An empty response if the operation was successful
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string id (empty) ID of the event.
query string recurrenceId (empty) The recurrence identifier.
query string scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string fields (empty) A comma-separated list of field identifiers.
query string timestamp (empty) Timestamp of the last update of the event.
query long checkConflicts (empty) Whether to check for conflicts or not.
query boolean rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string expand (empty) Defines if event series should be extended or not.
query boolean Body:
Description:A JSON object with the field `attendee` and `alarms`.
Content-type: application/json-
AttendeeAndAlarm
{- attendee ( Attendee ): No description available
- alarms ( array[Alarm] ): A list of alarms for this event.
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the event.
query string folder (empty) ID of the folder who contains the events.
query string Body:
Description:A JSON array with the identifiers of the attachments, which shall be put into ZIP archive
Content-type: application/json
Responses:
200:
The raw data of the ZIP archive. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/zip-
Unknown
-
-
GET /chronos/schedjoules?action=languages Retrieves a list of all supported languages by SchedJoules
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
An object containing all supported languages. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
LanguagesResponse
{- data ( array[LanguageData] ): Array of languages
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
LanguageData
{- language_id ( integer ): The language's unique identifier
- name ( string ): The language's name
- iso_639_1 ( string ): The language's ISO 639-1 code
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the event.
query string folder (empty) ID of the folder who contains the events.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string fields (empty) A comma-separated list of field identifiers.
query string alarmId (empty) The id of the alarm which shall be snoozed.
query integer snoozeTime (empty) The duration in milliseconds the alarm should be snoozed by. E.g. 300000 for 5 minutes.
query long Responses:
200:
A JSON object containing containing the result of the snooze operation. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Resolves an event identifier to an event, and returns it in the perspective of the current session's user, i.e. having an appropriate parent folder identifier assigned.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the event.
query string fields (empty) A comma-separated list of field identifiers.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean sequence (empty) The expected sequence number to match. If set, a resolved event is only returned if the stored sequence number is equal to this value.
query integer Responses:
200:
An object containing all data of the requested event, or an empty result if no event was found. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
EventResponse
{- data ( EventData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Sets/Overwrites the availability of the user. If an empty payload is sent, then the availability of the user is deleted/unset.
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the availability's data.
Content-type: application/json-
AvailabilityData
{
Responses:
200:
'If the availability of the user was successfully set, then an empty JSON object is returned to indicate that. In case of errors the responsible fields in the response are filled (see Error handling).'
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An analyze response describing what the ical intends to do and handling suggestions.
Content-type: application/json-
AnalyzeResponse
{- data ( Analysis ): An analysis array.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type checkConflicts (empty) Whether to check for conflicts or not.
query boolean folder (empty) ID of the folder who contains the events.
query string id (empty) ID of the event.
query string recurrenceId (empty) The recurrence identifier.
query string scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string fields (empty) A comma-separated list of field identifiers.
query string timestamp (empty) Timestamp of the last update of the event.
query long targetFolder (empty) ID of the target folder.
query string rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string expand (empty) Defines if event series should be extended or not.
query boolean Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Browses a specific page of the SchedJoules calendars catalog. If no 'id' is provided, then the root page is returned.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the page.
query integer language (empty) The language/locale to translate the results to. If none is provided then the locale of the user's session will be used. If that one is not available then falls back to 'en'.
query string country (empty) The country/location for which to fetch the available catalog pages from the SchedJoules. If none is provided then the country of the user's session will be used. If that one is not available then falls back to 'us'. The 'country' parameter is only used for the root page. Otherwise it has no effect.
query string Responses:
200:
A JSON object containing the result of the browse operation. The structure of the returned JSON object can be found here (https://github.com/schedjoules/calendar-store-api/blob/master/details/pages.md)
Content-type: application/json-
BrowseResponse
{- data ( PageData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
PageData
{- item_id ( integer ): The page's unique identifier
- name ( string ): The page's name (localisable)
- category_id ( integer ): The page's category identifier (Not applicable to root page)
- category ( string ): The page's category name (Not applicable to root page)
- country ( string ): The country for which the page is valid for
- description ( string ): The page's description (Not applicable to root page)
- icon ( string ): The URL of the page's icon (Not applicable to root page)
- page_sections ( array[PageSectionsData] ): No description available
-
PageSectionsData
{- items ( array[object] ): No description available
- name ( string ): The section's name
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string checkConflicts (empty) Whether to check for conflicts or not.
query boolean scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean pushToken (empty) The client's push token to allow filtering of push events for modified calendar data
query string rangeStart (empty) If expand is set to 'true' this parameter defines a lower inclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) If expand is set to 'true' this parameter defines a upper exclusive limit as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string expand (empty) Defines if event series should be extended or not.
query boolean usedGroups (empty) In case the client resolves groups into single attendees the client can provide the ids of the groups he used (resolved) as a comma separated list. This way the usecount of those groups will be increased.
query string Body:
Description:A JSON object containing the event's data.
Content-type: application/json-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
Responses:
200:
'A JSON object containing the newly created event, if it was created successfully. If the event could not be created due to conflicts, the response body is an object with the field `conflicts`, which holds informations about the conflict. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Note
It is possible to create multiple attachments at once. Therefore add additional form fields and replace "[index]" in
file_[index]
with the appropriate index, likefile_1
. The index always starts with 0 (mandatory attachment object). There can only be one json payload describing the EventData, the rest json payloads (if present) will simply be ignored.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events.
query string checkConflicts (empty) Whether to check for conflicts or not.
query boolean scheduling Controls the generation of scheduling messages and notification mails for the current operation.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean usedGroups (empty) In case the client resolves groups into single attendees the client can provide the ids of the groups he used (resolved) as a comma separated list. This way the usecount of those groups will be increased.
query string Body:
Description:No description available
Content-type: multipart/form-data-
NewRequestBody
{- json_0 ( string , required ): A JSON object containing the event's data as described in EventData.
- file_0 ( string , required ): The attachment file as per ``.
Responses:
200:
A HTML page containing the newly created event or in case of errors an error object (see File uploads as an example). If the event could not be created due to conflicts, the HTML Page contains an object with the field `conflicts`, which holds informations about the conflict.
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the folder who contains the events. If not set, all events of the default account will be queried.
query string rangeStart (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string fields (empty) A comma-separated list of field identifiers.
query string order (empty) The sort order to apply, either
ASC
for ascending, orDESC
for descending.query string sort (empty) Specifies the field for sorting the results.
query string expand (empty) Defines if event series should be extended or not.
query boolean extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean updateCache (empty) If set to 'true' the cache will be forced to be updated (e. g. by contacting the underlying external account)
query boolean Responses:
200:
A JSON object containing an array with events. The events are sorted in ascending order by the field `start_date`. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
EventsResponse
{- data ( array[EventData] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type rangeStart (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string rangeEnd (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string fields (empty) A comma-separated list of field identifiers.
query string order (empty) The sort order to apply, either
ASC
for ascending, orDESC
for descending.query string sort (empty) Specifies the field for sorting the results.
query string expand (empty) Defines if event series should be extended or not.
query boolean updateCache (empty) If set to 'true' the cache will be forced to be updated (e. g. by contacting the underlying external account)
query boolean Body:
Description:A JSON object containing the folder ids.
Content-type: application/json-
ChronosFolderBody
{- folders ( array[string] ): The folder ids to query.
Responses:
200:
A JSON object containing an array with events. The events are sorted in ascending order by the field `start_date`. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultipleFolderEventsResponse
{- data ( array[MultipleEventData] ): No description available
-
MultipleEventData
{- error ( error ): No description available
- folder ( string ): No description available
- events ( array[EventData] ): No description available
- timestamp ( integer , read only ): The timestamp of the event.
-
error
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type from (empty) Lower inclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which start on or after this date are returned.
query string until (empty) Upper exclusive limit of the queried range as a utc date-time value as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z". Only events which end before this date are returned.
query string maskUid (empty) The unique identifier of an existing event or event series to ignore when calculating free/busy information. This is useful when a client wants to find a new timeslot for an existing event.
query string merge (empty) Set to
true
to merge the resulting free/busy-times.query boolean Body:
Description:A JSON object containing the attendees' data.
Content-type: application/json-
FreeBusyBody
{- attendees ( array[Attendee] ): A list of attendees
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
Responses:
200:
An object containing an array of json objects for each attendee containing a list of free-busy times. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosFreeBusyResponse
{- data ( array[ChronosFreeBusyResponseData] ): An array of free-busy response data.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ChronosFreeBusyResponseData
{- attendee ( Attendee ): No description available
- freeBusyTime ( array[object] ): The free-busy times of the attendee.
- warnings ( array[object] ): No description available
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type message (empty) The comment the attendee wants to transmit
query string timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An array of Events that were newly created or changed.
Content-type: application/json-
ActionResponse
{- data ( array[EventData] ): The created or updated event.
- timestamp ( integer , read only ): The timestamp of the event.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar
Parameters:
Parameter Value Description Parameter Type Data Type fields (empty) A comma-separated list of field identifiers.
query string extendedEntities (empty) If set to 'true' attendees of internal users will be extended by a 'contact' field, which contains some of the contact fields of this user.
query boolean Body:
Description:A JSON array of JSON objects with the id and optionally the recurrence position of the event.
Content-type: application/json-
EventId
{- folder ( string , required ): The identifier of the folder.
- id ( string , required ): The identifier of the event.
- recurrenceId ( string ): The recurrence id of this recurrence.
- recurrenceRange ( string ): The targeted range specified with the recurrence id.
Responses:
200:
A JSON object containing an array with events. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
EventsResponse
{- data ( array[EventData] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Updates an event based on an iMIP COUNTER mail containing proposed changes by an attendee.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type language (empty) The language/locale to translate the results to. If none is provided then the locale of the user's session will be used. If that one is not available then falls back to 'en'.
query string Responses:
200:
An object containing all supported countries. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CountriesResponse
{- data ( array[CountryData] ): Array of countries
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CountryData
{- country_id ( integer ): The country's unique identifier
- name ( string ): The country's name
- iso_3166 ( string ): The country's ISO 3166 code
- icon ( string ): An icon with the country's flag
- icon_etag ( string ): The eTag for the country's icon
- name_translation ( string ): The translated name of the country
- translation_url ( string ): The translation translation URL
- page_id ( integer ): The root page for the country
-
-
Takes over the attendee's participation status based on the iMIP REPLY mail by the attendee.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
A JSON object containing containing the result of the update. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChronosCalendarResultResponse
{- data ( CalendarResult ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CalendarResult
{- created ( array[EventData] ): The created events.
- updated ( array ): The updated events.
- deleted ( array ): The deleted events.
- conflicts ( array[ChronosConflictDataRaw] ): An array of conflicts.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
Conflict - A conflict.
{- hard_conflict ( boolean ): Defines whether the conflict is a hard conflict or not.
- conflicting_attendees ( array ): An array of conflicting attendees.
- event ( EventData ): No description available
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type message (empty) The comment the attendee wants to transmit
query string timezone (empty) The timezone to show the resulting events in.
query string Body:
Description:The data source object.
Content-type: application/json-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
Responses:
200:
An array of Events that were newly created or changed.
Content-type: application/json-
ActionResponse
{- data ( array[EventData] ): The created or updated event.
- timestamp ( integer , read only ): The timestamp of the event.
-
EventData
{- startDate ( DateTime ): No description available
- endDate ( DateTime ): No description available
- created ( integer ): The creation time.
- timestamp ( integer , read only ): The timestamp of the event.
- categories ( array[string] ): An array of categories.
- filename ( string ): The filename of the event.
- uid ( string ): The universal identifier of the event.
- description ( string ): The event's description.
- attendees ( array[Attendee] ): The attendees of the event.
- alarms ( array[Alarm] ): The alarms of the event for the current user.
- lastModified ( integer ): The last modification time.
- modifiedBy ( CalendarUser ): No description available
- summary ( string ): The summary of the event.
- sequence ( integer ): The sequence number of the event.
- id ( string ): The identifier of the event.
- class ( string ): The classification of the event.
- organizer ( CalendarUser ): No description available
-
transp
(
string
, possibleValues:
OPAQUE
TRANSPARENT
- color ( string ): The color of the even as a css3 color definition.
- folder ( string ): The folder identifier.
- createdBy ( CalendarUser ): No description available
- changeExceptionDates ( array[string] ): An array of changed recurrences.
- deleteExceptionDates ( array[string] ): An array of deleted recurrences.
- recurrenceId ( string ): The recurrence id of this recurrence. The value is either a utc date-time value (e.g. "20170708T220000Z"), a floating date-time (e.g. "20170708T220000"), a date (e.g. "20170708"), or a local time with timezone reference (e.g. "Europe/Berlin:20170708T220000"). See RFC 5545 chapter 3.3.5. for more information.
- calendarUser ( CalendarUser ): No description available
- rrule ( string ): The recurrence rule according to rfc 5545 chapter 3.8.5.3.
- attachments ( array ): An array of attachments.
- extendedProperties ( extendedProperties ): No description available
- geo ( Geo ): The geolocation of the event.
- attendeePrivileges ( string ): The privileges attendees have on an event.
- url ( string ): The uniform resource locator (URL) of the event.
- seriesId ( string ): The identifier of the event series.
- status ( string ): The status of the event.
- location ( string ): The location of the event.
- flags ( array[string] ): Flags indicating certain aspects of an event, as described in Event Flags.
- relatedTo ( string ): The relationship between this and other events.
- conferences ( array[Conference] ): The conferences of the event.
-
DateTime
{- value ( string ): A date-time value without timezone information as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000"
- tzid ( string ): A timezone identifier. E.g. "America/New_York"
-
Attendee
{-
cuType
(
string
, possibleValues:
INDIVIDUAL
GROUP
RESOURCE
ROOM
UNKNOWN
- folder ( string ): The folder of the attendee.
- partStat ( string ): The participation status.
-
role
(
string
, possibleValues:
CHAIR
REQ-PARTICIPANT
OPT-PARTICIPANT
NON-PARTICIPANT
CHAIR
- The chair of the calendar entity.REQ-PARTICIPANT
- A participant whose participation is required.OPT-PARTICIPANT
- A participant whose participation is optional.NON-PARTICIPANT
- A participant who is copied for information purposes only.
- comment ( string ): The comment of the attendee.
- rsvp ( boolean ): The rsvp expectation of the attendee.
- member ( array[string] ): Each element represents the ID of a group or list in which the attendee is a member.
- contact ( contact ): In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
- resource ( resource ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
- group ( group ): In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
cuType
(
string
, possibleValues:
-
contact - In case the parameter 'extendedEntities' is set to 'true' and the entity is an internal user then this field contains some of the contact data of this user.
{- first_name ( string ): The first name of the attendee.
- last_name ( string ): The last name of the attendee.
- title ( string ): The title of the attendee.
- display_name ( string ): The display name of the attendee.
- image1_url ( string ): The url to the image of the attendee.
-
resource - In case the parameter 'extendedEntities' is set to 'true' and the entity is a resource then this field contains the data of this resource.
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
group - In case the parameter 'extendedEntities' is set to 'true' and the entity is a group then this field contains the data of this group.
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
extendedParameters - Extended parameters of the conference.
{- key ( string ): The name of the parameter
-
Alarm
{- uid ( string ): The uid of the alarm.
- id ( integer ): The id of the alarm.
- action ( string ): The action of the alarm.
- acknowledged ( integer ): The time of the acknowledgement.
- trigger ( Trigger ): The trigger of the alarm.
- attachments ( array[ChronosAttachment] ): An array of attachments.
- attendees ( array[Attendee] ): An array of attendees.
- summary ( string ): The summary of this alarm.
- description ( string ): The description of this alarm.
- extendedProperties ( extendedProperties ): No description available
-
Trigger - The trigger of the alarm.
{- duration ( string ): The duration of the trigger relative to the related field. See rfc 5545 chapter 3.3.6. for more informations about durations.
-
related
(
string
, possibleValues:
START
END
- dateTime ( string ): Defines an absolute date for the alarm. The value is a date-time value in utc timezone as specified in rfc 5545 chapter 3.3.5. E.g. "20170708T220000Z"
-
ChronosAttachment
{- filename ( string ): The name of the attachment file.
- fmtType ( string ): The format type of the attachment.
- size ( integer ): The size of the attachment in bytes.
- created ( integer ): The creation date.
- managedId ( integer ): The manage id of the attachment.
- uri ( string ): A uniform resource identifier to the attachment file.
-
CalendarUser
{- sentBy ( SentByCalendarUser ): A calendar user that is acting on behalf of this calendar user
- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
SentByCalendarUser - A calendar user that is acting on behalf of this calendar user
{- uri ( string ): The universal resource identifier of the user.
- cn ( string ): The common name of the user.
- email ( string ): The mail address of the user.
- entity ( integer ): The internal user identifier.
-
Geo - The geolocation of the event.
{- lat ( number ): The latitude geographic coordinate.
- long ( number ): The longitude geographic coordinate.
-
Conference
{- id ( integer ): The internal identifier of the conference.
- uri ( string ): The URI to access the conference.
- label ( string ): The label used to convey additional details on the use of the URI.
- features ( array[string] ): The features describing the key capabilities of the conference system.
- extendedParameters ( extendedParameters ): Extended parameters of the conference.
-
-
-
Clientonboarding
Via the client on-boarding module the client can retrieve possible on-boarding configurations-
Generate link to direct-download a profile to configure an apple device for CalDAV and/or CardDAV as well as IMAP/SMTP access
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type type The identifier of profile to download; one of - caldav - carddav - dav - mail - eas
query string Responses:
200:
The download link for the profile
Content-type: application/json-
Unknown
-
-
Retrieves the configuration providing available client on-boarding possibilities for session-associated user
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
'The configuration as a JSON object or in case of errors the responsible fields in the response are filled (see Error handling). The JSON object consists of five fields: "platforms", "devices", "scenarios", "actions" and "matching". Each field provides an array of objects. The "platforms" field lists the available platforms for which a device can receive on-boarding information. The "devices" field lists the concrete devices, which are supported to receive on-boarding information. Each object mainly provides: - A unique identifier for the associated device (e.g. "apple.iphone") and a display name - Whether the device is enabled; "false" to trigger upsell activities - A listing of applicable scenarios for the device consisting of composite identifiers (delimited by "/" character), which point to an entry from the "matching" object The "scenarios" field provides all available on-boarding scenarios (like installing an app or receive a profile configuration for a built-in application; e.g. Apple Mail). Each scenario also provides: - A unique identifier and a display name - Whether the scenario is enabled along-side with "missing_capabilities" to trigger upsell activities - A description text for the user The "actions" field represents the available actions that can be performed in order to transfer a certain on-boarding information to a device. As of now there are five possible actions for a certain device/scenario combination: "download", "email", "display", "link" and "sms". - "download" refers to a simple download that is performed; e.g. a profile configuration file. - "email" lets the Middleware to send out an E-Mail containing the on-boarding information. - "sms" lets the Middleware to send out an SMS containing the on-boarding information. - "display" represents a plain display of on-boarding information for manual setup. Actions of this type provide a composite identifier (delimited by "/" character) that also contains the concrete scenario to which that action applies; e.g. "display/davsync". Moreover it has a "data" field that provides the user-sensitive information to display; e.g. the mail settings. - "link" hints to an available link that a user can follow; e.g, a link to a certain app held in an app store. Actions of this type provide a composite identifier (delimited by "/" character) that also contains the concrete scenario to which that action applies. In addition there is a field for each device providing the exact link and type; e.g. having a link to Apple Appstore for an iPhone device. The "matching" field is the combination of supported device, scenario and actions combinations. It provides an "id" field that contains a composite identifier (delimited by "/" character) to refer to the device and scenario combination; e.g. "apple.ipad/mailsync". Moreover, there is a listing of available action identifiers (pointing to entries from "actions") that are possible being executed in order to let such a device being on-boarded for the referenced scenario.'
Content-type: application/json-
ClientOnboardingResponse
{- data ( ClientOnboardingData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ClientOnboardingData
{- platforms ( array[object] ): No description available
- devices ( array[object] ): No description available
- scenarios ( array[object] ): No description available
- actions ( array[object] ): No description available
- matching ( array[object] ): No description available
-
-
Direct-downloads a profile to configure an apple device for CalDAV and/or CardDAV as well as IMAP/SMTP access
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type type The identifier of profile to download; one of - caldav - carddav - dav - mail - eas
query string Responses:
200:
The profile
Content-type: application/json-
Unknown
-
-
Performs a certain client on-boarding action for a given device and scenario; e.g. download a profile or send an E-Mail/SMS
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The compiste identifier of device and scenario pair; e.g. "apple.iphone/davsync"
query string action_id (empty) The identifier of action to perform; one of - download - email - sms - display or - link
query string Body:
Description:An optional JSON object containing additional data for the action.
Content-type: application/json-
Unknown
Responses:
200:
'The appropriate result object or binary data dependent on specified action. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Config
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.-
The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type path The path to the node.
path string Responses:
200:
Value of the node specified by path. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ConfigResponse
{- data ( data ): Generic type which can be object, string, array, etc.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_userconfig
Parameters:
Parameter Value Description Parameter Type Data Type path The path to the node.
path string Body:
Description:A JSON object containing the value of the config node.
Content-type: application/json-
ConfigBody
{- data ( data , required ): The new value of the node specified by path.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type name (empty) The name of the property to return.
query string Responses:
200:
A JSON response providing the property's name and its value. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ConfigPropertyResponse
{- data ( ConfigProperty ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ConfigProperty
{- name ( string ): The name of the property.
- value ( value ): The value of the property.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type name (empty) The name of the property to return.
query string Body:
Description:A JSON object providing the value to set (Example: {"value":"test123"}).
Content-type: application/json-
ConfigPropertyBody
{- value ( string ): The concrete value to set.
Responses:
200:
A JSON response providing the property's name and its value. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ConfigPropertyResponse
{- data ( ConfigProperty ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ConfigProperty
{- name ( string ): The name of the property.
- value ( value ): The value of the property.
-
-
-
Contacts
The contacts module is used to access contact information. Deprecated, and provides only access to internally stored contacts from the default contacts provider. Clients should switch to the "addressbooks" module for new features.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string Body:
Description:A JSON array of JSON objects with the id and folder of the contacts.
Content-type: application/json-
ContactListElement
{- id ( string , required ): The object ID of the contact.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
A JSON object containing an array with data for the requested contacts. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Finds contacts based on a prefix, usually used to auto-complete e-mail recipients while the user is typing.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string query (empty) The query to search for.
query string email (empty) Whether to only include contacts with at least one e-mail address. Defaults to `true`.
query boolean folder (empty) Object ID of the parent folder that is searched. If not set, all visible folders are used.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. If this parameter is missing, response is sorted by a user-specific use count of contacts, ID of contacts' parent folder and display name.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string left_hand_limit (empty) A positive integer number to specify the "left-hand" limit of the range to return.
query integer right_hand_limit (empty) A positive integer number to specify the "right-hand" limit of the range to return.
query integer Responses:
200:
A JSON object containing the contact data. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Updates a contact's data and images. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the contact's data while the image file must be placed in a file field namedfile
(see also File uploads).Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string id (empty) Object ID of the contact that shall be updated.
query string timestamp (empty) Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.
query long Body:
Description:No description available
Content-type: multipart/form-data-
updateContactAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the contact data as described in ContactData model. Only modified fields must be specified but at least "{}".
- file ( string , required ): The image file.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the contact or errors if some occurred.
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Finds contacts whose anniversary falls into a specified time range.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string start (empty) The lower (inclusive) limit of the requested time range.
query long end (empty) The upper (exclusive) limit of the requested time range.
query long folder (empty) Object ID of the parent folder that is searched. If not set, all visible folders are used.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Body:
Description:No description available
Content-type: application/json-
advancedSearchBody
{- filter ( string , required ): A JSON object describing the search term as introducted in Advanced search. Example: `["and",["=", {"field":"last_name"},"Mustermann"],["=",{"field":"first_name"},"Max"]]` which represents 'last_name = "Mustermann" AND first_name = "Max"'. Valid fields are the ones specified in Contact data model. The field 'folder' is not allowed as operand.
- folders ( array[string] ): The identifiers of the folders to restrict the search to. If not defined, all visible folders (optionally filtered through to "folderTypes"]) are considered.
- folderTypes ( contactsSearchFolderTypes ): The kind of folders to perform the search in, if no folders are defined through "folders" explicitly.
-
contactsSearchFolderTypes - The kind of folders to perform the search in, if no folders are defined through "folders" explicitly.
{- includeUnsubscribed ( string ): Controls whether also unsubscribed folders (i.e. not visible in the tree) are considered.
- pickerOnly ( string ): Configures if only folders that are explicitly marked for usage in the picker are considered.
Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the deleted contacts.
query long Body:
Description:A JSON array of JSON objects with the id and folder of the contacts.
Content-type: application/json-
ContactListElement
{- id ( string , required ): The object ID of the contact.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
A JSON array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactDeletionsResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Finds contacts whose birthday falls into a specified time range.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string start (empty) The lower (inclusive) limit of the requested time range.
query long end (empty) The upper (exclusive) limit of the requested time range.
query long folder (empty) Object ID of the parent folder that is searched. If not set, all visible folders are used.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Updates a contact's data. This request cannot change or add contact images. Therefore it is necessary to use the
POST
method.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string id (empty) Object ID of the contact that shall be updated.
query string timestamp (empty) Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.
query long Body:
Description:A JSON object containing the contact's data. Only modified fields must be specified. To remove some contact image send the image attribute set to null.
Content-type: application/json-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
A JSON object with a timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactUpdateResponse
{- data ( ContactUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactUpdateData
{- id ( string ): ID of a newly created contact.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Updates a contact's data and images. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the contact's data while the image file must be placed in a file field namedfile
(see also File uploads).Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string id (empty) Object ID of the contact that shall be updated.
query string timestamp (empty) Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.
query long Body:
Description:No description available
Content-type: multipart/form-data-
updateContactAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the contact data as described in ContactData model. Only modified fields must be specified but at least "{}".
- file ( string , required ): The image file.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the contact or errors if some occurred.
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested contact.
query string folder (empty) Object ID of the folder who contains the contacts.
query string Responses:
200:
An object containing all data of the requested contact. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactResponse
{- data ( ContactData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Creates a new contact with contact images. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the contact's data while the image file must be placed in a file field namedfile
(see also File uploads).Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Body:
Description:No description available
Content-type: multipart/form-data-
createContactAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the contact data as described in the ContactData (see createContact model.
- file ( string , required ): The image file.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the contact or errors if some occurred.
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string timestamp (empty) Timestamp of the last update of the requested contacts.
query long ignore Which kinds of updates should be ignored. Omit this parameter or set it to "deleted" to not have deleted tasks identifier in the response. Set this parameter to `false` and the response contains deleted tasks identifier.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted contacts (should the ignore parameter be ever implemented) would be identified by their object IDs as integers, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactUpdatesResponse
{- data ( data ): Array of contacts.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string Body:
Description:A JSON array with user IDs.
Content-type: application/json
Responses:
200:
A JSON object containing an array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Body:
Description:A JSON object containing search parameters.
Content-type: application/json-
ContactSearchBody
{- pattern ( string ): Search pattern to find contacts. In the pattern, the character "*" matches zero or more characters and the character "?" matches exactly one character. All other characters match only themselves. Matching is performed against any substring of the field display_name.
- startletter ( boolean ): Search contacts with the given startletter. If this field is present, the pattern is matched against the contact field which is specified by the property "contact_first_letter_field" on the server (default: last name). Otherwise, the pattern is matched against the display name.
- folder ( array[string] ): If a list of folder identifiers or at least a single folder identifier is given, only in that folders will be searched for contacts. This paramenter is optional but searching in all contact folders that are viewable and where objects can be read in is more expensive on that database than searching in a dedicated number of them. Mutual exclusive with 'exclude_folders'.
- exclude_folders ( array[string] ): If a list of folder identifiers or at least a single folder identifier is given, those folders will not be searched for contacts. Mutual exclusive with 'folders'.
- last_name ( string ): Searches contacts where the last name match with the given last name.
- first_name ( string ): Searches contacts where the first name match with the given first name.
- display_name ( string ): Searches contacts where the display name match with the given display name.
- email1 ( string ): Searches contacts where the email1 address match with the given search pattern.
- email2 ( string ): Searches contacts where the email2 address match with the given search pattern.
- email3 ( string ): Searches contacts where the email3 address match with the given search pattern.
- company ( string ): Searches contacts where the company match with the given search pattern.
- categories ( string ): Searches contacts where the categories match with the given search pattern.
- orSearch ( boolean ): If set to `true`, a contact is returned if any specified pattern matches at the start of the corresponding field. Otherwise, a contact is returned if all specified patterns match any substring of the corresponding field.
- emailAutoComplete ( boolean ): If set to `true`, results are guaranteed to contain at least one email adress and the search is performed as if orSearch were set to `true`. The actual value of orSearch is ignored.
- exactMatch ( boolean ): If set to `true`, contacts are returned where the specified patterns match the corresponding fields exactly. Otherwise, a "startsWith" or "substring" comparison is used based on the "orSearch" parameter.
Responses:
200:
A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Tries to get a picture for a given contact. To specify a contact at least one of three informations must be given:
user_id
- an id of an internal user.contact_id
andfolder_id
- together those ids identifiy a contact.email
- an email address.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type user_id (empty) The user identifier.
query string account_id (empty) The account identifier of an specific account belonging to the user of the session. If the account ID is set, the search will be delegated to the matching account, if found.
query string contact_id (empty) The contact identifier.
query string folder_id (empty) The folder id the contact id belongs to.
query string email (empty) The mail address of the contact.
query string rotate (empty) Adds a 'rotate' transformation, leading to the image being rotated according to the contained EXIF information.
query boolean width (empty) The maximum width of the target image.
query integer height (empty) The maximum height of the target image.
query integer shrinkOnly (empty) Set to true to only scale images 'greater than' target size.
query boolean scaleType Defines the scale type. Possible value:
cover
- The "cover" scale type, specifying the minimum target dimensions.
The source image will be resized in a way that the resulting image covers the target resolution entirely, with the original aspect ratio being preserved. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "cover", will result in the picture being resized to 267x200 pixels.contain
- The "contain" scale type, specifying the maximum target dimensions.
The source image will be resized in a way that the resulting image fits into the target resolution entirely, with the original aspect ratio being preserved. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "contain", will result in the picture being resized to 200x150 pixels.containforcedimension
- The "containforcedimension" scale type, specifying the maximum target dimensions.
The source image will be resized in a way that the resulting image fits into the target resolution entirely, with the original aspect ratio being preserved while smaller sides get padded to fit exact dimension. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "containforcedimension", will result in the picture being first resized to 200x150 pixels, then height gets padded by 25 pixels per side resulting in exactly 200x200 pixels.coverandcrop
- The "coverandcrop" scale type, specifying the target dimensions.
If the source image is bigger than the target dimension, in a first step the image will be resized in a way that the resulting image covers the target resolution entirely, with the original aspect ratio being preserved. In a second step the image will be cropped to fit the target dimension. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "coverandcrop", will result in the picture being resized to 267x200 pixels and then cropped to fit 200x200. In case the image is smaller than then target dimension the image will not be resized and instead it gets padded to fit exact dimension. For example, with an original resolution of 100x100 pixels and a target dimension of 200x200 pixels and type "coverandcrop", will result in the picture being padded on all sides with 50 pixels.auto
- The "auto" scale type.
query string cropWidth (empty) The width of the specified rectangular region.
query integer cropHeight (empty) The height of the specified rectangular region.
query integer cropX (empty) The X coordinate of the upper-left corner of the specified rectangular region.
query integer cropY (empty) The Y coordinate of the upper-left corner of the specified rectangular region.
query integer Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/json-
Unknown
404:
No image could be found.
-
Creates a new contact. This request cannot add contact images. Therefor it is necessary to use the
POST
method.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Body:
Description:A JSON object containing the contact's data. The field id is not included.
Content-type: application/json-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
A JSON object containing the ID of the newly created contact. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactUpdateResponse
{- data ( ContactUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactUpdateData
{- id ( string ): ID of a newly created contact.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Creates a new contact with contact images. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the contact's data while the image file must be placed in a file field namedfile
(see also File uploads).Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Body:
Description:No description available
Content-type: multipart/form-data-
createContactAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the contact data as described in the ContactData (see createContact model.
- file ( string , required ): The image file.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the contact or errors if some occurred.
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the contacts.
query string columns (empty) A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string collation Allows you to specify a collation to sort the contacts by. Only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work.
query string Responses:
200:
A JSON object containing an array with data for all contacts. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactsResponse
{- data ( data ): Array of contacts. Each contact is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) User ID (not Object ID) of the requested user.
query integer Responses:
200:
An object containing all data of the requested contact. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ContactResponse
{- data ( ContactData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
Conversion
The conversion module is a generic module to request data from a data source and to process obtained/submitted data with a data handler. Thus data is converted from a data source by a data handler.-
Saving an iCal email attachment
If an iCal file is attached to an email, its content can be saved as appointments and tasks into given calendar and task folder. If the fields "com.openexchange.groupware.calendar.confirmstatus" and "com.openexchange.groupware.calendar.confirmmessage" are set, the data handler inserts the appointment with the given status for the user, if the appointment does not exist. If it is already existing, the handler just updates the participant status.
{ "datasource": { "identifier":"com.openexchange.mail.ical", "args": [ {"com.openexchange.mail.conversion.fullname":"<folder-fullname>"}, {"com.openexchange.mail.conversion.mailid":"<mail-id>"}, {"com.openexchange.mail.conversion.sequenceid":"<attachment-sequence-id>"} ] }, "datahandler": { "identifier":"com.openexchange.ical", "args": [ {"com.openexchange.groupware.calendar.folder":"<calendar-folder-id>"}, {"com.openexchange.groupware.task.folder":"<task-folder-id>"}, {"com.openexchange.groupware.calendar.confirmstatus":"<status>"}, {"com.openexchange.groupware.calendar.confirmmessage":"<message>"} ] } }
The response is a JSON array of JSON objects each providing folder and object ID of added appointments/tasks, e.g.
[{"folder_id":2567,"id":7689}, ...]
.Converting an iCal email attachment into JSON objects
If an iCal file is attached to an email, its content can be converted to JSON appointments and tasks.
{ "datasource": { "identifier":"com.openexchange.mail.ical", "args": [ {"com.openexchange.mail.conversion.fullname":"<folder-fullname>"}, {"com.openexchange.mail.conversion.mailid":"<mail-id>"}, {"com.openexchange.mail.conversion.sequenceid":"<attachment-sequence-id>"} ] }, "datahandler": { "identifier":"com.openexchange.ical.json", "args": [ {"com.openexchange.groupware.calendar.timezone":"<timezone-id>"}, {"com.openexchange.groupware.calendar.recurrencePosition":"<recurrence-position>"}, {"com.openexchange.groupware.calendar.searchobject":"<true|false>"} ] } }
The response is a JSON array of JSON objects for each appointment/task. See the TaskData model of the getTask request and the AppointmentData model of the getAttachment request for more informations.
Saving a vCard email attachment
If a vCard file is attached to an email, its content can be saved as contacts into given contact folder.
{ "datasource": { "identifier":"com.openexchange.mail.vcard", "args": [ {"com.openexchange.mail.conversion.fullname":"<folder-fullname>"}, {"com.openexchange.mail.conversion.mailid":"<mail-id>"}, {"com.openexchange.mail.conversion.sequenceid":"<attachment-sequence-id>"} ] }, "datahandler": { "identifier":"com.openexchange.contact", "args": [ {"com.openexchange.groupware.contact.folder":"<contact-folder-id>"} ] } }
The response is a JSON array of JSON objects each providing folder and object ID of added contacts, e.g.
[{"folder_id":2567,"id":7689}, ...]
.Contact(s) attached to a new email as a vCard file
Obtain vCard data from spacified contact object(s).
{ "datasource": { "identifier":"com.openexchange.contact", "args": [ {"folder":"<folder-id1>","id":"<id1>"}, ..., "folder":"<folder-idn>","id":"<idn>" ] }, "datahandler": { "identifier":"com.openexchange.mail.vcard", "args": [] } }
The response is a JSON object containing mail data. See the MailData model of the getMail request.
[{"folder_id":2567,"id":7689}, ...]
.Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object the data source object and the data handler object.
Content-type: application/json-
ConversionBody
{- datasource ( ConversionDataSource ): No description available
- datahandler ( ConversionDataHandler ): No description available
-
ConversionDataSource
{- com.openexchange.mail.conversion.fullname ( string ): The identifier of the folder.
- com.openexchange.mail.conversion.mailid ( string ): The identifier of the mail.
- com.openexchange.mail.conversion.sequenceid ( string ): The identifier of attachment to analyze.
-
ConversionDataHandler
{- identifier ( string ): The identifier of the data handler.
- args ( array[ConversionDataHandlerPair] ): A JSON array of optional JSON objects containing the name-value-pairs.
-
ConversionDataHandlerPair
{- com.openexchange.groupware.calendar.folder ( string ): The calendar folder ID.
- com.openexchange.groupware.task.folder ( string ): The task folder ID.
- com.openexchange.groupware.calendar.confirmstatus ( string ): The status.
- com.openexchange.groupware.calendar.confirmmessage ( string ): The message.
- com.openexchange.groupware.calendar.timezone ( string ): The timezone ID.
- com.openexchange.grouware.calendar.recurrencePosition ( string ): The recurrence position.
- com.openexchange.groupware.calendar.searchobject ( string ): Can be `true` or `false`.
- com.openexchange.groupware.contact.folder ( string ): The contact folder ID.
Responses:
200:
The conversion result. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ConversionResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
-
Deletes the result files and all resourcess of data export task for session-associated user
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the success status.
Content-type: application/json-
deleteDataExportTaskResponse
{- success ( boolean ): True if such resources for data export task has been successfully deleted; false otherwise
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the available modules.
Content-type: application/json-
DataExportModules
{- calendar ( calendar ): The calendar module
- contacts ( contacts ): The contacts module
- infostore ( infostore ): The infostore module
- mail ( mail ): The mail module
- tasks ( tasks ): The tasks module
-
calendar - The calendar module
{- enabled ( boolean , required ): Whether the calendar module is enabled
- includePublic ( boolean ): The default setting for public folders if public folder export is available.
- includeShared ( boolean ): The default setting for shared folders if shared folder export is available.
- includeUnsubscribed ( boolean ): The default setting for unsubscribed folders if unsubscribed folder export is available.
-
contacts - The contacts module
{- enabled ( boolean , required ): Whether the contacts module is enabled
- includePublic ( boolean ): The default setting for public folders if public folder export is available.
- includeShared ( boolean ): The default setting for shared folders if shared folder export is available.
-
infostore - The infostore module
{- enabled ( boolean , required ): Whether the infostore module is enabled
- includePublic ( boolean ): The default setting for public folders if public folder export is available.
- includeShared ( boolean ): The default setting for shared folders if shared folder export is available.
- includeTrash ( boolean ): The default setting for the trash folder if trash folder export is available.
- includeAllVersions ( boolean ): The default setting for all versions export if all version export is available.
-
mail - The mail module
{- enabled ( boolean , required ): Whether the mail module is enabled
- includePublic ( boolean ): The default setting for public folders if public folder export is available.
- includeShared ( boolean ): The default setting for shared folders if shared folder export is available.
- includeTrash ( boolean ): The default setting for the trash folder if trash folder export is available.
- includeUnsubscribed ( boolean ): The default setting for unsubscribed folders if unsubscribed folder export is available.
-
tasks - The tasks module
{- enabled ( boolean , required ): Whether the tasks module is enabled
- includePublic ( boolean ): The default setting for public folders if public folder export is available.
- includeShared ( boolean ): The default setting for shared folders if shared folder export is available.
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Downloads the available result file package from user-associated data export task.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string number (empty) The number of the package
query integer Responses:
200:
A ZIP archive.
Content-type: application/zip-
Unknown
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the requested data export task.
Content-type: application/json-
DataExportTaskResponse
{- data ( DataExportTask ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
DataExportTask
{- id ( string ): The task identifier
- status ( string ): The task's status
- creationTime ( integer ): The time when task was created/submitted.
- startTime ( integer ): The time when processing of the task started. Not present in case task has not yet been started.
- duration ( integer ): The duration of the processing for the task. Not present in case task is not yet terminated.
- availableUntil ( integer ): The number of milliseconds how long task's result files will stay accessible until automatically deleted. Not present in case task is not yet terminated.
- results ( array[DataExportResultFile] ): The result files. Not present in case task is not yet terminated.
- workItems ( array[DataExportWorkItem] ): The result files. Not present in case task is not yet terminated.
-
DataExportResultFile
{- fileInfo ( string ): The work item identifier
- number ( integer ): The package number
- contentType ( string ): The Content-Type identifier
- taskId ( string ): The task identifier
-
DataExportWorkItem
{- id ( string ): The work item identifier
- module ( string ): The module identifier
- status ( string ): The status of the work item
- info ( info ): The optional status information
-
info - The optional status information
{- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): An array of error params.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type deleteOldDataExport (empty) A flag indicating whether previously completed data export is supposed to be deleted prior to submitting a new one.
query boolean Body:
Description:A JSON object containing the modules and associated parameters.
Content-type: application/json-
Unknown
Responses:
200:
A JSON object containing the success status.
Content-type: application/json-
submitDataExportTaskResponse
{- success ( boolean ): True if such a data export task has been successfully canceled; false otherwise
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the success status.
Content-type: application/json-
cancelDataExportTaskResponse
{- success ( boolean ): True if such a data export task has been successfully canceled; false otherwise
400:
Bad request, response contains error message.
401:
Not authorized
-
-
-
-
Updates a previously granted deputy permission to a certain user
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object describing the deputy permission.
Content-type: application/json-
DeputyPermission
{- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
Responses:
200:
The JSON representation of the updated deputy permission
Content-type: application/json-
DeputyResponse
{- data ( GrantedDeputyPermission ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GrantedDeputyPermission
{- deputyId ( string ): The identifier of the deputy permission
- granteeId ( integer ): The identifier of the user which granted the deputy permission
- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type deputyId (empty) The identifier for the deputy permission
query string Responses:
200:
A JSON object containing all data of the requested deputy permission. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
DeputyResponse
{- data ( GrantedDeputyPermission ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GrantedDeputyPermission
{- deputyId ( string ): The identifier of the deputy permission
- granteeId ( integer ): The identifier of the user which granted the deputy permission
- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type deputyId (empty) The identifier for the deputy permission
query string Responses:
200:
A JSON object containing the success status.
Content-type: application/json-
deleteDeputyPermissionByIdResponse
{- success ( boolean ): True if such a deputy permission has been successfully deleted; false otherwise
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON array containing deputy permissions.
Content-type: application/json-
DeputyListResponse
{- data ( array[GrantedDeputyPermission] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GrantedDeputyPermission
{- deputyId ( string ): The identifier of the deputy permission
- granteeId ( integer ): The identifier of the user which granted the deputy permission
- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
-
Grants a new deputy permission to a certain user
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object describing the deputy permission.
Content-type: application/json-
DeputyPermission
{- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
Responses:
200:
The JSON representation of the newly created deputy permission
Content-type: application/json-
DeputyResponse
{- data ( GrantedDeputyPermission ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GrantedDeputyPermission
{- deputyId ( string ): The identifier of the deputy permission
- granteeId ( integer ): The identifier of the user which granted the deputy permission
- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON array containing deputy permissions.
Content-type: application/json-
DeputyListResponse
{- data ( array[GrantedDeputyPermission] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GrantedDeputyPermission
{- deputyId ( string ): The identifier of the deputy permission
- granteeId ( integer ): The identifier of the user which granted the deputy permission
- userId ( integer ): The identifier of the user to which a deputy permission is granted
- sendOnBehalfOf ( boolean ): Whether the deputy user is allowed to send E-Mail on behalf of granting user
- modulePermissions ( modulePermissions ): The individual permissions by module granted to deputy user
-
modulePermissions - The individual permissions by module granted to deputy user
{- calendar ( calendar ): The calendar permissions granted to deputy user
- contact ( contact ): The contact permissions granted to deputy user
- drive ( drive ): The Drive permissions granted to deputy user
- mail ( mail ): The mail permissions granted to deputy user
- task ( task ): The task permissions granted to deputy user
-
calendar - The calendar permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
contact - The contact permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
drive - The Drive permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
mail - The mail permissions granted to deputy user
{- permission ( integer ): The permission bit mask
-
task - The task permissions granted to deputy user
{- permission ( integer ): The permission bit mask
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON array containing available module identifiers for which to grant a deputy permission. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
DeputyAvailableModulesResponse
{- data ( array[string] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
400:
Bad request, response contains error message.
401:
Not authorized
-
-
-
Export
The module export allows to export specific module data (like contacts, tasks or appointments) from a folder in several formats (iCal, vCard, CSV).-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_calendar Name Scopes oauth
read_tasks
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder whose content shall be exported. This must be a calendar folder.
query string Responses:
200:
An input stream containing the content of the iCal file with the MIME type `text/calendar`.
Content-type: application/json-
Unknown
-
-
Exports a batch of appointments and tasks data to a iCalendar file.
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array of JSON objects with the id and folder_id.
Content-type: application/json-
InfoItemExport
{- id ( string , required ): The object ID of the contact, task or appointment (e.g. "368").
- folder_id ( string , required ): The object ID of the related folder (e.g. "2435").
Responses:
200:
An input stream containing the content of the vCard file with the MIME type `text/calendar`.
Content-type: application/json-
Unknown
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder whose content shall be exported. This must be a contact folder. Only required if there is no ids parameter submitted.
query string export_dlists (empty) Toggles whether distribution lists shall be exported too (default is `false`).
query string Responses:
200:
An input stream containing the content of the vCard file with the MIME type `text/x-vcard`.
Content-type: application/json-
Unknown
-
-
Exports a batch of contact data to a vCard file.
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array of JSON objects with the id and folder_id.
Content-type: application/json-
InfoItemExport
{- id ( string , required ): The object ID of the contact, task or appointment (e.g. "368").
- folder_id ( string , required ): The object ID of the related folder (e.g. "2435").
Responses:
200:
An input stream containing the content of the vCard file with the MIME type `text/x-vcard`.
Content-type: application/json-
Unknown
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder whose content shall be exported. This must be a contact folder.
query string columns (empty) A comma-separated list of columns to export, like "501,502". A column is specified by a numeric column identifier, see Detailed contact data.
query string export_dlists (empty) Toggles whether distribution lists shall be exported too (default is `false`).
query string Responses:
200:
An input stream containing the content of the CSV file with the MIME type `text/csv`.
Content-type: application/json-
Unknown
-
-
Exports a batch of contact data to a CSV file.
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array of JSON objects with the id and folder_id.
Content-type: application/json-
InfoItemExport
{- id ( string , required ): The object ID of the contact, task or appointment (e.g. "368").
- folder_id ( string , required ): The object ID of the related folder (e.g. "2435").
Responses:
200:
An input stream containing the content of the CSV file with the MIME type `text/csv`.
Content-type: application/json-
Unknown
-
-
-
File
The ajax file upload module offers to store files in server's dedicated download directory for a configurable amount of time. The files are then accessible for further operations like inline images in (html) mails.-
By updating the last access timestamp the file is prevented from being deleted from both session and disk storage.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the uploaded file whose timestamp should be updated.
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the uploaded file.
query string Responses:
200:
The content of the requested file is directly written into output stream.
Content-type: application/octet-stream-
Unknown
404:
Not found.
-
-
It can be uploaded multiple files at once. Each file must be specified in an own form field (the form field name is arbitrary).
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type module (empty) The module for which the file is uploaded to determine proper upload quota constraints (e.g. "mail", "infostore", etc.).
query string type The file type filter to define which file types are allowed during upload. Currently supported filters are: file (for all), text (for `text/*`), media (for image, audio or video), image (for `image/*`), audio (for `audio/*`), video (for `video/*`) and application (for `application/*`).
query string Body:
Description:No description available
Content-type: multipart/form-data-
uploadFileBody
{- file ( string , required ): The file to upload.
Responses:
200:
A HTML page as described in File uploads containing a JSON array with the IDs of the uploaded files or errors if some occurred. The files are accessible through the returned IDs for future use.
Content-type: text/html-
Unknown
-
-
-
Filestorage
The file storage module provides access to file storage backends, e.g. Drive, Dropbox, etc.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_files
Parameters:
Parameter Value Description Parameter Type Data Type filestorageService (empty) The identifier of the file storage service the account belongs to.
query string id (empty) The ID of the requested account.
query string Responses:
200:
A JSON object containing the data of the file storage account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileAccountResponse
{- data ( FileAccountData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FileAccountData
{- id ( string ): The identifier of the file storage account in the scope of its file storage service (e.g. Infostore, Dropbox, ...). This is not writeable and is generated by the server.
- filestorageService ( string ): The identifier of the file storage service this account belongs to.
- qualifiedId ( string , read only ): A global identifier of the file storage account across all file storage services. This is not writeable and is generated by the server.
- displayName ( string ): A user chosen, human-readable name to identify the account. Will also be translated into the folder name of the folder representing the accounts content.
- rootFolder ( string , read only ): The ID of the account's root folder within the folder tree, if available. This is not writeable and is generated by the server.
- isDefaultAccount ( boolean ): Indicates whether this account is the user's default account. Exactly one account will have this flag set to `true`.
- hasError ( boolean ): Indicates whether an error occurred during the connection check for this account. If set to true, the other error related information in this response object are set as well.
- error ( string ): The translated error message. Present in case of errors during the connection check.
- error_params ( array[string] ): Exception parameters
- error_id ( string ): Unique error identifier to help finding this connection check error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
- metadata ( metadata , read only ): A JSON object providing additional arbitrary metadata of the account.
- capabilities ( array[string] , read only ): An array of capability names. Possible values are: FILE_VERSIONS, EXTENDED_METADATA, RANDOM_FILE_ACCESS, and LOCKS.
- configuration ( configuration ): The configuration data according to the form description of the relevant file storage service.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_files
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the file storage service to load.
query string Responses:
200:
A JSON object containing the data of the file storage service. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileServiceResponse
{- data ( FileServiceData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FileServiceData
{- id ( string ): The identifier of the file storage service, e.g. "boxcom".
- displayName ( string ): A human-readable display name of the service, e.g. "Box File Storage Service"
- configuration ( array[FileServiceConfiguration] ): An array of dynamic form fields. Same as in PubSub.
-
FileServiceConfiguration
{- widget ( string ): The name of the widget.
- name ( string ): The name of the field.
- displayName ( string ): The display name of the field.
- mandatory ( boolean ): Indicates whether the field is mandatory.
- options ( options ): An object describing the available options in the field.
- defaultValue ( defaultValue ): Can contain a default value.
-
-
Example for creating a new OAuth-based file storage account
First, get the description of the file storage service for which a new account is supposed to be created:
GET /ajax/fileservice?action=get&id=boxcom&session=...
The response might be:
{ id: "boxcom", displayName: "Box File Storage Service", configuration: { widget: "oauthAccount", options: { type: "com.openexchange.oauth.boxcom" }, name: "account", displayName: "Select an existing account", mandatory: true } }
Next get the associated OAuth account information:
GET /ajax/oauth/accounts?action=all&serviceId=com.openexchange.oauth.boxcom&session=...
The response might be:
{ "data":[ { "id":333, "displayName":"My Box.com account", "serviceId":"com.openexchange.oauth.boxcom" } ] }
Finally, create the file storage account:
PUT /ajax/fileaccount?action=new&session=... { "filestorageService":"boxcom", "displayName":"My box.com account", "configuration":{ "account":"333", "type":"com.openexchange.oauth.boxcom" } }
The response provides the relative identifier of the newly created account.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_files
Body:
Description:A JSON object describing the account to create, with at least the field `filestorageService` set.
Content-type: application/json-
FileAccountData
{- id ( string ): The identifier of the file storage account in the scope of its file storage service (e.g. Infostore, Dropbox, ...). This is not writeable and is generated by the server.
- filestorageService ( string ): The identifier of the file storage service this account belongs to.
- qualifiedId ( string , read only ): A global identifier of the file storage account across all file storage services. This is not writeable and is generated by the server.
- displayName ( string ): A user chosen, human-readable name to identify the account. Will also be translated into the folder name of the folder representing the accounts content.
- rootFolder ( string , read only ): The ID of the account's root folder within the folder tree, if available. This is not writeable and is generated by the server.
- isDefaultAccount ( boolean ): Indicates whether this account is the user's default account. Exactly one account will have this flag set to `true`.
- hasError ( boolean ): Indicates whether an error occurred during the connection check for this account. If set to true, the other error related information in this response object are set as well.
- error ( string ): The translated error message. Present in case of errors during the connection check.
- error_params ( array[string] ): Exception parameters
- error_id ( string ): Unique error identifier to help finding this connection check error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
- metadata ( metadata , read only ): A JSON object providing additional arbitrary metadata of the account.
- capabilities ( array[string] , read only ): An array of capability names. Possible values are: FILE_VERSIONS, EXTENDED_METADATA, RANDOM_FILE_ACCESS, and LOCKS.
- configuration ( configuration ): The configuration data according to the form description of the relevant file storage service.
Responses:
200:
A JSON object containing the ID of the newly created account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileAccountCreationResponse
{- data ( string ): The ID of the newly created account.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_files
Parameters:
Parameter Value Description Parameter Type Data Type filestorageService (empty) The identifier of a file storage service to list only those accounts that belong to that file storage service.
query string connectionCheck (empty) If set to true, a connection check is performed for each queried file storage account. In case the connection check failed, the hasError flag is set to true in the returned response object, and also an error object describing the cause of the failure is included.
query boolean Responses:
200:
A JSON object containing an array with JSON objects each describing one file storage account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileAccountsResponse
{- data ( array[FileAccountData] ): An array of JSON objects each describing one file storage account.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FileAccountData
{- id ( string ): The identifier of the file storage account in the scope of its file storage service (e.g. Infostore, Dropbox, ...). This is not writeable and is generated by the server.
- filestorageService ( string ): The identifier of the file storage service this account belongs to.
- qualifiedId ( string , read only ): A global identifier of the file storage account across all file storage services. This is not writeable and is generated by the server.
- displayName ( string ): A user chosen, human-readable name to identify the account. Will also be translated into the folder name of the folder representing the accounts content.
- rootFolder ( string , read only ): The ID of the account's root folder within the folder tree, if available. This is not writeable and is generated by the server.
- isDefaultAccount ( boolean ): Indicates whether this account is the user's default account. Exactly one account will have this flag set to `true`.
- hasError ( boolean ): Indicates whether an error occurred during the connection check for this account. If set to true, the other error related information in this response object are set as well.
- error ( string ): The translated error message. Present in case of errors during the connection check.
- error_params ( array[string] ): Exception parameters
- error_id ( string ): Unique error identifier to help finding this connection check error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
- metadata ( metadata , read only ): A JSON object providing additional arbitrary metadata of the account.
- capabilities ( array[string] , read only ): An array of capability names. Possible values are: FILE_VERSIONS, EXTENDED_METADATA, RANDOM_FILE_ACCESS, and LOCKS.
- configuration ( configuration ): The configuration data according to the form description of the relevant file storage service.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_files
Responses:
200:
A JSON object containing an array with JSON objects each describing one file storage service. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileServicesResponse
{- data ( array[FileServiceData] ): An array of JSON objects each describing one service.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FileServiceData
{- id ( string ): The identifier of the file storage service, e.g. "boxcom".
- displayName ( string ): A human-readable display name of the service, e.g. "Box File Storage Service"
- configuration ( array[FileServiceConfiguration] ): An array of dynamic form fields. Same as in PubSub.
-
FileServiceConfiguration
{- widget ( string ): The name of the widget.
- name ( string ): The name of the field.
- displayName ( string ): The display name of the field.
- mandatory ( boolean ): Indicates whether the field is mandatory.
- options ( options ): An object describing the available options in the field.
- defaultValue ( defaultValue ): Can contain a default value.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_files
Parameters:
Parameter Value Description Parameter Type Data Type filestorageService (empty) The identifier of the file storage service the account belongs to.
query string id (empty) The ID of the account to delete.
query string Responses:
200:
A JSON object containing the number 1 on success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileAccountUpdateResponse
{- data ( integer ): Returns 1 on success.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_files
Body:
Description:A JSON object describing the updated data of the account. The fields `id` and `filestorageService` must be set.
Content-type: application/json-
FileAccountData
{- id ( string ): The identifier of the file storage account in the scope of its file storage service (e.g. Infostore, Dropbox, ...). This is not writeable and is generated by the server.
- filestorageService ( string ): The identifier of the file storage service this account belongs to.
- qualifiedId ( string , read only ): A global identifier of the file storage account across all file storage services. This is not writeable and is generated by the server.
- displayName ( string ): A user chosen, human-readable name to identify the account. Will also be translated into the folder name of the folder representing the accounts content.
- rootFolder ( string , read only ): The ID of the account's root folder within the folder tree, if available. This is not writeable and is generated by the server.
- isDefaultAccount ( boolean ): Indicates whether this account is the user's default account. Exactly one account will have this flag set to `true`.
- hasError ( boolean ): Indicates whether an error occurred during the connection check for this account. If set to true, the other error related information in this response object are set as well.
- error ( string ): The translated error message. Present in case of errors during the connection check.
- error_params ( array[string] ): Exception parameters
- error_id ( string ): Unique error identifier to help finding this connection check error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
- metadata ( metadata , read only ): A JSON object providing additional arbitrary metadata of the account.
- capabilities ( array[string] , read only ): An array of capability names. Possible values are: FILE_VERSIONS, EXTENDED_METADATA, RANDOM_FILE_ACCESS, and LOCKS.
- configuration ( configuration ): The configuration data according to the form description of the relevant file storage service.
Responses:
200:
A JSON object containing the number 1 on success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FileAccountCreationResponse
{- data ( string ): The ID of the newly created account.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Find
The find module consists of calls for performing searches within the modules mail, contacts, tasks and drive. It was designed to provide an iterative approach where the search criteria can be refined step-wise until the desired items are found. The starting point is always an `autocomplete` request, that suggests possible search filters based on a users input. Those filters are grouped into categories, called "facets". A facet may provide one or more values with every value being a possible filter. A client is meant to remember every value that was selected by a user and include it within the following `autocomplete` and `query` requests, while `query` performs the actual search and returns the found items. Some of the objects returned by the server contain former user input. A client must never interpret strings as HTML but always as plain text to be not vulnerable for CSS attacks!-
Before querying the search you should fetch the search filters (facets) by calling the /find?action=autocomplete request.
Active facets
Every value that has been selected by a user must be remembered and provided with every subsequent request. The representation of a facet within a request body differs from the one within an autocomplete response. We call those "active facets". Their representation is independent from their style.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type module (empty) The name of the module within that the search shall be performed. Possible modules are: mail, contacts, calendar, tasks, drive. Because a user may have limited access to modules the useable modules might only be a subset of the available ones. Retrieve a list of allowed modules by querying the user configuration, see module "config" (path `search`) or module "JSlob" (e.g. `id=io.ox/core`).
query string columns (empty) A comma-separated list of module-specific columns that shall be contained in the response items. See Column identifiers for the numeric IDs of fields for specific modules.
query string fields (empty) A comma-separated list of field identifiers. This parameter must be used instead of columns in case the module is set to 'calendar'.
query string Body:
Description:A JSON object containing the selected `facets` and possible `options`. For pagination the keys `start` and `size` can be set.
Content-type: application/json-
FindQueryBody
{- facets ( array[FindActiveFacet] ): An array of selected facets that shall be applied for search.
- options ( FindOptionsData ): No description available
- start ( integer ): The start of a pagination, if desired.
- size ( integer ): The page size of a pagination, if desired.
-
FindActiveFacet
{- facet ( string ): The ID of the according facet.
- value ( string ): The ID of the according value. Must always be copied from the value object, not from a possibly according option (in the two-dimensional case).
- filter ( FindActiveFacetFilter ): The filter object, copied from the value or option.
-
FindActiveFacetFilter - The filter object, copied from the value or option.
{- fields ( array[string] ): An array of fields to search for.
- queries ( array[string] ): An array of corresponding search values.
-
FindOptionsData
{- timezone ( string ): The timezone to use if any dates are returned.
- includeSubfolders ( boolean ): Search in subfolders of given root folder too, defaults to `true`.
- all ( boolean ): Deliver all subfolders regardless of their subscribed status, defaults to `true`
- sort ( string ): The field to sort results. Default varies depending on module.
- order ( string ): The sort order, possible values are `asc` and `desc`, defaults to `asc`.
- admin ( boolean ): (DEPRECATED) Indicates whether the context admin shall be included if it matches any search criteria. If the context admin shall always be ignored (i.e. not returned), `false` has to be set.
Responses:
200:
A JSON object containing the search result. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FindQueryResponse
{- data ( FindQueryResponseData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FindQueryResponseData
{- num_found ( integer ): The number of found items.
- start ( integer ): The start of the pagination.
- size ( integer ): The page size.
- results ( results ): An array of search results. Each result is described by a JSON object containing the fields specified in the `columns` parameter.
-
-
Filters are grouped into categories, the so called facets.
Facets
The style of a facet is responsible for how the according object is structured, how it is handled on the server-side and how the client has to handle it. We distinguish three styles of facets:
- simple
- default
- exclusive
Every facet value contains an embedded
filter
object. The filter must not be changed by the client, it has to be seen as a black-box. Instead the filters of selected facet values have to be copied and sent to the server with the subsequent requests.Simple facets
A simple facet is a special facet that has exactly one value. The facet's type and its value are strictly coupled, in a way that a display name for both, facet and value would be redundant. A simple facet generally denotes a logical field like 'phone number'. Internally this logical field can map to several internal fields (e.g. 'phone_private', 'phone_mobile', 'phone_business'). In clients the facet as a whole can be displayed as a single item. Example: "Search for 'term' in field 'phone number'".
Default facets
A default facet contains multiple values and may be present multiple times in search requests to filter results by a combination of different values (e.g. "mails with 'foo' and 'bar' in subject").
Facet values may be one- or two-dimensional. A one-dimensional value can be displayed as is and contains an according filter object. A two-dimensional value contains an array "options" with every option defining different semantics of how the value is used to filter the search results.
Exclusive facets
An exclusive facet is a facet where the contained values are mutually exclusive. That means that the facet must only be present once in an autocomplete or query request.
Facet values may be one- or two-dimensional. A one-dimensional value can be displayed as is and contains an according filter object. A two-dimensional value contains an array "options" with every option defining different semantics of how the value is used to filter the search results.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type module (empty) The name of the module within that the search shall be performed. Possible modules are: mail, contacts, calendar, tasks, drive. Because a user may have limited access to modules the useable modules might only be a subset of the available ones. Retrieve a list of allowed modules by querying the user configuration, see module "config" (path `search`) or module "JSlob" (e.g. `id=io.ox/core`).
query string limit (empty) The maximum number of values returned per facet.
query integer Body:
Description:A JSON object containing the user's input (specified in field `prefix`), already selected `facets`, and possible `options`.
Content-type: application/json-
FindAutoCompleteBody
{- prefix ( string ): The user's search input.
- facets ( array[FindActiveFacet] ): An array of already selected facets, meaning categories the user has filtered by before.
- options ( FindOptionsData ): No description available
-
FindActiveFacet
{- facet ( string ): The ID of the according facet.
- value ( string ): The ID of the according value. Must always be copied from the value object, not from a possibly according option (in the two-dimensional case).
- filter ( FindActiveFacetFilter ): The filter object, copied from the value or option.
-
FindActiveFacetFilter - The filter object, copied from the value or option.
{- fields ( array[string] ): An array of fields to search for.
- queries ( array[string] ): An array of corresponding search values.
-
FindOptionsData
{- timezone ( string ): The timezone to use if any dates are returned.
- includeSubfolders ( boolean ): Search in subfolders of given root folder too, defaults to `true`.
- all ( boolean ): Deliver all subfolders regardless of their subscribed status, defaults to `true`
- sort ( string ): The field to sort results. Default varies depending on module.
- order ( string ): The sort order, possible values are `asc` and `desc`, defaults to `asc`.
- admin ( boolean ): (DEPRECATED) Indicates whether the context admin shall be included if it matches any search criteria. If the context admin shall always be ignored (i.e. not returned), `false` has to be set.
Responses:
200:
A JSON object containing the facets that were found. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FindAutoCompleteResponse
{- data ( FindAutoCompleteData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FindAutoCompleteData
{- facets ( array[FindFacetData] ): An array of facets each describing a possible search category or an already applied category.
-
FindFacetData
{- style ( string ): The facet style, which can be one of: simple, default, or exclusive. Dependent on the style some fields are present and others are not.
- id ( string ): The ID of this facet. Must be unique within an autocomplete response. Can be used to distinguish and filter certain facets. (for simple, default, and exclusive)
- name ( string ): A displayable (and localized) name for this facet. If absent, an `item` attribute is present. (for simple, default, and exclusive)
- item ( FindFacetItem ): A more complex object to display this facet. Attributes are `name`, `detail` (optional), and `image_url` (optional). (for simple, default, and exclusive)
-
flags
(
array[string]
):
An array of flags. Available flags: conflicts (specified as "conflicts:
", facets carrying this flag must not be combined with a facet of type ). (for simple, default, and exclusive) - filter ( FindFacetFilter ): The filter to refine the search. (for simple)
- values ( array[FindFacetValue] ): An array of facet values. (for default)
- options ( array ): An array of facet values. (for exclusive)
-
FindFacetItem - A more complex object to display this facet. Attributes are `name`, `detail` (optional), and `image_url` (optional). (for simple, default, and exclusive)
{- name ( string ): A displayable (and localized) name for the facet.
- detail ( string ): A displayable (and localized) detail name, like "in mail text".
- image_url ( string ): An URL to a displayable image.
-
FindFacetFilter - The filter to refine the search. (for simple)
{- fields ( array[string] ): An array of fields to search for.
- queries ( array[string] ): An array of corresponding search values.
-
FindFacetValue
{- id ( string ): The ID of the value. Must be unique within one facet.
- name ( string ): A displayable (and localized) name for this facet. If absent, an `item` attribute is present.
- item ( FindFacetValueItem ): A more complex object to display this facet. Attributes are `name`, `detail` (optional), and `image_url` (optional).
- filter ( FindFacetValueFilter ): The filter to refine the search.
- options ( array[FindFacetValueOption] ): An array of options to refine the search.
-
FindFacetValueItem - A more complex object to display this facet. Attributes are `name`, `detail` (optional), and `image_url` (optional).
{- name ( string ): A displayable (and localized) name for the facet.
- detail ( string ): A displayable (and localized) detail name, like "in mail text".
- image_url ( string ): An URL to a displayable image.
-
FindFacetValueFilter - The filter to refine the search.
{- fields ( array[string] ): An array of fields to search for.
- queries ( array[string] ): An array of corresponding search values.
-
FindFacetValueOption
{- id ( string ): The ID of the option. Must be unique within a set of options.
- name ( string ): The displayable (and localized) name for this option.
- filter ( FindFacetValueFilter ): The filter to refine the search.
-
-
Folders
The folders module is used to access the OX folder structure. Special system folders:ID Type Description 6 contacts System Users -
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string id (empty) Object ID of the shared folder to notify about.
query string Body:
Description:JSON object providing the JSON array `entities`, which holds the entity ID(s) of the users or groups that should be notified. To send a custom message to the recipients, an additional JSON object `notification` may be included, inside of which an optional message can be passed (otherwise, some default message is used). (Example: {"entities":["2332"]} or {"entities":["2332"],"notification":{"transport":"mail","message":"The message"}})
Content-type: application/json-
FolderSharingNotificationBody
{- entities ( array[string] , required ): Array containing the entity ID(s) of the users or groups that shall be notified.
- notification ( FolderBodyNotification ): No description available
-
FolderBodyNotification
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
An empty JSON object. Any transport warnings that occurred during sending the notifications are available in the warnings array of the response. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderSharingNotificationResponse
{- data ( FolderSharingNotificationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FolderSharingNotificationData
{- warnings ( warnings ): An array of transport warnings that occured during sending the notifications.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data.
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string Responses:
200:
A JSON object containing an array with data for all folders at the root level of the folder structure. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersResponse
{- data ( data ): Array of folders. Each folder is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string timestamp (empty) The optional timestamp of the last update of the deleted folders.
query long allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string hardDelete (empty) If set to `true`, the folders are deleted permanently. Otherwise, and if the underlying storage supports a trash folder and the folders are not yet located below the trash folder, they are moved to the trash folder.
query boolean failOnError (empty) If an error occured for one folder and this parameter is set to `true` the process will abort and throw an error. If this parameter is set to 'false' the process will continue for the remaining folders and will add a warning to the response instead.
query boolean extendedResponse (empty) If this parameter is set to `true` a different response will be returned. The response contains an array of json objects, which can contain the following fields:
new_path
- The new path of the folder in case of a trash operation.path
- The old path.hasFailed
- A boolean flag indicating that the delete operation has failed.isTrashed
- A boolean flag indicating that the folder has been trashed.isSuppoprted
- A boolean flag indicating that the folder storage supports trashing.
query boolean pushToken (empty) The client's push token to restrict the generated drive event
query string allow_enqueue (empty) Optional flag that specifies whether the request is allowed for being submitted to job queue.
query boolean Body:
Description:A JSON array with object IDs of the folders.
Content-type: application/json
Responses:
200:
An array with object IDs of folders that were NOT deleted. There may be a lot of different causes for a not deleted folder: A folder has been modified in the mean time, the user does not have the permission to delete it or those permissions have just been removed, the folder does not exist, etc. You receive an empty JSON array if everything worked well. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersCleanUpResponse
{- data ( array[string] ): An array with object IDs of folders that could not be processed because of a concurrent modification or something else. If the extendedResponse parameter is set to `true` the array contains json objects instead.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string content_type (empty) The desired content type (either numbers or strings; e.g. "tasks", "calendar"/"event", "contacts"/"addressdata", "mail", "infostore").
query string columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string all (empty) Whether or not to include subscribed folders.
query boolean Responses:
200:
A JSON object containing three fields: "private", "public, and "shared". Each field is a JSON array with data for all folders. Each folder is itself described by an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. For the content_type "mail" a JSON object only containing the JSON array "private" is returned. Mail folders are managed by the mail storage and all are considered to be in private folder namespace for an Open-Xchange user. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersVisibilityResponse
{- data ( FoldersVisibilityData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FoldersVisibilityData
{- private ( private ): Array of private folders. Each folder is described as an array itself.
- public ( public ): Array of public folders. Each folder is described as an array itself.
- shared ( shared ): Array of shared folders. Each folder is described as an array itself.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON array with object IDs of the folders.
Content-type: application/json
Responses:
200:
A JSON array containing the IDs of folders that could not be cleared due to a concurrent modification. Meaning you receive an empty JSON array if everything worked well. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersCleanUpResponse
{- data ( array[string] ): An array with object IDs of folders that could not be processed because of a concurrent modification or something else. If the extendedResponse parameter is set to `true` the array contains json objects instead.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mails Name Scopes oauth
read_tasks Name Scopes oauth
read_calendar Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested folder.
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string altNames (empty) Whether to prefer alternative names for former infostore folders or not.
query boolean Responses:
200:
A JSON object containing the data of the requested folder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderResponse
{- data ( FolderData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FolderData
{- id ( string ): Object ID
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- last_modified_utc ( integer , read only ): Timestamp of the last modification. Note that the type is Timestamp, not Time.
- folder_id ( string ): Object ID of the parent folder.
- title ( string ): Name of this folder.
- module ( string ): Name of the module which implements this folder; e.g. "tasks", "calendar", "contacts", "infostore", or "mail"
- type ( integer ): Type of folder.
- subfolders ( boolean , read only ): Set `true` if this folder has subfolders.
- own_rights ( integer ): Permissions which apply to the current user, as described either in Permission flags or in RFC2086.
- permissions ( array[FolderPermission] ): No description available
- summary ( string ): Information about contained objects.
- standard_folder ( boolean ): Indicates whether or not folder is marked as a default folder (only OX folder).
- total ( integer , read only ): The number of objects in this Folder.
- new ( integer , read only ): The number of new objects in this Folder.
- unread ( integer , read only ): The number of unread objects in this Folder.
- deleted ( integer , read only ): The number of deleted objects in this Folder.
-
capabilities
(
integer
,
read only
, possibleValues:
0
1
2
3
* bit 0 (mailing system supports permissions),
* bit 1 (mailing system supports ordering mails by their thread reference),
* bit 2 (mailing system supports quota restrictions),
* bit 3 (mailing system supports sorting),
* bit 4 (mailing system supports folder subscription) - subscribed ( boolean ): Indicates whether this folder should appear in folder tree or not. Standard folders cannot be unsubscribed.
- subscr_subflds ( boolean ): Indicates whether subfolders should appear in folder tree or not.
-
standard_folder_type
(
integer
, possibleValues:
0
1
2
3
7
8
9
10
11
12
* 0 (non-default folder),
* 1 (task),
* 2 (calendar),
* 3 (contact),
* 7 (inbox),
* 8 (infostore),
* 9 (drafts),
* 10 (sent),
* 11 (spam),
* 12 (trash) - supported_capabilities ( array[string] , read only ): Can contain "permissions", "quota", "sort", "subscription".
- account_id ( string ): Will be null if the folder does not belong to any account (i.e. if its module doesn't support multiple accounts), is a virtual folder or an account-agnostic system folder.
- com.openexchange.publish.publicationFlag ( boolean , read only ): Indicates whether this folder is published. Read Only, provided by the com.openexchange.publish plugin.
- com.openexchange.subscribe.subscriptionFlag ( boolean , read only ): Indicates whether this folder has subscriptions storing their content in this folder. Read Only, provided by the com.openexchange.subscribe plugin.
- com.openexchange.folderstorage.displayName ( string , read only ): Provides the read only display name of the folder's owner.
- com.openexchange.share.extendedPermissions ( array[FolderExtendedPermission] ): No description available
- com.openexchange.calendar.extendedProperties ( FolderCalendarExtendedProperties ): Contains the extended properties for calendar folders
- com.openexchange.calendar.config ( FolderCalendarConfig ): Holds arbitrary, provider-specific configuration data for calendar accounts.
- com.openexchange.calendar.provider ( string ): Denotes the identifier of the underlying calendar provider.
- com.openexchange.contacts.extendedProperties ( FolderContactsExtendedProperties ): Contains the extended properties for contact folders
- used_for_sync ( used_for_sync ): Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
-
FolderPermission
{- bits ( integer ): For non-mail folders, a number as described in Permission flags.
- rights ( string ): For mail folders, the rights string as defined in RFC 2086.
- identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies (ignored for type "anonymous" or "guest").
- group ( boolean ): Set `true` if entity refers to a group, `false` if it refers to a user (ignored for type "anonymous" or "guest").
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
- includeSubfolders ( boolean ): If this permission is applied to subfolders (for type "anonymous", optional).
-
FolderExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
- bits ( integer ): A number as described in Permission flags.
- type ( string ): Set "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( contact ): A (reduced) set of Detailed contact data for "user" and "guest" entities.
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
- includeSubfolders ( boolean ): The optionally set "include subfolders" option for "anonymous" entities.
- isInherited ( boolean ): A flag indicating whether the permissions is inherited from the parent folder or not. The client must not allow the user to delete or update inherited permissions.
- isInheritedFrom ( integer ): If this permission is handed down from a parent folder (isInherited is set to `true`) this field contains the id of the sharing folder.
-
FolderCalendarExtendedProperties - Contains the extended properties for calendar folders
{- description ( description ): The description of the folder
- usedForSync ( usedForSync ): Indicates whether the folder should be considered for synchronization with external clients or not.
- color ( color ): Indicates the color the folder should be displayed with
- scheduleTransp ( scheduleTransp ): Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
- lastUpdate ( lastUpdate ): indicates the timestamp of the last update of the contents for cached calendars
-
description - The description of the folder
{- value ( string ): No description available
-
usedForSync - Indicates whether the folder should be considered for synchronization with external clients or not.
{- value ( string ): No description available
-
color - Indicates the color the folder should be displayed with
{- value ( string ): No description available
-
scheduleTransp - Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
{- value ( string ): No description available
-
lastUpdate - indicates the timestamp of the last update of the contents for cached calendars
{- value ( integer ): No description available
-
FolderCalendarConfig - Holds arbitrary, provider-specific configuration data for calendar accounts.
{- enabled ( boolean ): Defines if the account is enabled.
- color ( string ): Defines the account color.
- usedForSync ( boolean ): Defines if the account should be synced via CalDAV.
- uri ( string ): (ical provider only) The URI of the ICal feed that should be subscribed.
- refreshInterval ( integer ): (ical provider only) Defines the refresh interval used for the subscribed ICal feed.
- login ( string ): (ical provider only) Defines an optional login for the subscribed ICal feed.
- password ( string ): (ical provider only) An optional password for the subscribed ICal feed.
- itemId ( string ): (schedjoules provider only) Unique identifier for schedjoules feed.
- locale ( string ): (schedjoules provider only) The locale of the subscribed schedjoules feed.
-
FolderContactsExtendedProperties - Contains the extended properties for contact folders
{- usedInPicker ( usedInPicker ): Indicates whether the folder should be considered for the enterprise contact picker or not.
-
usedInPicker - Indicates whether the folder should be considered for the enterprise contact picker or not.
{- value ( boolean ): No description available
-
used_for_sync - Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
{- value ( string ): The actual used_for_sync value. Either 'true' or 'false'.
- protected ( string ): Whether this value is protected and can't be changed by the client or not. Either 'true' or 'false'
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data. Defaults to "1,2,3,5,51,52,300" (id,created_by,modified_by,creation_date,last_modified,created_from,modified_from,title)
query string id (empty) Object ID of the folder used as root folder for the search.
query string module (empty) Module identifier to search, only valid values for 7.10.5 are "files" or "infostore".
query string Body:
Description:A JSON object containing the search body
Content-type: application/json-
FolderSearchBody
{- query ( string ): The query to search
- start ( integer ): The start of a pagination, if desired. Defaults to `0`.
- size ( integer ): The page size of a pagination, if desired. Defaults to `50`.
- includeSubfolders ( boolean ): Search in subfolders of given root folder too, defaults to `true`.
- all ( boolean ): Deliver all subfolders regardless of their subscribed status, defaults to `true`.
- date ( integer ): The time stamp to limit search result to folders that are newer, defaults to `-1`.
Responses:
200:
A JSON object containing an array with matching folders. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderData
{- id ( string ): Object ID
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- last_modified_utc ( integer , read only ): Timestamp of the last modification. Note that the type is Timestamp, not Time.
- folder_id ( string ): Object ID of the parent folder.
- title ( string ): Name of this folder.
- module ( string ): Name of the module which implements this folder; e.g. "tasks", "calendar", "contacts", "infostore", or "mail"
- type ( integer ): Type of folder.
- subfolders ( boolean , read only ): Set `true` if this folder has subfolders.
- own_rights ( integer ): Permissions which apply to the current user, as described either in Permission flags or in RFC2086.
- permissions ( array[FolderPermission] ): No description available
- summary ( string ): Information about contained objects.
- standard_folder ( boolean ): Indicates whether or not folder is marked as a default folder (only OX folder).
- total ( integer , read only ): The number of objects in this Folder.
- new ( integer , read only ): The number of new objects in this Folder.
- unread ( integer , read only ): The number of unread objects in this Folder.
- deleted ( integer , read only ): The number of deleted objects in this Folder.
-
capabilities
(
integer
,
read only
, possibleValues:
0
1
2
3
* bit 0 (mailing system supports permissions),
* bit 1 (mailing system supports ordering mails by their thread reference),
* bit 2 (mailing system supports quota restrictions),
* bit 3 (mailing system supports sorting),
* bit 4 (mailing system supports folder subscription) - subscribed ( boolean ): Indicates whether this folder should appear in folder tree or not. Standard folders cannot be unsubscribed.
- subscr_subflds ( boolean ): Indicates whether subfolders should appear in folder tree or not.
-
standard_folder_type
(
integer
, possibleValues:
0
1
2
3
7
8
9
10
11
12
* 0 (non-default folder),
* 1 (task),
* 2 (calendar),
* 3 (contact),
* 7 (inbox),
* 8 (infostore),
* 9 (drafts),
* 10 (sent),
* 11 (spam),
* 12 (trash) - supported_capabilities ( array[string] , read only ): Can contain "permissions", "quota", "sort", "subscription".
- account_id ( string ): Will be null if the folder does not belong to any account (i.e. if its module doesn't support multiple accounts), is a virtual folder or an account-agnostic system folder.
- com.openexchange.publish.publicationFlag ( boolean , read only ): Indicates whether this folder is published. Read Only, provided by the com.openexchange.publish plugin.
- com.openexchange.subscribe.subscriptionFlag ( boolean , read only ): Indicates whether this folder has subscriptions storing their content in this folder. Read Only, provided by the com.openexchange.subscribe plugin.
- com.openexchange.folderstorage.displayName ( string , read only ): Provides the read only display name of the folder's owner.
- com.openexchange.share.extendedPermissions ( array[FolderExtendedPermission] ): No description available
- com.openexchange.calendar.extendedProperties ( FolderCalendarExtendedProperties ): Contains the extended properties for calendar folders
- com.openexchange.calendar.config ( FolderCalendarConfig ): Holds arbitrary, provider-specific configuration data for calendar accounts.
- com.openexchange.calendar.provider ( string ): Denotes the identifier of the underlying calendar provider.
- com.openexchange.contacts.extendedProperties ( FolderContactsExtendedProperties ): Contains the extended properties for contact folders
- used_for_sync ( used_for_sync ): Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
-
FolderPermission
{- bits ( integer ): For non-mail folders, a number as described in Permission flags.
- rights ( string ): For mail folders, the rights string as defined in RFC 2086.
- identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies (ignored for type "anonymous" or "guest").
- group ( boolean ): Set `true` if entity refers to a group, `false` if it refers to a user (ignored for type "anonymous" or "guest").
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
- includeSubfolders ( boolean ): If this permission is applied to subfolders (for type "anonymous", optional).
-
FolderExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
- bits ( integer ): A number as described in Permission flags.
- type ( string ): Set "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( contact ): A (reduced) set of Detailed contact data for "user" and "guest" entities.
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
- includeSubfolders ( boolean ): The optionally set "include subfolders" option for "anonymous" entities.
- isInherited ( boolean ): A flag indicating whether the permissions is inherited from the parent folder or not. The client must not allow the user to delete or update inherited permissions.
- isInheritedFrom ( integer ): If this permission is handed down from a parent folder (isInherited is set to `true`) this field contains the id of the sharing folder.
-
FolderCalendarExtendedProperties - Contains the extended properties for calendar folders
{- description ( description ): The description of the folder
- usedForSync ( usedForSync ): Indicates whether the folder should be considered for synchronization with external clients or not.
- color ( color ): Indicates the color the folder should be displayed with
- scheduleTransp ( scheduleTransp ): Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
- lastUpdate ( lastUpdate ): indicates the timestamp of the last update of the contents for cached calendars
-
description - The description of the folder
{- value ( string ): No description available
-
usedForSync - Indicates whether the folder should be considered for synchronization with external clients or not.
{- value ( string ): No description available
-
color - Indicates the color the folder should be displayed with
{- value ( string ): No description available
-
scheduleTransp - Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
{- value ( string ): No description available
-
lastUpdate - indicates the timestamp of the last update of the contents for cached calendars
{- value ( integer ): No description available
-
FolderCalendarConfig - Holds arbitrary, provider-specific configuration data for calendar accounts.
{- enabled ( boolean ): Defines if the account is enabled.
- color ( string ): Defines the account color.
- usedForSync ( boolean ): Defines if the account should be synced via CalDAV.
- uri ( string ): (ical provider only) The URI of the ICal feed that should be subscribed.
- refreshInterval ( integer ): (ical provider only) Defines the refresh interval used for the subscribed ICal feed.
- login ( string ): (ical provider only) Defines an optional login for the subscribed ICal feed.
- password ( string ): (ical provider only) An optional password for the subscribed ICal feed.
- itemId ( string ): (schedjoules provider only) Unique identifier for schedjoules feed.
- locale ( string ): (schedjoules provider only) The locale of the subscribed schedjoules feed.
-
FolderContactsExtendedProperties - Contains the extended properties for contact folders
{- usedInPicker ( usedInPicker ): Indicates whether the folder should be considered for the enterprise contact picker or not.
-
usedInPicker - Indicates whether the folder should be considered for the enterprise contact picker or not.
{- value ( boolean ): No description available
-
used_for_sync - Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
{- value ( string ): The actual used_for_sync value. Either 'true' or 'false'.
- protected ( string ): Whether this value is protected and can't be changed by the client or not. Either 'true' or 'false'
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the requested folders.
query long columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data.
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string ignore Which kinds of updates should be ignored. Currently, the only valid value – "deleted" – causes deleted object IDs not to be returned.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string Responses:
200:
An array with data for new, modified and deleted folders. New and modified folders are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted folders (should the ignore parameter be ever implemented) would be identified by their object IDs as plain strings, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderUpdatesResponse
{- data ( data ): Array of folders.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder_id (empty) The parent folder object ID of the newly created folder.
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string pushToken (empty) The client's push token to restrict the generated drive event
query string autorename (empty) Whether to automatically rename the folder in case an folder with the same name already exists.
query boolean Body:
Description:JSON object with "folder" object containing the modified fields and optional "notification" object to let added permission entities be notified about newly shared folders for all modules except mail. (Example: {"folder":{"module":"infostore","subscribed":true,"title":"Test123"}} or {"folder":{"module":"infostore","subscribed":true,"title":"Test123","permissions":[{"bits":403710016,"entity":84,"group":false}]},"notification":{"transport":"mail","message":"The message"}})
Content-type: application/json-
NewFolderBody
{- folder ( folder , required ): No description available
- notification ( FolderBodyNotification ): No description available
-
folder
{- id ( string ): Object ID
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- last_modified_utc ( integer , read only ): Timestamp of the last modification. Note that the type is Timestamp, not Time.
- folder_id ( string ): Object ID of the parent folder.
- title ( string ): Name of this folder.
- module ( string , required ): Name of the module which implements this folder; e.g. "tasks", "calendar", "contacts", "infostore", or "mail"
- type ( integer ): Type of folder.
- subfolders ( boolean , read only ): Set `true` if this folder has subfolders.
- own_rights ( integer ): Permissions which apply to the current user, as described either in Permission flags or in RFC2086.
- permissions ( array[FolderPermission] ): No description available
- summary ( string ): Information about contained objects.
- standard_folder ( boolean ): Indicates whether or not folder is marked as a default folder (only OX folder).
- total ( integer , read only ): The number of objects in this Folder.
- new ( integer , read only ): The number of new objects in this Folder.
- unread ( integer , read only ): The number of unread objects in this Folder.
- deleted ( integer , read only ): The number of deleted objects in this Folder.
-
capabilities
(
integer
,
read only
, possibleValues:
0
1
2
3
* bit 0 (mailing system supports permissions),
* bit 1 (mailing system supports ordering mails by their thread reference),
* bit 2 (mailing system supports quota restrictions),
* bit 3 (mailing system supports sorting),
* bit 4 (mailing system supports folder subscription) - subscribed ( boolean ): Indicates whether this folder should appear in folder tree or not. Standard folders cannot be unsubscribed.
- subscr_subflds ( boolean ): Indicates whether subfolders should appear in folder tree or not.
-
standard_folder_type
(
integer
, possibleValues:
0
1
2
3
7
8
9
10
11
12
* 0 (non-default folder),
* 1 (task),
* 2 (calendar),
* 3 (contact),
* 7 (inbox),
* 8 (infostore),
* 9 (drafts),
* 10 (sent),
* 11 (spam),
* 12 (trash) - supported_capabilities ( array[string] , read only ): Can contain "permissions", "quota", "sort", "subscription".
- account_id ( string ): Will be null if the folder does not belong to any account (i.e. if its module doesn't support multiple accounts), is a virtual folder or an account-agnostic system folder.
- com.openexchange.publish.publicationFlag ( boolean , read only ): Indicates whether this folder is published. Read Only, provided by the com.openexchange.publish plugin.
- com.openexchange.subscribe.subscriptionFlag ( boolean , read only ): Indicates whether this folder has subscriptions storing their content in this folder. Read Only, provided by the com.openexchange.subscribe plugin.
- com.openexchange.folderstorage.displayName ( string , read only ): Provides the read only display name of the folder's owner.
- com.openexchange.share.extendedPermissions ( array[FolderExtendedPermission] ): No description available
- com.openexchange.calendar.extendedProperties ( FolderCalendarExtendedProperties ): Contains the extended properties for calendar folders
- com.openexchange.calendar.config ( FolderCalendarConfig ): Holds arbitrary, provider-specific configuration data for calendar accounts.
- com.openexchange.calendar.provider ( string ): Denotes the identifier of the underlying calendar provider.
- com.openexchange.contacts.extendedProperties ( FolderContactsExtendedProperties ): Contains the extended properties for contact folders
- used_for_sync ( used_for_sync ): Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
-
FolderPermission
{- bits ( integer ): For non-mail folders, a number as described in Permission flags.
- rights ( string ): For mail folders, the rights string as defined in RFC 2086.
- identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies (ignored for type "anonymous" or "guest").
- group ( boolean ): Set `true` if entity refers to a group, `false` if it refers to a user (ignored for type "anonymous" or "guest").
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
- includeSubfolders ( boolean ): If this permission is applied to subfolders (for type "anonymous", optional).
-
FolderExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
- bits ( integer ): A number as described in Permission flags.
- type ( string ): Set "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( contact ): A (reduced) set of Detailed contact data for "user" and "guest" entities.
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
- includeSubfolders ( boolean ): The optionally set "include subfolders" option for "anonymous" entities.
- isInherited ( boolean ): A flag indicating whether the permissions is inherited from the parent folder or not. The client must not allow the user to delete or update inherited permissions.
- isInheritedFrom ( integer ): If this permission is handed down from a parent folder (isInherited is set to `true`) this field contains the id of the sharing folder.
-
FolderCalendarExtendedProperties - Contains the extended properties for calendar folders
{- description ( description ): The description of the folder
- usedForSync ( usedForSync ): Indicates whether the folder should be considered for synchronization with external clients or not.
- color ( color ): Indicates the color the folder should be displayed with
- scheduleTransp ( scheduleTransp ): Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
- lastUpdate ( lastUpdate ): indicates the timestamp of the last update of the contents for cached calendars
-
description - The description of the folder
{- value ( string ): No description available
-
usedForSync - Indicates whether the folder should be considered for synchronization with external clients or not.
{- value ( string ): No description available
-
color - Indicates the color the folder should be displayed with
{- value ( string ): No description available
-
scheduleTransp - Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
{- value ( string ): No description available
-
lastUpdate - indicates the timestamp of the last update of the contents for cached calendars
{- value ( integer ): No description available
-
FolderCalendarConfig - Holds arbitrary, provider-specific configuration data for calendar accounts.
{- enabled ( boolean ): Defines if the account is enabled.
- color ( string ): Defines the account color.
- usedForSync ( boolean ): Defines if the account should be synced via CalDAV.
- uri ( string ): (ical provider only) The URI of the ICal feed that should be subscribed.
- refreshInterval ( integer ): (ical provider only) Defines the refresh interval used for the subscribed ICal feed.
- login ( string ): (ical provider only) Defines an optional login for the subscribed ICal feed.
- password ( string ): (ical provider only) An optional password for the subscribed ICal feed.
- itemId ( string ): (schedjoules provider only) Unique identifier for schedjoules feed.
- locale ( string ): (schedjoules provider only) The locale of the subscribed schedjoules feed.
-
FolderContactsExtendedProperties - Contains the extended properties for contact folders
{- usedInPicker ( usedInPicker ): Indicates whether the folder should be considered for the enterprise contact picker or not.
-
usedInPicker - Indicates whether the folder should be considered for the enterprise contact picker or not.
{- value ( boolean ): No description available
-
used_for_sync - Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
{- value ( string ): The actual used_for_sync value. Either 'true' or 'false'.
- protected ( string ): Whether this value is protected and can't be changed by the client or not. Either 'true' or 'false'
-
FolderBodyNotification
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
A JSON object with the object ID of the folder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderUpdateResponse
{- data ( string ): The object id of the folder.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- warnings ( warnings ): Present in case of one or more warnings. In case one warning occurs the object contains a JSONObject with error data. If more warnings occur, the object contains a JSONArray that holds JSONObjects with error data.
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mails Name Scopes oauth
read_tasks Name Scopes oauth
read_calendar Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type parent (empty) Object ID of a folder, which is the parent folder of the requested folders.
query string columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data.
query string all (empty) Set to 1 to list even not subscribed folders.
query integer tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string errorOnDuplicateName (empty) query boolean Responses:
200:
A JSON object containing an array with data for all folders, which have the folder with the requested object ID as parent. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersResponse
{- data ( data ): Array of folders. Each folder is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of a folder.
query string columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data.
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string Responses:
200:
An array with data for all parent nodes of a folder. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersResponse
{- data ( data ): Array of folders. Each folder is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,300". Each column is specified by a numeric column identifier, see Common folder data and Detailed folder data.
query string content_type (empty) The desired content type (either numbers or strings; e.g. "tasks", "calendar", "contacts", "mail", "infostore").
query string tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string all (empty) Set to 1 to list even not subscribed folders.
query integer Responses:
200:
A JSON object containing an array with data for all folders that are considered as shared by the user. Each array element describes one folder and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersResponse
{- data ( data ): Array of folders. Each folder is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the folder to check.
query string type (empty) The type of the files to upload (e. g. 'filestorage, 'pim')
query string Body:
Description:A JSON object containing an array of file meta data (size and name).
Content-type: application/json-
FolderCheckLimitsData
{- files ( array[FolderCheckLimitsFiles] ): An array of files
-
FolderCheckLimitsFiles
{- size ( integer ): The size of the file to check in bytes.
- name ( string ): The name of the file to check.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderCheckLimitsResponse
{- data ( FolderCheckLimitsResponseData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
FolderCheckLimitsResponseData
{- errors ( array[FolderCheckLimitsResponseErrorData] ): No description available
-
FolderCheckLimitsResponseErrorData
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type allow_enqueue (empty) Optional flag that specifies whether the request is allowed for being submitted to job queue.
query boolean id (empty) Object ID of the updated folder.
query string timestamp (empty) Timestamp of the updated folder. If the folder was modified after the specified timestamp, then the update must fail.
query long tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string allowed_modules (empty) An array of modules (either numbers or strings; e.g. "tasks,calendar,contacts,mail") supported by requesting client. If missing, all available modules are considered.
query string cascadePermissions (empty) `true` to cascade permissions to all sub-folders. The user must have administrative permissions to all sub-folders subject to change. If one permission change fails, the entire operation fails.
query boolean pushToken (empty) The client's push token to restrict the generated drive event
query string autorename (empty) Whether to automatically rename the folder in case an folder with the same name already exists.
query boolean ignoreWarnings (empty) Indicates whether warnings should be ignored or not.
query boolean Body:
Description:JSON object with "folder" object containing the modified fields and optional "notification" object to let added permission entities be notified about newly shared folders for all modules except mail. (Example: {"folder":{"title":"test123"}} or {"folder":{"permissions":[{"bits":403710016,"entity":84,"group":false}]},"notification":{"transport":"mail","message":"The message"}})
Content-type: application/json-
FolderBody
{- folder ( FolderData , required ): No description available
- notification ( FolderBodyNotification ): No description available
-
FolderData
{- id ( string ): Object ID
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- last_modified_utc ( integer , read only ): Timestamp of the last modification. Note that the type is Timestamp, not Time.
- folder_id ( string ): Object ID of the parent folder.
- title ( string ): Name of this folder.
- module ( string ): Name of the module which implements this folder; e.g. "tasks", "calendar", "contacts", "infostore", or "mail"
- type ( integer ): Type of folder.
- subfolders ( boolean , read only ): Set `true` if this folder has subfolders.
- own_rights ( integer ): Permissions which apply to the current user, as described either in Permission flags or in RFC2086.
- permissions ( array[FolderPermission] ): No description available
- summary ( string ): Information about contained objects.
- standard_folder ( boolean ): Indicates whether or not folder is marked as a default folder (only OX folder).
- total ( integer , read only ): The number of objects in this Folder.
- new ( integer , read only ): The number of new objects in this Folder.
- unread ( integer , read only ): The number of unread objects in this Folder.
- deleted ( integer , read only ): The number of deleted objects in this Folder.
-
capabilities
(
integer
,
read only
, possibleValues:
0
1
2
3
* bit 0 (mailing system supports permissions),
* bit 1 (mailing system supports ordering mails by their thread reference),
* bit 2 (mailing system supports quota restrictions),
* bit 3 (mailing system supports sorting),
* bit 4 (mailing system supports folder subscription) - subscribed ( boolean ): Indicates whether this folder should appear in folder tree or not. Standard folders cannot be unsubscribed.
- subscr_subflds ( boolean ): Indicates whether subfolders should appear in folder tree or not.
-
standard_folder_type
(
integer
, possibleValues:
0
1
2
3
7
8
9
10
11
12
* 0 (non-default folder),
* 1 (task),
* 2 (calendar),
* 3 (contact),
* 7 (inbox),
* 8 (infostore),
* 9 (drafts),
* 10 (sent),
* 11 (spam),
* 12 (trash) - supported_capabilities ( array[string] , read only ): Can contain "permissions", "quota", "sort", "subscription".
- account_id ( string ): Will be null if the folder does not belong to any account (i.e. if its module doesn't support multiple accounts), is a virtual folder or an account-agnostic system folder.
- com.openexchange.publish.publicationFlag ( boolean , read only ): Indicates whether this folder is published. Read Only, provided by the com.openexchange.publish plugin.
- com.openexchange.subscribe.subscriptionFlag ( boolean , read only ): Indicates whether this folder has subscriptions storing their content in this folder. Read Only, provided by the com.openexchange.subscribe plugin.
- com.openexchange.folderstorage.displayName ( string , read only ): Provides the read only display name of the folder's owner.
- com.openexchange.share.extendedPermissions ( array[FolderExtendedPermission] ): No description available
- com.openexchange.calendar.extendedProperties ( FolderCalendarExtendedProperties ): Contains the extended properties for calendar folders
- com.openexchange.calendar.config ( FolderCalendarConfig ): Holds arbitrary, provider-specific configuration data for calendar accounts.
- com.openexchange.calendar.provider ( string ): Denotes the identifier of the underlying calendar provider.
- com.openexchange.contacts.extendedProperties ( FolderContactsExtendedProperties ): Contains the extended properties for contact folders
- used_for_sync ( used_for_sync ): Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
-
FolderPermission
{- bits ( integer ): For non-mail folders, a number as described in Permission flags.
- rights ( string ): For mail folders, the rights string as defined in RFC 2086.
- identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies (ignored for type "anonymous" or "guest").
- group ( boolean ): Set `true` if entity refers to a group, `false` if it refers to a user (ignored for type "anonymous" or "guest").
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
- includeSubfolders ( boolean ): If this permission is applied to subfolders (for type "anonymous", optional).
-
FolderExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
- bits ( integer ): A number as described in Permission flags.
- type ( string ): Set "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( contact ): A (reduced) set of Detailed contact data for "user" and "guest" entities.
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
- includeSubfolders ( boolean ): The optionally set "include subfolders" option for "anonymous" entities.
- isInherited ( boolean ): A flag indicating whether the permissions is inherited from the parent folder or not. The client must not allow the user to delete or update inherited permissions.
- isInheritedFrom ( integer ): If this permission is handed down from a parent folder (isInherited is set to `true`) this field contains the id of the sharing folder.
-
FolderCalendarExtendedProperties - Contains the extended properties for calendar folders
{- description ( description ): The description of the folder
- usedForSync ( usedForSync ): Indicates whether the folder should be considered for synchronization with external clients or not.
- color ( color ): Indicates the color the folder should be displayed with
- scheduleTransp ( scheduleTransp ): Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
- lastUpdate ( lastUpdate ): indicates the timestamp of the last update of the contents for cached calendars
-
description - The description of the folder
{- value ( string ): No description available
-
usedForSync - Indicates whether the folder should be considered for synchronization with external clients or not.
{- value ( string ): No description available
-
color - Indicates the color the folder should be displayed with
{- value ( string ): No description available
-
scheduleTransp - Indicates whether the calendar object resources in a calendar collection will affect the owner's busy time information or not
{- value ( string ): No description available
-
lastUpdate - indicates the timestamp of the last update of the contents for cached calendars
{- value ( integer ): No description available
-
FolderCalendarConfig - Holds arbitrary, provider-specific configuration data for calendar accounts.
{- enabled ( boolean ): Defines if the account is enabled.
- color ( string ): Defines the account color.
- usedForSync ( boolean ): Defines if the account should be synced via CalDAV.
- uri ( string ): (ical provider only) The URI of the ICal feed that should be subscribed.
- refreshInterval ( integer ): (ical provider only) Defines the refresh interval used for the subscribed ICal feed.
- login ( string ): (ical provider only) Defines an optional login for the subscribed ICal feed.
- password ( string ): (ical provider only) An optional password for the subscribed ICal feed.
- itemId ( string ): (schedjoules provider only) Unique identifier for schedjoules feed.
- locale ( string ): (schedjoules provider only) The locale of the subscribed schedjoules feed.
-
FolderContactsExtendedProperties - Contains the extended properties for contact folders
{- usedInPicker ( usedInPicker ): Indicates whether the folder should be considered for the enterprise contact picker or not.
-
usedInPicker - Indicates whether the folder should be considered for the enterprise contact picker or not.
{- value ( boolean ): No description available
-
used_for_sync - Indicates whether this folder should used for sync or not. Standard folders cannot be changed.
{- value ( string ): The actual used_for_sync value. Either 'true' or 'false'.
- protected ( string ): Whether this value is protected and can't be changed by the client or not. Either 'true' or 'false'
-
FolderBodyNotification
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
A JSON object with the object id of the folder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderUpdateResponse
{- data ( string ): The object id of the folder.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- warnings ( warnings ): Present in case of one or more warnings. In case one warning occurs the object contains a JSONObject with error data. If more warnings occur, the object contains a JSONArray that holds JSONObjects with error data.
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
202:
The operation did not complete in time and was added to job queue providing the job identifier. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GetJobResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- job ( string ): The job identifier
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails Name Scopes oauth
write_tasks Name Scopes oauth
write_calendar Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type tree (empty) The identifier of the folder tree. If missing "0" (primary folder tree) is assumed.
query string pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON array of folder ids that shall be restored.
Content-type: application/x-www-form-urlencoded
Responses:
200:
A JSON object containing an array with data for all folders requested to restore. Each array element describes one folder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FolderRestoreResponse
{- folder ( string ): Folder ID
- path ( array[FolderPathData] ): The folder path of the restored folder down to root folder.
-
FolderPathData
{- id ( string ): The folder id
- title ( string ): The folder title
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
Groups
The group module allows to query available groups. It is mainly used by the dialog for the selection of participants.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the group that shall be updated.
query integer timestamp (empty) Timestamp of the last update of the group to update. If the group was modified after the specified timestamp, then the update must fail.
query long Body:
Description:A JSON object containing the group data fields to change. Only modified fields are present and the field id is omitted.
Content-type: application/json-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the group.
query integer Responses:
200:
A JSON object containing the group data. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupResponse
{- data ( GroupData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object with the search parameters.
Content-type: application/json-
GroupSearchBody
{- pattern ( string ): Search pattern to find groups. In the pattern, the character "*" matches zero or more characters and the character "?" matches exactly one character. All other characters match only themselves.
Responses:
200:
A JSON object containing an array of group objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupsResponse
{- data ( array[GroupData] ): Array of group objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the group data. The field id is not present.
Content-type: application/json-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
Responses:
200:
A JSON object with the ID of the newly created group. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupUpdateResponse
{- data ( GroupUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupUpdateData
{- id ( integer ): The ID of a newly created group.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Group data.
query string Responses:
200:
A JSON object containing an array of group objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupsResponse
{- data ( array[GroupData] ): Array of group objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array of JSON objects with the id of the requested groups.
Content-type: application/json-
GroupListElement
{- id ( integer ): ID of a group.
Responses:
200:
A JSON object containing an array of group objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupsResponse
{- data ( array[GroupData] ): Array of group objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the requested groups.
query long Responses:
200:
A JSON object with fields `new`, `modified` and `deleted` representing arrays of new, modified and deleted group objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupUpdatesResponse
{- data ( GroupUpdatesData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupUpdatesData
{- new ( array[GroupData] ): Array of new group objects.
- modified ( array ): Array of modified group objects.
- deleted ( array ): Array of deleted group objects.
-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the group to delete.
query long Body:
Description:A JSON object with the field `id` containing the unique identifier of the group.
Content-type: application/json-
GroupListElement
{- id ( integer ): ID of a group.
Responses:
200:
A JSON object with an empty array if the group was deleted successfully. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GroupsResponse
{- data ( array[GroupData] ): Array of group objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
GroupData
{- id ( integer ): The group ID.
- display_name ( string ): Display name of the group.
- name ( string ): Internal name with character restrictions.
- members ( array[integer] ): The array contains identifiers of users that are member of the group.
- last_modified_utc ( integer , read only ): Timestamp of the last modification.
-
-
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array with available halo providers. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
HaloServicesResponse
{- data ( array[string] ): An array with available halo providers.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Important:
This endpoint is deprecated and will be removed in the future. Use the new /contacts/picture endpoint instead.
At least one of the optional search parameters should be set. All parameters are connected by OR during the search. More specific parameters like
user_id
orid
are prioritized in case of multiple matches.Parameters:
Parameter Value Description Parameter Type Data Type session (empty) Falls back to the public session cookie.
query string internal_userid (empty) The internal user ID of a user whose picture you want to load.
query integer userid (empty) An alias for `internal_userid`.
query integer user_id (empty) An alias for `internal_userid`.
query integer id (empty) A contact ID.
query string email (empty) An email to searchz for. Will pick global address book matches before regular matches. After that picks the most recently changed contact.
query string email1 (empty) An alias for `email`.
query string email2 (empty) An alias for `email`.
query string email3 (empty) An alias for `email`.
query string transformationNeeded (empty) Indicate if the image needs to be transformed.
query boolean cropWidth (empty) The width a cropped image should have. Needs to be a bigger value than the images width.
query integer cropHeight (empty) The height a cropped image should have. Needs to be a bigger value than the images hight.
query integer rotate (empty) Indicate if the image should get rotated
query boolean compress (empty) Indicate if the image should be compressed. Output format depends on scaleType.
query boolean width (empty) The maximum width of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxWidth'. Default is 4096.
query integer height (empty) The maximum height of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxHeight'. Default is 4096.
query integer shrinkOnly (empty) Set to 'true' to only scale images 'greater than' target size
query boolean scaleType The scale type to use.
query string Responses:
200:
The picture with proper ETag and caching headers set.
Content-type: application/json-
Unknown
404:
If no picture could be found.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type provider (empty) The halo provider, like "com.openexchange.halo.contacts". See /halo/contact?action=services for available providers.
query string email1 (empty) The first eMail address of the contact
query string email2 (empty) The second eMail address of the contact
query string email3 (empty) The third eMail address of the contact
query string internal_userid (empty) The internal id of the user
query integer timezone (empty) The timezone.
query string columns (empty) A comma-separated list of columns to return. See Column identifiers for a mapping of numeric identifiers to fields.
query string start (empty) The start point. Only mandatory for provider "com.openexchange.halo.appointments".
query long end (empty) The end point. Only mandatory for provider "com.openexchange.halo.appointments".
query long sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. Optional for provider "com.openexchange.halo.appointments".
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Optional for provider "com.openexchange.halo.appointments".
query string limit (empty) The maximum number of mails within the result. Optional for provider "com.openexchange.halo.mail".
query integer Responses:
200:
A JSON object containing an array with data for the requested columns. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
HaloInvestigationResponse
{- data ( data ): Array of halo data objects specified by the corresponding identifiers in the `columns` parameter. The element types can be distinguished.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type provider (empty) The halo provider, like "com.openexchange.halo.contacts". See /halo/contact?action=services for available providers.
query string timezone (empty) The timezone.
query string columns (empty) A comma-separated list of columns to return. See Column identifiers for a mapping of numeric identifiers to fields.
query string start (empty) The start point. Only mandatory for provider "com.openexchange.halo.appointments".
query long end (empty) The end point. Only mandatory for provider "com.openexchange.halo.appointments".
query long sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. Optional for provider "com.openexchange.halo.appointments".
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Optional for provider "com.openexchange.halo.appointments".
query string limit (empty) The maximum number of mails within the result. Optional for provider "com.openexchange.halo.mail".
query integer Body:
Description:A JSON object containing the contact's data.
Content-type: application/x-www-form-urlencoded-
ContactDataWithInternalId Composed Schema
ALLOF: Object Object -
Unknown
{- contact_id ( integer ): The id of the contact
- internal_userid ( integer ): The internal user id
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
A JSON object containing an array with data for the requested columns. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
HaloInvestigationResponse
{- data ( data ): Array of halo data objects specified by the corresponding identifiers in the `columns` parameter. The element types can be distinguished.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Image
The image module allows to download images from Open-Xchange server without providing a session ID in request's URL parameters.-
Important: This endpoint is deprecated and will be removed in the future. Use the new /contacts/picture endpoint instead.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_contacts
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) The folder ID in which the contact resides.
query string id (empty) The object ID of the contact.
query integer transformationNeeded (empty) Indicate if the image needs to be transformed.
query boolean cropWidth (empty) The width a cropped image should have. Needs to be a bigger value than the images width.
query integer cropHeight (empty) The height a cropped image should have. Needs to be a bigger value than the images hight.
query integer rotate (empty) Indicate if the image should get rotated
query boolean compress (empty) Indicate if the image should be compressed. Output format depends on scaleType.
query boolean width (empty) The maximum width of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxWidth'. Default is 4096.
query integer height (empty) The maximum height of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxHeight'. Default is 4096.
query integer shrinkOnly (empty) Set to 'true' to only scale images 'greater than' target size
query boolean scaleType The scale type to use.
query string Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/octet-stream-
Unknown
400:
If request cannot be handled.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the uploaded image.
query string Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/octet-stream-
Unknown
400:
If request cannot be handled.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type uid (empty) The identifier of the image previously obtained from the authentication_results field of the mail module.
query string Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/octet-stream-
Unknown
400:
If request cannot be handled.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type uid (empty) The identifier of the uploaded image.
query string Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/octet-stream-
Unknown
400:
If request cannot be handled.
-
-
Important: This endpoint is deprecated and will be removed in the future. Use the new /contacts/picture endpoint instead.
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The object ID of the user.
query string transformationNeeded (empty) Indicate if the image needs to be transformed.
query boolean cropWidth (empty) The width a cropped image should have. Needs to be a bigger value than the images width.
query integer cropHeight (empty) The height a cropped image should have. Needs to be a bigger value than the images hight.
query integer rotate (empty) Indicate if the image should get rotated
query boolean compress (empty) Indicate if the image should be compressed. Output format depends on scaleType.
query boolean width (empty) The maximum width of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxWidth'. Default is 4096.
query integer height (empty) The maximum height of the target image. Can not be greater than the value set in 'com.openexchange.tools.images.maxHeight'. Default is 4096.
query integer shrinkOnly (empty) Set to 'true' to only scale images 'greater than' target size
query boolean scaleType The scale type to use.
query string Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/octet-stream-
Unknown
400:
If request cannot be handled.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) The folder ID in which the mail resides.
query string id (empty) The object ID of the mail.
query string uid (empty) The identifier of the image inside the referenced mail.
query string accountId (empty) The mail account identifier
query integer Responses:
200:
The content of the requested image is directly written into output stream.
Content-type: application/octet-stream-
Unknown
400:
If request cannot be handled.
-
-
-
Import
The module import allows to import specific module data (like Contacts, Tasks or Appointments) in several formats (iCal, vCard, CSV) into a folder. Please note: The callback for all actions of this bundle is `callback_import`, not `callback_$actionname` for legacy purposes.-
Example CSV
"Given name","Sur name" "Günther","Mustermann" "Hildegard","Musterfrau"
The delimiter may be any CSV-valid character (e.g. "," or ";"). The first line must contain the column titles that are related to the corresponding fields of the ContactData model (see getContact request). See Detailed contact data for a mapping of fields to CSV column titles.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type allow_enqueue (empty) Optional flag that specifies whether the request is allowed for being submitted to job queue.
query boolean folder (empty) Object ID of the folder into which the data should be imported. This must be a contact folder.
query string charset (empty) A fixed character encoding to use when parsing the uploaded file, overriding the built-in defaults, following the conventions documented in RFC 2278.
query string Body:
Description:No description available
Content-type: multipart/form-data-
importCSVBody
{- file ( string , required ): The CSV file containing the contact data. The column titles are the ones described in Detailed contact data.
Responses:
200:
A HTML page as described in File uploads containing a JSON object with the field `data` that represents an array of objects each consisting of the fields `id`, `folder_id` and `last_modified` of the newly created contacts. In case of errors the JSON object contains the well known error fields.
Content-type: text/html-
Unknown
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_calendar Name Scopes oauth
write_tasks
Parameters:
Parameter Value Description Parameter Type Data Type allow_enqueue (empty) Optional flag that specifies whether the request is allowed for being submitted to job queue.
query boolean folder (empty) Object ID of the folder into which the data should be imported. This may be be an appointment or a task folder.
query string suppressNotification (empty) Can be used to disable the notifications for new appointments that are imported through the given iCal file. This help keeping the Inbox clean if a lot of appointments need to be imported. The value of this parameter does not matter because only for the existence of the parameter is checked.
query boolean ignoreUIDs (empty) When set to `true`, UIDs are partially ignored during import of tasks and appointments from iCal. Internally, each UID is replaced statically by a random one to preserve possibly existing relations between recurring appointments in the same iCal file, but at the same time to avoid collisions with already existing tasks and appointments.
query boolean plainJson (empty) When set to `true`, signals that client expects plain JSON; no JavaScript callback.
query boolean Body:
Description:No description available
Content-type: multipart/form-data-
importICalBody
{- file ( string , required ): The iCal file containing the appointment and task data.
Responses:
200:
A HTML page as described in File uploads containing a JSON object with the field `data` that represents an array of objects each consisting of the fields `id`, `folder_id` and `last_modified` of the newly created appointments/tasks. In case of errors the JSON object contains the well known error fields. Beside a field `warnings` may contain an array of objects with warning data containing customary error fields.
Content-type: text/html-
Unknown
-
-
Supported vCard formats
- vCard 2.1
- vCard 3.0
- vCalendar 1.0
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type allow_enqueue (empty) Optional flag that specifies whether the request is allowed for being submitted to job queue.
query boolean folder (empty) Object ID of the folder into which the data should be imported. This must be a contact folder.
query string Body:
Description:No description available
Content-type: multipart/form-data-
importVCardBody
{- file ( string , required ): The vCard file.
Responses:
200:
A HTML page as described in File uploads containing a JSON object with the field `data` that represents an array of objects each consisting of the fields `id`, `folder_id` and `last_modified` of the newly created objects. In case of errors the JSON object contains the well known error fields.
Content-type: text/html-
Unknown
-
Example: exported Outlook CSV
First Name,Last Name Günther,Mustermann Hildegard,Musterfrau
The column titles in the first line of the CSV file may be those used by the English, French or German version of Outlook.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_contacts
Parameters:
Parameter Value Description Parameter Type Data Type allow_enqueue (empty) Optional flag that specifies whether the request is allowed for being submitted to job queue.
query boolean folder (empty) Object ID of the folder into which the data should be imported. This must be a contact folder.
query string charset (empty) A fixed character encoding to use when parsing the uploaded file, overriding the built-in defaults, following the conventions documented in RFC 2278.
query string Body:
Description:No description available
Content-type: multipart/form-data-
importOutlookCSVBody
{- file ( string , required ): The CSV file **with Windows' default encoding CP-1252** containing the contact data. The column titles are those used by the English, French or German version of Outlook.
Responses:
200:
A HTML page as described in File uploads containing a JSON object with the field `data` that represents an array of objects each consisting of the fields `id`, `folder_id` and `last_modified` of the newly created contacts. In case of errors the JSON object contains the well known error fields.
Content-type: text/html-
Unknown
-
-
-
Infostore
The module infostore or filestore or files or drive has been renamed quite often. Whatever its name, it combines the knowledge database, bookmarks and document storage.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be unlocked.
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the base object.
query string folder (empty) The folder ID of the base object.
query string timestamp (empty) Timestamp of the last update of the infoitem.
query long pushToken (empty) The client's push token to restrict the generated drive event
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON array of objects with the fields `id` and `folder` representing infoitems that shall be restored.
Content-type: application/json-
InfoItemListElement
{- id ( string , required ): The object ID of the infoitem (e.g. "31841/36639").
- folder ( string , required ): The object ID of the related folder (e.g. "31841").
Responses:
200:
A JSON object containing an array with data for all infoitems requested to restore. Each array element describes one infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsRestoreResponse
{- data ( array[InfoItemsRestoreResponseData] ): The restored items
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
InfoItemsRestoreResponseData - The restored item
{- id ( string ): Object ID
- path ( array[InfoFolderPathData] ): Folder path from restored file down to root folder
-
InfoFolderPathData
{- id ( string ): The folder id
- title ( string ): The folder title
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Responses:
200:
A JSON object containing an array with data for all infoitems that are considered as shared by the user. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
It is possible to add a filename to the request's URI like
/infostore/{filename}?action=zipfolder
. The filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the infoitems.
query string recursive (empty) `true` to also include subfolders and their infoitems respectively; otherwise `false` to only consider the infoitems of specified.
query boolean scan (empty) Flag to request an Anti-Virus scan for the ifoitems in the specified folder before downloading them.
query boolean Responses:
200:
The raw byte data of the ZIP archive. The response type for the HTTP request is set to `application/zip`.
Content-type: application/zip-
Unknown
-
-
This request cannot change or add files. Therefore it is necessary to use the
POST
method.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be copied.
query string pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON object containing the modified fields of the destination infoitem. The field `id` must not be present.
Content-type: application/json-
InfoItemData
{- object_permissions ( array[InfoItemPermission] ): An array of object permissions.
- shareable ( boolean , read only ): (read-only) Indicates if the item can be shared.
- title ( string ): The title.
- url ( string ): Link/URL to item.
- filename ( string ): Displayed filename of the document.
- file_mimetype ( string ): MIME type of the document. The client converts known types to more readable names before displaying them.
- file_size ( integer ): The size of the document in bytes.
- version ( string ): Version of the document. NULL can be used to denote the most recent version and will be set in responses if versions are not supported by the underlying storage.
- description ( string ): A description if the item.
- locked_until ( integer , read only ): The time until which this item will presumably be locked. Only set if the docment is currently locked, `0` otherwise.
- file_md5sum ( string ): MD5Sum of the document.
- version_comment ( string ): A version comment is used to file a changelog for the file.
- current_version ( boolean , read only ): `true` if this version is the current version, `false` otherwise. Note: This is not writeable.
- number_of_versions ( integer , read only ): The number of all versions of the item. Note: This is not writeable.
- sequence_number ( integer ): Sequence number of the infoitem.
- capture_date ( integer , read only ): Date and time when media file was captured/recorded
- geolocation ( string , read only ): The geo location associated with the media resource as latitude and longitude pair; e.g. "(45 23)"
- width ( integer , read only ): The width of the media resource
- height ( integer , read only ): The height of the media resource
- camera_iso_speed ( integer , read only ): The ISO speed value of a camera or input device associated with the media resource
- camera_aperture ( string , read only ): The aperture used to create the photo (f-number)
- camera_exposure_time ( string , read only ): The length of the exposure, in seconds
- camera_focal_length ( string , read only ): The focal length used to create the photo, in millimeters
- camera_model ( string , read only ): The name of the camera model associated with the media resource
- media_meta ( media_meta , read only ): Contains metadata extracted from the media resource
- media_status ( string , read only ): Represents the status for the process of extracting metadata from a media resource
- media_date ( integer , read only ): A special field, which prefers the capture date and falls-back to last-modified date if absent
- com.openexchange.share.extendedObjectPermissions ( array[InfoItemExtendedPermission] ): An array of extended object permissions (read-only).
- com.openexchange.realtime.resourceID ( string , read only ): The resource identifier for the infoitem for usage within the realtime component.
- com.openexchange.file.storage.mail.mailMetadata ( com.openexchange.file.storage.mail.mailMetadata , read only ): Contains additional metadata for items in the "maildrive" file storage.
- unique_id ( string , read only ): Lifetime unique identifier of the file that does not change e.g. after move or rename operations.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string , required ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
InfoItemPermission
{-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies.
- group ( boolean ): Is `true` if entity refers to a group, `false` if it refers to a user.
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
-
bits
(
integer
, possibleValues:
-
InfoItemExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - type ( string ): "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( ContactData ): No description available
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
A JSON object with the object ID of the newly created infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemUpdateResponse
{- data ( string ): The object ID of the updated infoitem.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Copies an infoitem's data with the possibility to change the file. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the infoitem's data while the file must be placed in a file field namedfile
(see also File uploads).Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be copies.
query string pushToken (empty) The push token of the drive client
query string Body:
Description:No description available
Content-type: multipart/form-data-
copyInfoItemAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the infoitem's data (See InfoItemData model of the getInfoItem request). Only modified fields must be specified but at least `{"folder_id":"destination"}`.
- file ( string , required ): The metadata as per ``.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the infoitem or errors if some occurred.
Content-type: text/html-
Unknown
-
-
It is possible to add a filename to the request's URI like
/infostore/{filename}?action=document
. The filename may be added to the customary infostore path to suggest a filename to a Save-As dialog.If the file is an image file then it is possible to use the image transformation parameters.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the infoitems.
query string id (empty) Object ID of the requested infoitem.
query string version (empty) If present the infoitem data describes the given version. Otherwise the current version is returned.
query integer content_type (empty) If present the response declares the given `content_type` in the Content-Type header.
query string scan (empty) Flag to request an Anti-Virus scan for the specified document before downloading them.
query boolean format (empty) Allows to set "metadata" as value to retrieve an image's metadata information (EXIF directory, etc.) as a JSON structure. If there are no metadata available (e.g. infoitem document is not an image) 404 Not Found is returned.
query string rotate (empty) Adds a 'rotate' transformation, leading to the image being rotated according to the contained EXIF information.
query boolean width (empty) The maximum width of the target image.
query integer height (empty) The maximum height of the target image.
query integer shrinkOnly (empty) Set to true to only scale images 'greater than' target size.
query boolean scaleType Defines the scale type. Possible value:
cover
- The "cover" scale type, specifying the minimum target dimensions.
The source image will be resized in a way that the resulting image covers the target resolution entirely, with the original aspect ratio being preserved. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "cover", will result in the picture being resized to 267x200 pixels.contain
- The "contain" scale type, specifying the maximum target dimensions.
The source image will be resized in a way that the resulting image fits into the target resolution entirely, with the original aspect ratio being preserved. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "contain", will result in the picture being resized to 200x150 pixels.containforcedimension
- The "containforcedimension" scale type, specifying the maximum target dimensions.
The source image will be resized in a way that the resulting image fits into the target resolution entirely, with the original aspect ratio being preserved while smaller sides get padded to fit exact dimension. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "containforcedimension", will result in the picture being first resized to 200x150 pixels, then height gets padded by 25 pixels per side resulting in exactly 200x200 pixels.coverandcrop
- The "coverandcrop" scale type, specifying the target dimensions.
If the source image is bigger than the target dimension, in a first step the image will be resized in a way that the resulting image covers the target resolution entirely, with the original aspect ratio being preserved. In a second step the image will be cropped to fit the target dimension. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "coverandcrop", will result in the picture being resized to 267x200 pixels and then cropped to fit 200x200. In case the image is smaller than then target dimension the image will not be resized and instead it gets padded to fit exact dimension. For example, with an original resolution of 100x100 pixels and a target dimension of 200x200 pixels and type "coverandcrop", will result in the picture being padded on all sides with 50 pixels.auto
- The "auto" scale type.
query string cropWidth (empty) The width of the specified rectangular region.
query integer cropHeight (empty) The height of the specified rectangular region.
query integer cropX (empty) The X coordinate of the upper-left corner of the specified rectangular region.
query integer cropY (empty) The Y coordinate of the upper-left corner of the specified rectangular region.
query integer Responses:
200:
The raw byte data of the document. The response type for the HTTP request is set accordingly to the defined mimetype for this infoitem or the content_type given.
Content-type: application/octet-stream-
Unknown
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type attached (empty) The ID of the object to which the attachment belongs.
query integer folder (empty) The folder ID of the object.
query integer module (empty) The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).
query integer attachment (empty) The ID of the attachment to save.
query string pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON object describing the attachment's infoitem. The field `id`is not included. The fields in this infoitem object override values from the attachment. The folder_id must be given. It is possible to let added object permission entities be notified about newly shared files. In that case add a "notification" object.
Content-type: application/json-
InfoItemBody
{- file ( InfoItemData , required ): No description available
- notification ( InfoItemBodyNotification ): Responsible for sending out notifications for changed object permissions of an infoitem.
-
InfoItemData
{- object_permissions ( array[InfoItemPermission] ): An array of object permissions.
- shareable ( boolean , read only ): (read-only) Indicates if the item can be shared.
- title ( string ): The title.
- url ( string ): Link/URL to item.
- filename ( string ): Displayed filename of the document.
- file_mimetype ( string ): MIME type of the document. The client converts known types to more readable names before displaying them.
- file_size ( integer ): The size of the document in bytes.
- version ( string ): Version of the document. NULL can be used to denote the most recent version and will be set in responses if versions are not supported by the underlying storage.
- description ( string ): A description if the item.
- locked_until ( integer , read only ): The time until which this item will presumably be locked. Only set if the docment is currently locked, `0` otherwise.
- file_md5sum ( string ): MD5Sum of the document.
- version_comment ( string ): A version comment is used to file a changelog for the file.
- current_version ( boolean , read only ): `true` if this version is the current version, `false` otherwise. Note: This is not writeable.
- number_of_versions ( integer , read only ): The number of all versions of the item. Note: This is not writeable.
- sequence_number ( integer ): Sequence number of the infoitem.
- capture_date ( integer , read only ): Date and time when media file was captured/recorded
- geolocation ( string , read only ): The geo location associated with the media resource as latitude and longitude pair; e.g. "(45 23)"
- width ( integer , read only ): The width of the media resource
- height ( integer , read only ): The height of the media resource
- camera_iso_speed ( integer , read only ): The ISO speed value of a camera or input device associated with the media resource
- camera_aperture ( string , read only ): The aperture used to create the photo (f-number)
- camera_exposure_time ( string , read only ): The length of the exposure, in seconds
- camera_focal_length ( string , read only ): The focal length used to create the photo, in millimeters
- camera_model ( string , read only ): The name of the camera model associated with the media resource
- media_meta ( media_meta , read only ): Contains metadata extracted from the media resource
- media_status ( string , read only ): Represents the status for the process of extracting metadata from a media resource
- media_date ( integer , read only ): A special field, which prefers the capture date and falls-back to last-modified date if absent
- com.openexchange.share.extendedObjectPermissions ( array[InfoItemExtendedPermission] ): An array of extended object permissions (read-only).
- com.openexchange.realtime.resourceID ( string , read only ): The resource identifier for the infoitem for usage within the realtime component.
- com.openexchange.file.storage.mail.mailMetadata ( com.openexchange.file.storage.mail.mailMetadata , read only ): Contains additional metadata for items in the "maildrive" file storage.
- unique_id ( string , read only ): Lifetime unique identifier of the file that does not change e.g. after move or rename operations.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string , required ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
InfoItemPermission
{-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies.
- group ( boolean ): Is `true` if entity refers to a group, `false` if it refers to a user.
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
-
bits
(
integer
, possibleValues:
-
InfoItemExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - type ( string ): "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( ContactData ): No description available
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
-
InfoItemBodyNotification - Responsible for sending out notifications for changed object permissions of an infoitem.
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
A JSON object with the object ID of the newly created infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemUpdateResponse
{- data ( string ): The object ID of the updated infoitem.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the infoitem to move.
query long folder (empty) ID of the destination folder.
query string id (empty) Object ID of the infoitem that shall be moved.
query string pushToken (empty) The client's push token to restrict the generated drive event
query string ignoreWarnings (empty) Indicates whether warnings should be ignored or not.
query boolean Responses:
200:
A JSON object with an array of infoitem identifiers that could not be moved (due to a conflict). Th array is empty if everything went fine. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemMovedResponse
{- data ( string ): The new infoitem identifier.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- warnings ( warnings ): Present in case of one or more warnings. In case one warning occurs the object contains a JSONObject with error data. If more warnings occur, the object contains a JSONArray that holds JSONObjects with error data.
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) ID of the destination folder.
query string pushToken (empty) The push token of the drive client
query string ignoreWarnings (empty) Indicates whether warnings should be ignored or not.
query boolean Body:
Description:A JSON array of JSON objects each referencing to an existing infoitem that is supposed to be moved to the destination folder.
Content-type: application/json-
InfoItemListElement
{- id ( string , required ): The object ID of the infoitem (e.g. "31841/36639").
- folder ( string , required ): The object ID of the related folder (e.g. "31841").
Responses:
200:
A JSON object with an array of infoitem identifiers that could not be moved (due to a conflict). Th array is empty if everything went fine. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsMovedResponse
{- data ( array[InfoItemListElement] ): Array of infoitems that could not be moved (due to a conflict).
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- warnings ( warnings ): Present in case of one or more warnings. In case one warning occurs the object contains a JSONObject with error data. If more warnings occur, the object contains a JSONArray that holds JSONObjects with error data.
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
InfoItemListElement
{- id ( string , required ): The object ID of the infoitem (e.g. "31841/36639").
- folder ( string , required ): The object ID of the related folder (e.g. "31841").
-
-
Creates a new infoitem. This request cannot add a file to the infoitem. Therefor it is necessary to use the
POST
method.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be updated.
query string timestamp (empty) Timestamp of the last update of the infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.
query long pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON object containing a field `file` with the modified fields of the infoitem's data. It is possible to let added object permission entities be notified about newly shared files. In that case add a "notification" object.
Content-type: application/json-
InfoItemBody
{- file ( InfoItemData , required ): No description available
- notification ( InfoItemBodyNotification ): Responsible for sending out notifications for changed object permissions of an infoitem.
-
InfoItemData
{- object_permissions ( array[InfoItemPermission] ): An array of object permissions.
- shareable ( boolean , read only ): (read-only) Indicates if the item can be shared.
- title ( string ): The title.
- url ( string ): Link/URL to item.
- filename ( string ): Displayed filename of the document.
- file_mimetype ( string ): MIME type of the document. The client converts known types to more readable names before displaying them.
- file_size ( integer ): The size of the document in bytes.
- version ( string ): Version of the document. NULL can be used to denote the most recent version and will be set in responses if versions are not supported by the underlying storage.
- description ( string ): A description if the item.
- locked_until ( integer , read only ): The time until which this item will presumably be locked. Only set if the docment is currently locked, `0` otherwise.
- file_md5sum ( string ): MD5Sum of the document.
- version_comment ( string ): A version comment is used to file a changelog for the file.
- current_version ( boolean , read only ): `true` if this version is the current version, `false` otherwise. Note: This is not writeable.
- number_of_versions ( integer , read only ): The number of all versions of the item. Note: This is not writeable.
- sequence_number ( integer ): Sequence number of the infoitem.
- capture_date ( integer , read only ): Date and time when media file was captured/recorded
- geolocation ( string , read only ): The geo location associated with the media resource as latitude and longitude pair; e.g. "(45 23)"
- width ( integer , read only ): The width of the media resource
- height ( integer , read only ): The height of the media resource
- camera_iso_speed ( integer , read only ): The ISO speed value of a camera or input device associated with the media resource
- camera_aperture ( string , read only ): The aperture used to create the photo (f-number)
- camera_exposure_time ( string , read only ): The length of the exposure, in seconds
- camera_focal_length ( string , read only ): The focal length used to create the photo, in millimeters
- camera_model ( string , read only ): The name of the camera model associated with the media resource
- media_meta ( media_meta , read only ): Contains metadata extracted from the media resource
- media_status ( string , read only ): Represents the status for the process of extracting metadata from a media resource
- media_date ( integer , read only ): A special field, which prefers the capture date and falls-back to last-modified date if absent
- com.openexchange.share.extendedObjectPermissions ( array[InfoItemExtendedPermission] ): An array of extended object permissions (read-only).
- com.openexchange.realtime.resourceID ( string , read only ): The resource identifier for the infoitem for usage within the realtime component.
- com.openexchange.file.storage.mail.mailMetadata ( com.openexchange.file.storage.mail.mailMetadata , read only ): Contains additional metadata for items in the "maildrive" file storage.
- unique_id ( string , read only ): Lifetime unique identifier of the file that does not change e.g. after move or rename operations.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string , required ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
InfoItemPermission
{-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies.
- group ( boolean ): Is `true` if entity refers to a group, `false` if it refers to a user.
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
-
bits
(
integer
, possibleValues:
-
InfoItemExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - type ( string ): "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( ContactData ): No description available
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
-
InfoItemBodyNotification - Responsible for sending out notifications for changed object permissions of an infoitem.
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
A JSON object with the object ID of the newly created infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemUpdateResponse
{- data ( string ): The object ID of the updated infoitem.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Creates a new infoitem with a file. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the infoitem's data while the file must be placed in a file field namedfile
(see also File uploads).Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type try_add_version (empty) Add new file version if file name exists
query boolean pushToken (empty) The push token of the drive client
query string Body:
Description:No description available
Content-type: multipart/form-data-
createInfoItemAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the infoitem's data (See InfoItemBody model of the newInfoItem request).
- file ( string , required ): The metadata as per ``.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the infoitem or errors if some occurred.
Content-type: text/html-
Unknown
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the infoitems.
query string columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string left_hand_limit (empty) A positive integer number to specify the "left-hand" limit of the range to return.
query integer right_hand_limit (empty) A positive integer number to specify the "right-hand" limit of the range to return.
query integer limit (empty) A positive integer number to specify how many items shall be returned according to given sorting; overrides left_hand_limit/right_hand_limit parameters and is equal to left_hand_limit=0 and right_hand_limit=
. query integer pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Responses:
200:
A JSON object containing an array with data for all infoitems. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type name (empty) The file name to check.
query string Responses:
200:
An empty JSON object when file name is valid. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string folder (empty) Object ID of the folder who contains the infoitems.
query string id (empty) Object ID of the requested infoitem.
query string redirect (empty) "true" if the redirect link should be returned in the Location header of a HTTP 302 Moved Temporarily response, "false" (default) to return the link in a plain API response.
query boolean Responses:
302:
The backward link will be put into the Location header of the response. Used if "redirect" URL parameter was true.
200:
An JSON object holding the backward link in its "link" field if the call was successful. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
BackwardLinkResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- link ( string ): The generated backward link
-
-
Note
When the current version of a document is deleted the new current version will be the latest version.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the base object.
query string folder (empty) The folder ID of the base object.
query string timestamp (empty) Timestamp of the last update of the infoitem.
query long pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON array of version numbers to detach.
Content-type: application/json
Responses:
200:
A JSON object with an empty array of version numbers that were not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemDetachResponse
{- data ( array[integer] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Body:
Description:A JSON array of JSON objects with the id of the infoitems.
Content-type: application/json-
InfoItemListElement
{- id ( string , required ): The object ID of the infoitem (e.g. "31841/36639").
- folder ( string , required ): The object ID of the related folder (e.g. "31841").
Responses:
200:
A JSON object containing an array with data for the requested infoitems. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string folder (empty) The folder ID to restrict the search to. If not specified, all folders are searched.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string start (empty) The start index (inclusive, zero-based) in the ordered search, that is requested.
query integer end (empty) The last index (inclusive) from the ordered search, that is requested.
query integer includeSubfolders (empty) If set to `true` and a `folder` is specified, this folder and all of its subfolders are considered by the search.
query boolean pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Body:
Description:A JSON object containing search parameters.
Content-type: application/json-
InfoItemSearchBody
{- pattern ( string ): The search pattern, where "*" matches any sequence of characters.
Responses:
200:
A JSON object containing an array with matching infoitems. Infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem whose versions are requested.
query string columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Responses:
200:
A JSON object containing an array with data for the infoitem. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. The timestamp is the timestamp relating to the requested infostore item. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Creates or updates an infoitem with a file.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder_id (empty) The folder id.
query string timestamp (empty) Timestamp of the last update of the infoitem. If the infoitem was modified after the specified timestamp, then the update must fail. Note: This must only be set for updates of existing infoitems.
query long id (empty) The id of the file in case of an update.
query string title (empty) The title of the file.
query string filename (empty) The name of the file.
query string file_mimetype (empty) The mimetype of the file.
query string file_md5sum (empty) The md5sum of the file.
query string description (empty) The description of the file.
query string url (empty) The url of the file.
query string version (empty) The version of the file.
query string version_comment (empty) The comment of the version.
query string categories (empty) The a list of categories.
query string color_label (empty) The color label identifier.
query integer file_size (empty) The complete final size of the document in bytes, even if data is appended.
query long try_add_version (empty) Add new file version if file name exists
query boolean ignoreWarnings (empty) In case of an update indicates whether warnings should be ignored or not
query boolean offset (empty) Optionally sets the start offset in bytes where to append the data to the document, must be equal to the actual document's length. Only available if the underlying File storage account supports the "RANDOM_FILE_ACCESS" capability. If set the id parameter must also be set to the id previously recieved from the first/starting request.
query long pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:The binary file
Content-type: application/octet-stream-
Unknown
Responses:
200:
A JSON object with the object ID of the newly created infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: text/html-
InfoItemUpdateResponse
{- data ( string ): The object ID of the updated infoitem.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be locked.
query string diff (empty) If present the value is added to the current time on the server (both in ms). The document will be locked until that time. If this parameter is not present, the document will be locked for a duration as configured on the server.
query long Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the infoitems.
query string columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string timestamp (empty) Timestamp of the last update of the requested infoitems.
query long ignore Which kinds of updates should be ignored. Currently, the only valid value – "deleted" – causes deleted object IDs not to be returned.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Responses:
200:
An array with new, modified and deleted infoitems. New and modified infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted infoitems would be identified by their object IDs as string, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemUpdatesResponse
{- data ( array[object] ): Array of infoitems.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type scan (empty) Flag to request an Anti-Virus scan for the specified documents before downloading them.
query boolean Body:
Description:A JSON array of JSON objects with the id, folder and optionally the documents' versions to include in the requested ZIP archive (if missing, it refers to the latest/current version).
Content-type: application/json-
InfoItemZipElement
{- id ( string , required ): The object ID of the infoitem (e.g. "31841/36639").
- folder ( string , required ): The object ID of the related folder (e.g. "31841").
- version ( string ): The version of the infoitem.
Responses:
200:
The raw byte data of the ZIP archive. The response type for the HTTP request is set to `application/zip`.
Content-type: application/zip-
Unknown
-
-
Updates an infoitem's data. This request cannot change or add files. Therefore it is necessary to use the
POST
method.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be updated.
query string timestamp (empty) Timestamp of the last update of the infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.
query long pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON object containing a field `file` with the modified fields of the infoitem's data. It is possible to let added object permission entities be notified about newly shared files. In that case add a "notification" object.
Content-type: application/json-
InfoItemBody
{- file ( InfoItemData , required ): No description available
- notification ( InfoItemBodyNotification ): Responsible for sending out notifications for changed object permissions of an infoitem.
-
InfoItemData
{- object_permissions ( array[InfoItemPermission] ): An array of object permissions.
- shareable ( boolean , read only ): (read-only) Indicates if the item can be shared.
- title ( string ): The title.
- url ( string ): Link/URL to item.
- filename ( string ): Displayed filename of the document.
- file_mimetype ( string ): MIME type of the document. The client converts known types to more readable names before displaying them.
- file_size ( integer ): The size of the document in bytes.
- version ( string ): Version of the document. NULL can be used to denote the most recent version and will be set in responses if versions are not supported by the underlying storage.
- description ( string ): A description if the item.
- locked_until ( integer , read only ): The time until which this item will presumably be locked. Only set if the docment is currently locked, `0` otherwise.
- file_md5sum ( string ): MD5Sum of the document.
- version_comment ( string ): A version comment is used to file a changelog for the file.
- current_version ( boolean , read only ): `true` if this version is the current version, `false` otherwise. Note: This is not writeable.
- number_of_versions ( integer , read only ): The number of all versions of the item. Note: This is not writeable.
- sequence_number ( integer ): Sequence number of the infoitem.
- capture_date ( integer , read only ): Date and time when media file was captured/recorded
- geolocation ( string , read only ): The geo location associated with the media resource as latitude and longitude pair; e.g. "(45 23)"
- width ( integer , read only ): The width of the media resource
- height ( integer , read only ): The height of the media resource
- camera_iso_speed ( integer , read only ): The ISO speed value of a camera or input device associated with the media resource
- camera_aperture ( string , read only ): The aperture used to create the photo (f-number)
- camera_exposure_time ( string , read only ): The length of the exposure, in seconds
- camera_focal_length ( string , read only ): The focal length used to create the photo, in millimeters
- camera_model ( string , read only ): The name of the camera model associated with the media resource
- media_meta ( media_meta , read only ): Contains metadata extracted from the media resource
- media_status ( string , read only ): Represents the status for the process of extracting metadata from a media resource
- media_date ( integer , read only ): A special field, which prefers the capture date and falls-back to last-modified date if absent
- com.openexchange.share.extendedObjectPermissions ( array[InfoItemExtendedPermission] ): An array of extended object permissions (read-only).
- com.openexchange.realtime.resourceID ( string , read only ): The resource identifier for the infoitem for usage within the realtime component.
- com.openexchange.file.storage.mail.mailMetadata ( com.openexchange.file.storage.mail.mailMetadata , read only ): Contains additional metadata for items in the "maildrive" file storage.
- unique_id ( string , read only ): Lifetime unique identifier of the file that does not change e.g. after move or rename operations.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string , required ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
InfoItemPermission
{-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies.
- group ( boolean ): Is `true` if entity refers to a group, `false` if it refers to a user.
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
-
bits
(
integer
, possibleValues:
-
InfoItemExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - type ( string ): "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( ContactData ): No description available
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
-
InfoItemBodyNotification - Responsible for sending out notifications for changed object permissions of an infoitem.
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
A JSON object with the object ID of the updated infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemUpdateResponse
{- data ( string ): The object ID of the updated infoitem.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Updates an infoitem's data and file. The normal request body must be placed as form-data using the content-type
multipart/form-data
. The form fieldjson
contains the infoitem's data while the file must be placed in a file field namedfile
(see also File uploads).Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the infoitem that shall be updated.
query string timestamp (empty) Timestamp of the updated infoitem. If the infoitem was modified after the specified timestamp, then the update must fail.
query long offset (empty) Optionally sets the start offset in bytes where to append the data to the document, must be equal to the actual document's length. Only available if the underlying File storage account supports the "RANDOM_FILE_ACCESS" capability.
query integer pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:No description available
Content-type: multipart/form-data-
updateInfoItemAdvancedBody
{- json ( string , required ): Represents the normal request body as JSON string containing the infoitem's data (See InfoItemBody model of the newInfoItem request). Only modified fields must be specified but at least "{}".
- file ( string , required ): The metadata as per ``.
Responses:
200:
A HTML page as described in File uploads containing the object ID of the infoitem or errors if some occurred.
Content-type: text/html-
Unknown
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested infoitem.
query string folder (empty) Object ID of the folder who contains the infoitems.
query string Responses:
200:
A JSON object containing all data of the requested infoitem. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemResponse
{- data ( InfoItemData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
InfoItemData
{- object_permissions ( array[InfoItemPermission] ): An array of object permissions.
- shareable ( boolean , read only ): (read-only) Indicates if the item can be shared.
- title ( string ): The title.
- url ( string ): Link/URL to item.
- filename ( string ): Displayed filename of the document.
- file_mimetype ( string ): MIME type of the document. The client converts known types to more readable names before displaying them.
- file_size ( integer ): The size of the document in bytes.
- version ( string ): Version of the document. NULL can be used to denote the most recent version and will be set in responses if versions are not supported by the underlying storage.
- description ( string ): A description if the item.
- locked_until ( integer , read only ): The time until which this item will presumably be locked. Only set if the docment is currently locked, `0` otherwise.
- file_md5sum ( string ): MD5Sum of the document.
- version_comment ( string ): A version comment is used to file a changelog for the file.
- current_version ( boolean , read only ): `true` if this version is the current version, `false` otherwise. Note: This is not writeable.
- number_of_versions ( integer , read only ): The number of all versions of the item. Note: This is not writeable.
- sequence_number ( integer ): Sequence number of the infoitem.
- capture_date ( integer , read only ): Date and time when media file was captured/recorded
- geolocation ( string , read only ): The geo location associated with the media resource as latitude and longitude pair; e.g. "(45 23)"
- width ( integer , read only ): The width of the media resource
- height ( integer , read only ): The height of the media resource
- camera_iso_speed ( integer , read only ): The ISO speed value of a camera or input device associated with the media resource
- camera_aperture ( string , read only ): The aperture used to create the photo (f-number)
- camera_exposure_time ( string , read only ): The length of the exposure, in seconds
- camera_focal_length ( string , read only ): The focal length used to create the photo, in millimeters
- camera_model ( string , read only ): The name of the camera model associated with the media resource
- media_meta ( media_meta , read only ): Contains metadata extracted from the media resource
- media_status ( string , read only ): Represents the status for the process of extracting metadata from a media resource
- media_date ( integer , read only ): A special field, which prefers the capture date and falls-back to last-modified date if absent
- com.openexchange.share.extendedObjectPermissions ( array[InfoItemExtendedPermission] ): An array of extended object permissions (read-only).
- com.openexchange.realtime.resourceID ( string , read only ): The resource identifier for the infoitem for usage within the realtime component.
- com.openexchange.file.storage.mail.mailMetadata ( com.openexchange.file.storage.mail.mailMetadata , read only ): Contains additional metadata for items in the "maildrive" file storage.
- unique_id ( string , read only ): Lifetime unique identifier of the file that does not change e.g. after move or rename operations.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string , required ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
InfoItemPermission
{-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - identifier ( string ): The qualified identifier of the entity associated with this permission.
- entity ( integer ): Internal identifier of the user or group to which this permission applies.
- group ( boolean ): Is `true` if entity refers to a group, `false` if it refers to a user.
- type ( string ): The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined).
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional).
- email_address ( string ): The e-mail address of the recipient (for type "guest").
- display_name ( string ): The display name of the recipient (for type "guest", optional).
- contact_id ( string ): The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional).
- contact_folder ( string ): The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional).
-
bits
(
integer
, possibleValues:
-
InfoItemExtendedPermission
{- identifier ( string ): The qualified identifier of the entity associated with this permission. Should be used to associate the entry with its 'extended' permission version equivalent.
- entity ( integer ): Internal identifier of the permission entity (i.e. user-, group- or guest-ID).
-
bits
(
integer
, possibleValues:
0
1
2
* 0 (the numerical value indicating no object permissions),
* 1 (the numerical value indicating read object permissions),
* 2 (the numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask)) - type ( string ): "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity.
- display_name ( string ): A display name for the permission entity.
- contact ( ContactData ): No description available
- share_url ( string ): The share link for "anonymous" entities.
- password ( string ): The optionally set password for "anonymous" entities.
- expiry_date ( integer ): The optionally set expiry date for "anonymous" entities.
-
ContactData Composed Schema
ALLOF: CommonObjectData RawContactData -
CommonObjectData
{- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
RawContactData
{- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the shared infoitem to notify about.
query string Body:
Description:JSON object providing the JSON array `entities`, which holds the entity ID(s) of the users or groups that should be notified. To send a custom message to the recipients, an additional JSON object `notification` may be included, inside of which an optional message can be passed (otherwise, some default message is used). (Example: {"entities":["2332"]} or {"entities":["2332"],"notification":{"transport":"mail","message":"The message"}})
Content-type: application/json-
InfoItemSharingNotificationBody
{- entities ( array[string] , required ): Array containing the entity ID(s) of the users or groups that shall be notified.
- notification ( InfoItemBodyNotification ): Responsible for sending out notifications for changed object permissions of an infoitem.
-
InfoItemBodyNotification - Responsible for sending out notifications for changed object permissions of an infoitem.
{- transport ( string ): E.g. "mail".
- message ( string ): No description available
Responses:
200:
An empty JSON object. Any transport warnings that occurred during sending the notifications are available in the warnings array of the response. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemSharingNotificationResponse
{- data ( InfoItemSharingNotificationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
InfoItemSharingNotificationData
{- warnings ( array[object] ): Can contain transport warnings that occured during sending the notifications.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the infoitems to delete.
query long hardDelete (empty) Defaults to `false`. If set to `true`, the file is deleted permanently. Otherwise, and if the underlying storage supports a trash folder and the file is not yet located below the trash folder, it is moved to the trash folder.
query boolean pushToken (empty) The client's push token to restrict the generated drive event
query string Body:
Description:A JSON array of objects with the fields `id` and `folder` representing infoitems that shall be deleted.
Content-type: application/json-
InfoItemListElement
{- id ( string , required ): The object ID of the infoitem (e.g. "31841/36639").
- folder ( string , required ): The object ID of the related folder (e.g. "31841").
Responses:
200:
A JSON object with an empty array if the infoitems were deleted successfully. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string columns (empty) A comma-separated list of columns to return, like "1,700". Each column is specified by a numeric column identifier, see Common object data and Detailed infoitem data.
query string folder (empty) The folder ID to restrict the search to. If not specified, all folders are searched.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string start (empty) The start index (inclusive, zero-based) in the ordered search, that is requested.
query integer end (empty) The last index (inclusive) from the ordered search, that is requested.
query integer includeSubfolders (empty) If set to `true` and a `folder` is specified, this folder and all of its subfolders are considered by the search.
query boolean pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all files in request result
query boolean Body:
Description:A JSON object containing search parameters.(see Advanced Search).
Content-type: application/json-
Unknown
Responses:
200:
A JSON object containing an array with matching infoitems. Infoitems are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoItemsResponse
{- data ( data ): Array of infoitems. Each infoitem is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Jobqueue
The job queue module-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier for the job
query string Responses:
200:
An array of JSON objects each describing a job currently held in job queue. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
InfoJobResponse
{- data ( InfoJobData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
InfoJobData
{- id ( string ): The job identifier
- action ( string ): The action identifier
- module ( string ): The module identifier
- done ( boolean ): Signals whether job is already done or still in progress
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
An array of JSON objects each describing a job currently held in job queue. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AllJobsResponse
{- data ( array[InfoJobData] ): Contains the JSON representations for jobs currently held in job queue for a user
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
InfoJobData
{- id ( string ): The job identifier
- action ( string ): The action identifier
- module ( string ): The module identifier
- done ( boolean ): Signals whether job is already done or still in progress
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier for the job
query string Responses:
200:
A JSON object providing success information. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CancelJobResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- success ( boolean ): The flag signaling whether job has been successfully canceled
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier for the job
query string Responses:
200:
The regular response appropriate for submitted job. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
Unknown - The response of the originating request that was submitted as a job
202:
The operation did not complete in time and was added to job queue providing the job identifier. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
GetJobResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- job ( string ): The job identifier
-
-
-
JSlob
The JSlob module is used to store and retrieve arbitrary JSON-structured configuration for a single user.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type serviceId (empty) The identifier for the JSlob service, default is "com.openexchange.jslob.config".
query string id (empty) The JSlob identifier.
query string jslobPath (empty) The path to the jslob entry
path string Responses:
200:
A jsob object containing either the complete jslob or the specific jslob segment if it exists. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
Unknown
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type serviceId (empty) The identifier for the JSlob service, default is "com.openexchange.jslob.config".
query string Responses:
200:
A JSON object containing an array of JSON objects each representing a certain JSON configuration. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
JSlobsResponse
{- data ( array[JSlobData] ): An array containing JSON configurations.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
JSlobData
{- id ( string ): The identifier of the JSlob.
- tree ( tree ): The JSON object that is stored in the JSlob.
- meta ( meta ): A JSON object containing meta data.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type serviceId (empty) The identifier for the JSlob service, default is "com.openexchange.jslob.config".
query string Body:
Description:A JSON array with the identifiers of the requested JSlobs.
Content-type: application/json
Responses:
200:
A JSON object containing an array of JSON objects each representing a certain JSON configuration. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
JSlobsResponse
{- data ( array[JSlobData] ): An array containing JSON configurations.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
JSlobData
{- id ( string ): The identifier of the JSlob.
- tree ( tree ): The JSON object that is stored in the JSlob.
- meta ( meta ): A JSON object containing meta data.
-
-
When updating a JSlob entry there are two different ways to do so:
- Using a path and value field in the request body The same as in 1. but the path is provided in the request body as 'path' and the value is provided as 'value'. For example:
{ "path":"path/to/the/sub/tree" "value": {...} }
2. Performing a merge In case no path is given the provided value is merged with the existing jslob entry and only provided fields are updated.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The JSlob indentifier.
query string serviceId (empty) The identifier for the JSlob service, default is "com.openexchange.jslob.config".
query string Body:
Description:Either a JSON object which contains the new JSON configuration or a json object which contains a path and value field which provides the JSlob sub path and its value respectively. In case the configuration is provided directly it is either merged in case no path is given or it is used to update the subpath. Use `/jslob?action=set` to delete fields or entire JSlob.
Content-type: application/json-
Unknown
{
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
- Using a path and value field in the request body The same as in 1. but the path is provided in the request body as 'path' and the value is provided as 'value'. For example:
-
When a valid jslobPath is provided the JSlob sub path is replaced by the given request data.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The JSlob indentifier.
query string serviceId (empty) The identifier for the JSlob service, default is "com.openexchange.jslob.config".
query string jslobPath (empty) The path to the jslob entry
path string Body:
Description:A JSON object which contains the new JSON configuration. Use `/jslob?action=set` to delete fields or entire JSlob.
Content-type: application/json-
Unknown
{
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
To delete a JSON configuration just send an empty request body for the specified
id
.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The JSlob indentifier.
query string serviceId (empty) The identifier for the JSlob service, default is "com.openexchange.jslob.config".
query string Body:
Description:A JSON object containing the JSON configuration to store. To delete the JSlob just send an empty body.
Content-type: application/json-
Unknown
{
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Jump
The jump module is used to pass an acquired identity token for an authenticated user from one system to another for a single sign-on.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type system (empty) The identifier for the external service/system, like "com.openexchange.jump.endpoint.mysystem".
query string Responses:
200:
A JSON object containing the identity token. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
JumpResponse
{- data ( JumpTokenData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
JumpTokenData
{- token ( string ): The identifier of the token.
-
-
-
Login
The login module is used to obtain a session from the user's login credentials. To understand the details of the different login methods, see the article titled Login variations. Because of security reasons each login variation will reject requests containing the parameter "password" within the URL query.-
This API call is typically the result of a redirect created by the server. It does not need to be explicitly implemented by clients!
After a successful SAML logout flow, the client (web browser) is redirected to this endpoint, where the actual App Suite session gets terminated. As a result, the user gets usually redirected to an environment-specific location, for example a portal page. The redirect response removes all App Suite session cookies.
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) App Suite session ID
query string Responses:
200:
A html result page
302:
A redirect to an exit page
-
The login module is used to obtain a session from the user's login credentials. Parameters are normally expected in the POST request body.
Parameters:
Parameter Value Description Parameter Type Data Type share (empty) The token of the share to access
query string target (empty) The path to a specific share target.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
doLoginBody
{- rampup ( string ): Determines whether client specific rampup data should be returned with a successfull login request or not.
- rampupFor ( string ): Optional client identifier which is used to retrieve the rampup data.
- name ( string , required ): The login name.
- password ( string , required ): The password (MUST be placed in the request body, otherwise the login request will be denied).
- client ( string ): Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange.
- version ( string ): Used version of the HTTP/JSON interface client.
- clientIP ( string ): IP address of the client host for that the session is created. If this parameter is not specified the IP address of the HTTP client doing this request is used.
- clientUserAgent ( string ): Value of the User-Agent header of the client host for that the session is created. If this parameter is not specified the User-Agent of the current HTTP client doing this request is used.
- staySignedIn ( boolean ): Cookies will be persisted if user choses to stay signed in
Responses:
200:
A JSON object containing the session ID used for all subsequent requests. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
LoginResponse
{- session ( string ): The session ID.
- user ( string ): The username.
- user_id ( integer ): The user ID.
- context_id ( integer ): The context ID.
- locale ( string ): The users locale (e.g. "en_US").
- requires_multifactor ( boolean ): True if multifactor login required
- rampup ( rampup ): Contains various client specific rampup data. Only set if the rampup parameter is set to 'true'.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
This API call is typically the result of a redirect created by the server. It does not need to be explicitly implemented by clients!
After a successful SAML login flow, the client (web browser) is redirected to this endpoint, where the actual App Suite session gets created. As a result, the user gets redirected to
https://<webmail-domain>/<login-path>#session=<session-id>
. The redirect response has App Suite session cookies set.Parameters:
Parameter Value Description Parameter Type Data Type token (empty) A valid session reservation token
query string client (empty) Identifier of the client using the HTTP/JSON interface. Default: Value of configuration property `com.openexchange.ajax.login.http-auth.client`
query string clientUserAgent (empty) Parameter to override the user agent used for session creation. By default the `User-Agent` request header is evaluated.
query string loginPath (empty) The login path to be set on the resulting `Location` response header as part of the redirect response. Default: Value of configuration property `com.openexchange.UIWebPath`.
query string shard (empty) Shard identifier to route the requiest accordingly
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string Responses:
200:
A html error page
302:
In case of a succes the middleware answers with a redirect to for bootstrapping the client session
400:
In case the token is missing
403:
In case the login is not allowed
-
This request allows clients to access a session created with the
/login?action=tokenLogin
request. When accessing the session its life time is extended equally to every other session.Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
accessSessionBody
{- serverToken ( string , required ): The login name.
- clientToken ( string , required ): The password (MUST be placed in the request body, otherwise the login request will be denied).
- client ( string , required ): Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange.
Responses:
200:
A JSON object conform to the normal response body containing the session identifier, the login, the identifier and the locale of the user. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TokensResponse
{- data ( TokensData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
TokensData
{- session ( string ): The session ID.
- user ( string ): The username.
- user_id ( integer ): The user ID.
- context_id ( integer ): The context ID.
- locale ( string ): The users locale (e.g. "en_US").
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
If the session ID was stored in a cookie before by choosing to 'stay signed in' when logging in, the user can reuse his old session by using the autologin request.
Parameters:
Parameter Value Description Parameter Type Data Type authId (empty) Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request. (IS OPTIONAL, meaning can be empty)
query string client (empty) Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
autologinBody
{- rampup ( string ): Determines whether client specific rampup data should be returned with a successfull login request or not.
- rampupFor ( string ): Optional client identifier which is used to retrieve the rampup data.
Responses:
200:
A JSON object containing the session ID used for all subsequent requests. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
LoginResponse
{- session ( string ): The session ID.
- user ( string ): The username.
- user_id ( integer ): The user ID.
- context_id ( integer ): The context ID.
- locale ( string ): The users locale (e.g. "en_US").
- requires_multifactor ( boolean ): True if multifactor login required
- rampup ( rampup ): Contains various client specific rampup data. Only set if the rampup parameter is set to 'true'.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
The following request is especially for integration with systems located in the providers infrastructure. If those systems create a session with the following request the client host IP address in the session can be changed. The IP check for following requests will be done using this newly set client host IP address.
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string clientIP (empty) New IP address of the client host for the current session.
query string Responses:
200:
A JSON object containing the string "1" as data attribute. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ChangeIPResponse
{- data ( string ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
SECURITY WARNING! Utilizing this request is INSECURE! This request allows to access a session with a single one time token. This one time token may be delivered to the wrong client if the protocol has an error or Apache or the load balancer make a mistake. This will cause a wrong user to be in a wrong session. IMMEDIATELY consider not to use this request anymore. You have been warned. Use instead the FormLogin that does not need to use the redirect request.
Parameters:
Parameter Value Description Parameter Type Data Type random (empty) A session random token to jump into the session. This random token is part of the login response. Only a very short configurable time after the login it is allowed to jump into the session with the random token.
query string client (empty) The client can be defined here newly if it is not correct on the login request itself.
query string store (empty) Tells the UI to do a store request after login to be able to use autologin request.
query boolean uiWebPath (empty) The optional path on the webserver to the UI. If this parameter is not given the configured uiWebPath is used.
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
This request implements a possible login to the web frontend by only using a simple HTML form. The response contains a redirect link to the Web-UI. See OXSessionFormLogin for details. An example for such a form can be found in the backend's documentation folder (/usr/share/doc/open-xchange-core) under examples/login.html.
Parameters:
Parameter Value Description Parameter Type Data Type authId (empty) Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
doFormLoginBody
{- rampup ( string ): Determines whether client specific rampup data should be returned with a successfull login request or not.
- rampupFor ( string ): Optional client identifier which is used to retrieve the rampup data.
- login ( string , required ): The login name.
- password ( string , required ): The password.
- client ( string , required ): Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange. If the autologin request should work the client must be the same as the client sent by the UI in the normal login request.
- version ( string , required ): Used version of the HTTP/JSON interface client.
- autologin ( boolean , required ): True or false. True tells the UI to issue a store request for the session cookie. This store request is necessary if you want the autologin request not to fail.
- uiWebPath ( string ): Defines another path on the web server where the UI is located. If this parameter is not defined the configured default of the backend is used.
- clientIP ( string ): IP address of the client host for that the session is created. If this parameter is not specified the IP address of the HTTP client doing this request is used.
- clientUserAgent ( string ): Value of the User-Agent header of the client host for that the session is created. If this parameter is not specified the User-Agent of the current HTTP client doing this request is used.
Responses:
200:
A redirect to the web UI. The URL of the web UI is either taken from the given parameter or from the configured default of the backend.
Content-type: text/html-
Unknown
-
-
Does the logout which invalidates the session.
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string Responses:
200:
A successfull logout
403:
FORBIDDEN. The server refuses to respond to the request.
-
This request allows every possible client to create a very short living session. This session can then be transferred to any other client preferably a browser entering then the normal web interface. Then the sessions life time will be extended equally to every other session.
Compared to the login mechanism using the random token, this request is more secure because two tokens are used. One of these tokens is only known to the client and one is generated by the server. Only the combination of both tokens allows to use the session. The combination of both tokens must be done by the client creating the session.
DISCLAIMER: This request MUST NOT be used by some server side instance. If some server side instance uses this request to create a session for a browser on some client machine, then you have to transfer the full URL with server and client token over some connection to the client. This creates a VULNERABILITY if this is done. The token login method is only secure if this request is already sent from the same machine that later runs the browser using the created session.
Parameters:
Parameter Value Description Parameter Type Data Type authId (empty) Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
doTokenLoginBody
{- login ( string , required ): The login information.
- password ( string , required ): The password (MUST be placed in the request body, otherwise the login request will be denied).
- clientToken ( string , required ): Client side identifier for accessing the session later. The value should be some token that is unique for every login request.
- client ( string , required ): Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange.
- version ( string , required ): Version of the HTTP/JSON interface client. Only for statistic evaluations.
- staySignedIn ( boolean ): Cookies will be persisted if user choses to stay signed in.
- uiWebPath ( string ): Defines another path on the web server where the UI is located. If this parameter is not defined the configured default of the backend is used.
- clientIP ( string ): IP address of the client host for that the session is created. If this parameter is not specified the IP address of the HTTP client doing this request is used.
- clientUserAgent ( string ): Value of the User-Agent header of the client host for that the session is created. If this parameter is not specified the User-Agent of the current HTTP client doing this request is used.
- jsonResponse ( boolean ): ’True’ or ’false’ (default). Defines the returned data type as JSON. Default `false` will return a redirect.
Responses:
200:
In case `jsonResponse=true`, it is returned a JSON object. Otherwise a redirect to the web UI. The URL of the web UI is either taken from the given parameter or from the configured default of the backend. This redirect will only contain the server side token. The client side token sent in the request must be appended by the client creating the session. The final URL must have the form redirect_URL&clientToken=token. Both tokens are necessary to use the session and both tokens must match. Otherwise the session is terminated. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TokenLoginResponse
{- serverToken ( string ): The token generated by the server.
- jsessionid ( string ): No description available
- user ( string ): The username.
- user_id ( integer ): The user ID.
- url ( string ): The URL of the redirect to the web UI.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
Content-type: text/html-
TokenLoginResponse
{- serverToken ( string ): The token generated by the server.
- jsessionid ( string ): No description available
- user ( string ): The username.
- user_id ( integer ): The user ID.
- url ( string ): The URL of the redirect to the web UI.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
With a valid session it is possible to acquire a secret (see
token?action=acquireToken
). Using this secret another system is able to generate a valid session. This session may also contain the users password (configurable). The system in question needs to be registered at the server and has to identify itself with a key configured at the open-xchange server. This is only for internal communication and by default no keys are available.Parameters:
Parameter Value Description Parameter Type Data Type authId (empty) Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
redeemTokenBody
{- token ( string , required ): The token created with `token?action=acquireToken`.
- client ( string , required ): Identifier of the client using the HTTP/JSON interface. The client must identifier must be the same for each request after creating the login session.
- secret ( string , required ): The value of the secret string for token logins. This is configured through the tokenlogin-secrets configuration file.
Responses:
200:
A JSON object containing the session ID used for all subsequent requests. Additionally a random token is contained to be used for the Easy Login method. If configured within tokenlogin-secrets configuration file even the user password will be returned. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
LoginResponse
{- session ( string ): The session ID.
- user ( string ): The username.
- user_id ( integer ): The user ID.
- context_id ( integer ): The context ID.
- locale ( string ): The users locale (e.g. "en_US").
- requires_multifactor ( boolean ): True if multifactor login required
- rampup ( rampup ): Contains various client specific rampup data. Only set if the rampup parameter is set to 'true'.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
The login module is used to obtain a session from the user's login credentials. Parameters are normally expected in the POST request body.
Parameters:
Parameter Value Description Parameter Type Data Type authId (empty) Identifier for tracing every single login request passed between different systems in a cluster. The value should be some token that is unique for every login request. This parameter must be given as URL parameter and not inside the body of the POST request. (IS OPTIONAL, meaning can be empty)
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
doLoginBody
{- rampup ( string ): Determines whether client specific rampup data should be returned with a successfull login request or not.
- rampupFor ( string ): Optional client identifier which is used to retrieve the rampup data.
- name ( string , required ): The login name.
- password ( string , required ): The password (MUST be placed in the request body, otherwise the login request will be denied).
- client ( string ): Identifier of the client using the HTTP/JSON interface. This is for statistic evaluations what clients are used with Open-Xchange.
- version ( string ): Used version of the HTTP/JSON interface client.
- clientIP ( string ): IP address of the client host for that the session is created. If this parameter is not specified the IP address of the HTTP client doing this request is used.
- clientUserAgent ( string ): Value of the User-Agent header of the client host for that the session is created. If this parameter is not specified the User-Agent of the current HTTP client doing this request is used.
- staySignedIn ( boolean ): Cookies will be persisted if user choses to stay signed in
Responses:
200:
A JSON object containing the session ID used for all subsequent requests. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
LoginResponse
{- session ( string ): The session ID.
- user ( string ): The username.
- user_id ( integer ): The user ID.
- context_id ( integer ): The context ID.
- locale ( string ): The users locale (e.g. "en_US").
- requires_multifactor ( boolean ): True if multifactor login required
- rampup ( rampup ): Contains various client specific rampup data. Only set if the rampup parameter is set to 'true'.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Mail
The mail module is used to access mail data. When mails are stored on an IMAP server, some functionality is not available due to restrictions of the IMAP protocol. Such functionality is marked with "not IMAP".-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string Responses:
200:
'A JSON object containing an integer value representing the folder's mail count. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
MailCountResponse
{- data ( integer ): The folder's mail count.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string columns (empty) A comma-separated list of either columns or header names to return, like "600,601,X-Custom-Header". Each column is specified by a numeric column identifier, see Detailed mail data.
query string headers (empty) A comma-separated list of header names to return, like "From,X-Custom-Header". This parameter can be used in addition to the columns parameter.
query string unseen (empty) If `true` only mails without the `\Seen` flag are returned.
query boolean deleted (empty) If `false` only mails without the `\Deleted` flag are returned.
query boolean sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string left_hand_limit (empty) A positive integer number to specify the "left-hand" limit of the range to return.
query integer right_hand_limit (empty) A positive integer number to specify the "right-hand" limit of the range to return.
query integer limit (empty) A positive integer number to specify how many items shall be returned according to given sorting; overrides `left_hand_limit`/`right_hand_limit` parameters and is equal to `left_hand_limit=0` and `right_hand_limit=
`. query integer categoryid (empty) The category id to filter for. If set to "general" all mails which does not belong to any other category are retrieved.
query string Responses:
200:
'A JSON object containing an array with mail data. Each array element describes one mail and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
MailsResponse
{- data ( array[array[string]] ): Array of mails. Each mail is described as an array itself.
- cache ( boolean ): If present and set to true, that parameter signals that response has been fetched from cache
- more ( integer ): If present that parameter signals how many items are totally available since client requested a certain chunk from overall result set
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) In case the mail should not be sent out, but saved in a specific folder, the "folder" parameter can be used. If the mail should be sent out to the recipient, the "folder" parameter must not be included and the mail is stored in the folder "Sent Items".
query string flags (empty) In case the mail should be stored with status "read" (e.g. mail has been read already in the client inbox), the parameter "flags" has to be included. If no `folder` parameter is specified, this parameter must not be included. For information about mail flags see Mail data model.
query string Body:
Description:The mail as MIME data block
Content-type: application/octet-stream-
Unknown
Responses:
200:
A JSON object containing the folder ID and the object ID of the mail. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailDestinationResponse
{- data ( MailDestinationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailDestinationData
{- folder_id ( string ): Object ID of the destination folder.
- id ( string ): Object ID of the "new" mail.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
The request accepts file fields in upload form that denote referenced files that are going to be appended as attachments. For "text/plain" mail bodies, the JSON boolean field "raw" may be specified inside the body's JSON representation to signal that the text content shall be kept as-is; meaning to keep all formatting intact.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type lineWrapAfter (empty) An integer value specifying the line-wrap setting (only effective for plain-text content); if absent the setting is taken from user's mail settings.
query integer Body:
Description:No description available
Content-type: multipart/form-data-
sendMailBody
{-
json_0
(
string
,
required
, possibleValues:
0 (new mail)
1 (reply mail)
2 (forward mail)
3 (draft edit)
4 (draft transport)
6 (draft transport and delete)
0 (normal new mail),
1 (a reply mail, field `msgref` must be present),
2 (a forward mail, field `msgref` must be present),
3 (draft edit operation, field `msgref` must be present in order to delete previous draft message since e.g. IMAP does not support changing/replacing a message but requires a delete-and-insert sequence),
4 (transport of a draft mail, field `msgref` must be present),
6 (signals that user intends to send out a saved draft message and expects the draft message (referenced by `msgref` field) being deleted after successful transport).'
-
json_0
(
string
,
required
, possibleValues:
Responses:
200:
A HTML page containing the object ID of the newly created mail or in case of errors an error object (see File uploads as an example).
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) A comma-separated list of Object IDs of the requested mails.
query string Responses:
200:
The raw byte data of the ZIP file.
Content-type: application/zip-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Returns the data for the message that shall be replied.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested message.
query string view Content 'text' forces the server to deliver a text-only version of the requested mail's body, even if content is HTML. 'html' to allow a possible HTML mail body being transferred as it is (but white-list filter applied). NOTE: if set, the corresponding gui config setting will be ignored.
query string setFrom (empty) A flag (`true`/`false`) that signals if "From" header shall be pre-selected according to a suitable recipient address that matches one of user's email address aliases.
query boolean max_size (empty) A positive integer number (greater than 10000) to specify how many characters of the message content will be returned. If the number is smaller than 10000 the value will be ignored and 10000 used.
query integer decrypt (empty) If true, and the object is encrypted, an attempt will be made to decrypt the object. An error will be thrown if needed authentication isn't available. (Guard Required)
query boolean cryptoAuth (empty) Authentication token used for Guard in order to decrypt or sign items. Required if the token is not attached to the session and the decrypt flag was sent.
query string Responses:
200:
A JSON object containing all data of the requested mail. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailReplyResponse
{- data ( MailReplyData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailReplyData
{- msgref ( string ): Indicates the ID of the referenced original mail.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array[MailAttachment] ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
MailAttachment
{- id ( string ): Object ID (unique only inside the same message).
- content_type ( string ): MIME type.
- content ( string ): Content as text. Present only if easily convertible to text.
- filename ( string ): Displayed filename (mutually exclusive with content).
- size ( integer ): Size of the attachment in bytes.
-
disp
(
string
, possibleValues:
null
inline
attachment
alternative
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
This delivery receipt only acknowledges that the message could be receipted on the recipients computer.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Body:
Description:A JSON object containing the information of a mail for which a delivery receipt shall be requested.
Content-type: application/json-
MailAckBody
{- from ( string ): The from email address.
- folder ( string ): The ID of the folder where the mail is placed.
- id ( string ): The ID of the mail.
Responses:
200:
A JSON object with an empty data field if everything went well or a JSON object containing the error information. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAckResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type csid (empty) The "csid" parameter providing the composition space identifier.
query string Body:
Description:'Contains the rudimentary mail as JSON object as described in Detailed mail data with just its message body (as html content) defined in nested JSON array `attachments` and its header data (from, to, subject, etc.). The field "content_type" defines whether the mail ought to be sent as plain text ("text/plain"), as html ("text/html") or as multipart/alternative ("ALTERNATIVE"). Sending a mail requires some special fields inside JSON mail object. The field "infostore_ids" defines a JSON array of infostore document ID(s) that ought to be appended to this mail as attachments. The field "msgref" indicates the ID of the referenced original mail. Moreover the field "sendtype" indicates the type of the message:
0 (normal new mail),
1 (a reply mail, field `msgref` must be present),
2 (a forward mail, field `msgref` must be present),
3 (draft edit operation, field `msgref` must be present in order to delete previous draft message since e.g. IMAP does not support changing/replacing a message but requires a delete-and-insert sequence),
4 (transport of a draft mail, field `msgref` must be present),
6 (signals that user intends to send out a saved draft message and expects the draft message (referenced by `msgref` field) being deleted after successful transport). The `csid` field, if it is missing from the URL it must then be present in the body.'Content-type: application/x-www-form-urlencoded-
MailData
{
Responses:
200:
'A JSON object containing the identifier of the saved draft e-mail. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
MailsResponse
{- data ( array[array[string]] ): Array of mails. Each mail is described as an array itself.
- cache ( boolean ): If present and set to true, that parameter signals that response has been fetched from cache
- more ( integer ): If present that parameter signals how many items are totally available since client requested a certain chunk from overall result set
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) The identifier of the folder to provide the status information for
query string Responses:
200:
'The JSON representation for the status information. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
ExamineResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- validity ( string ): The folder validity string.
- total ( integer ): The number of total messages.
- unread ( integer ): The number of unread messages.
- next ( string ): The expected next identifier.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the mail which contains the attachment.
query string attachment (empty) ID of the requested attachment (can be substituted by the parameter `cid` otherwise this parameter is **mandatory**).
query string cid (empty) Value of header 'Content-ID' of the requested attachment (can be substituted by the parameter `attachment` otherwise this parameter is **mandatory**).
query string save (empty) 1 overwrites the defined mimetype for this attachment to force the download dialog, otherwise 0.
query integer filter (empty) 1 to apply HTML white-list filter rules if and only if requested attachment is of MIME type `text/htm*` **AND** parameter `save` is set to 0.
query integer allow_nested_messages (empty) A value of "false" leads to light-weight JSON objects for nested messages containing only the "id" field
query boolean scan (empty) Flag to request an Anti-Virus scan for the specified e-mail attachment before downloading it. Note that if there is a max file limitation set on the middleware, the URL parameter 'exact_length' has to be set to 'true' to instruct the middleware to calculate the attachment's size before passing it to the Anti-Virus scanner.
query boolean as_json (empty) Nested messages are parsed into full JSON objects. Can lead to longer loading times, for multiple nested messages.
query boolean decrypt (empty) If true, and the object is encrypted, an attempt will be made to decrypt the object. An error will be thrown if needed authentication isn't available. (Guard Required)
query boolean cryptoAuth (empty) Authentication token used for Guard in order to decrypt or sign items. Required if the token is not attached to the session and the decrypt flag was sent.
query string rotate (empty) Adds a 'rotate' transformation, leading to the image being rotated according to the contained EXIF information.
query boolean width (empty) The maximum width of the target image.
query integer height (empty) The maximum height of the target image.
query integer shrinkOnly (empty) Set to true to only scale images 'greater than' target size.
query boolean scaleType Defines the scale type. Possible value:
cover
- The "cover" scale type, specifying the minimum target dimensions.
The source image will be resized in a way that the resulting image covers the target resolution entirely, with the original aspect ratio being preserved. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "cover", will result in the picture being resized to 267x200 pixels.contain
- The "contain" scale type, specifying the maximum target dimensions.
The source image will be resized in a way that the resulting image fits into the target resolution entirely, with the original aspect ratio being preserved. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "contain", will result in the picture being resized to 200x150 pixels.containforcedimension
- The "containforcedimension" scale type, specifying the maximum target dimensions.
The source image will be resized in a way that the resulting image fits into the target resolution entirely, with the original aspect ratio being preserved while smaller sides get padded to fit exact dimension. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "containforcedimension", will result in the picture being first resized to 200x150 pixels, then height gets padded by 25 pixels per side resulting in exactly 200x200 pixels.coverandcrop
- The "coverandcrop" scale type, specifying the target dimensions.
If the source image is bigger than the target dimension, in a first step the image will be resized in a way that the resulting image covers the target resolution entirely, with the original aspect ratio being preserved. In a second step the image will be cropped to fit the target dimension. For example, scaling an image with an original resolution of 640x480 pixels to 200x200 pixels and type "coverandcrop", will result in the picture being resized to 267x200 pixels and then cropped to fit 200x200. In case the image is smaller than then target dimension the image will not be resized and instead it gets padded to fit exact dimension. For example, with an original resolution of 100x100 pixels and a target dimension of 200x200 pixels and type "coverandcrop", will result in the picture being padded on all sides with 50 pixels.auto
- The "auto" scale type.
query string cropWidth (empty) The width of the specified rectangular region.
query integer cropHeight (empty) The height of the specified rectangular region.
query integer cropX (empty) The X coordinate of the upper-left corner of the specified rectangular region.
query integer cropY (empty) The Y coordinate of the upper-left corner of the specified rectangular region.
query integer Responses:
200:
The raw byte data of the document. The response type for the HTTP Request is set accordingly to the defined mimetype for this attachment, except the parameter save is set to 1.
Content-type: application/json-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mails
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the mail which contains the attachment.
query string attachment (empty) ID of the requested attachment.
query string dest_folder (empty) Object ID of the folder in which the attachment should be stored.
query string Body:
Description:A possible empty JSON object containing the optional fields `description` and `filename`. The filename and description values will be used for the newly created file in the drive module.
Content-type: application/json-
PutAttachmentBody
{- filename ( string ): The name of the newly created drive file.
- description ( string ): The description of the newly created drive file.
Responses:
200:
A JSON object containting the data of the store operation. E.g. contains the id of the newly created drive file.
Content-type: application/json-
PutAttachmentResponse
{- data ( data ): No description available
-
data
{- mailFolder ( string ): Object ID of the folder who contains the mails.
- mailUID ( string ): Object ID of the mail which contains the attachment.
- id ( string ): Object ID of the newly created drive file.
- folder_id ( string ): Object ID of the folder in which the attachment is stored to.
- filename ( string ): Name of the newly created drive file.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string columns (empty) A comma-separated list of either columns or header names to return, like "600,601,X-Custom-Header". Each column is specified by a numeric column identifier, see Detailed mail data.
query string headers (empty) A comma-separated list of header names to return, like "From,X-Custom-Header". This parameter can be used in addition to the columns parameter.
query string unseen (empty) If `true` only mails without the `\Seen` flag are returned.
query boolean deleted (empty) If `false` only mails without the `\Deleted` flag are returned.
query boolean sort (empty) The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified. Note: Applies only to root-level messages.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Note: Applies only to root-level messages.
query string includeSent (empty) A boolean value to signal that conversations also include messages taken from special "sent" aka "sent items" folder.
query boolean left_hand_limit (empty) A positive integer number to specify the "left-hand" limit of the range to return. Note: Applies only to root-level messages.
query integer right_hand_limit (empty) A positive integer number to specify the "right-hand" limit of the range to return. Note: Applies only to root-level messages.
query integer limit (empty) A positive integer number to specify how many items shall be returned according to given sorting; overrides `left_hand_limit`/`right_hand_limit` parameters and is equal to `left_hand_limit=0` and `right_hand_limit=
`. Note: Applies only to root-level messages. query integer categoryid (empty) The category id to filter for. Retrieves all conversations with at least one mail in the category.
query string max (empty) The max. number of messages to consider.
query string Responses:
200:
A JSON object containing an array of objects, each representing a conversation's root message along with its message thread. The root message's JSON object is filled according to the specified `columns` and is enhanced by a special `thread` field representing the full message thread (including the root message itself). `thread` is a JSON array of objects each representing a message in the conversation sorted by time-line and filled with the specified `columns`. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailConversationsResponse
{- data ( array[MailConversationData] ): An array of JSON objects each representing a conversation's root message.
- cache ( boolean ): If present and set to true, that parameter signals that response has been fetched from cache
- more ( integer ): If present that parameter signals how many items are totally available since client requested a certain chunk from overall result set
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailConversationData
{- unreadCount ( integer ): No description available
- thread ( array[MailData] ): JSON array consisting of JSON objects, each representing a message in the conversation.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
MailData
{- nested_msgs ( array[object] ): An array containing additional mails that are attached to this mail.
- security_info ( GuardSecurityInfo ): Information if mail is encrypted or signed. Requires Guard
- security ( GuardSecurityResult ): Information regarding signature verification or decryption type after processed by Guard
- authenticity ( AuthenticationResult ): Informations about the authenticity of the sender domain.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array[MailAttachment] ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
GuardSecurityInfo - Information if mail is encrypted or signed. Requires Guard
{- encrypted ( boolean ): True if the mail is currently encrypted
- signed ( boolean ): True if the email has signatures
-
GuardSecurityResult - Information regarding signature verification or decryption type after processed by Guard
{- decrypted ( boolean ): True if the mail has been decrypted.
- type ( string ): Type of encryption. Currently only PGP supported
- pgpInline ( boolean ): True if the mail was encrypted using PGP Inline rather than PGP Mime
- signatures ( array[GuardSignatureResult] ): Array of signatures, if any, and the verification status
-
GuardSignatureResult
{- verified ( boolean ): True if the signature was verified and correct
- missing ( boolean ): True if the signature could not be verified due to missing public key
- date ( integer ): Date of the signature in ticks
-
AuthenticationResult - Informations about the authenticity of the sender domain.
{- dmarc ( dmarc ): The DMARC authentication results
- dkim ( dkim ): The DKIM authentication results
- spf ( spf ): The SPF authentication results
- unconsidered_results ( array[object] ): A list of unconsidered results
- trusted ( boolean ): Defines whether the sender is a trusted sender.
- image ( string ): In case the result is positive and the mail address of the sender is a trusted mail address this field contains the uid of the image if one exists. The image can be obtained from the image module.
- from_domain ( string ): The from domain
-
status
(
string
, possibleValues:
pass
neutral
fail
suspicious
not-analyzed
-
dmarc - The DMARC authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
dkim - The DKIM authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
spf - The SPF authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
MailAttachment
{- id ( string ): Object ID (unique only inside the same message).
- content_type ( string ): MIME type.
- content ( string ): Content as text. Present only if easily convertible to text.
- filename ( string ): Displayed filename (mutually exclusive with content).
- size ( integer ): Size of the attachment in bytes.
-
disp
(
string
, possibleValues:
null
inline
attachment
alternative
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Body:
Description:A JSON object providing the share reference to resolve
Content-type: application/json-
ResolveShareReferenceElement
{- reference ( string , required ): The reference string.
Responses:
200:
'The JSON representation for the resolved share reference. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
ResolveShareReferenceResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- shareToken ( string ): The associated share token.
- contextId ( integer ): The originator's context identifier.
- userId ( integer ): The originator's user identifier.
- files ( array[object] ): The file meta data.
- password ( string ): The optional password that protects the share link.
- expiration ( integer ): The optional expiration date of the share link.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Not IMAP: timestamp of the last update of the deleted mails.
query long harddelete (empty) Flag to hard delete the messages, meaning not to create a backup copy of each message in default trash if set to `true`.
query boolean returnAffectedFolders (empty) Flag to generate an JSON response as described below. If set to `false` just an empty JSON Array is returned.
query boolean Body:
Description:A JSON array of JSON objects with the id and folder of the mails.
Content-type: application/json-
MailListElement
{- id ( string , required ): The object ID of the mail.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
Not IMAP: A JSON array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailsCleanUpResponse
{- data ( array[string] ): Not IMAP: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Note
By setting the query parameter
src
to 1 the response type of the request action changes. Then it is returned a JSON object with the fielddata
containing the complete message source as plain text. The parameters below specify the ones that have an effect on the request.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested mail (can be substituded by `message_id` parameter).
query string message_id (empty) The value of "Message-Id" header of the requested mail. This parameter is a substitute for "id" parameter.
query string unseen (empty) Use `true` to leave an unseen mail as unseen although its content is requested.
query boolean save (empty) 1 to write the complete message source to output stream. **NOTE:** This parameter will only be used if parameter `src` is set to 1.
query integer Responses:
200:
A JSON object containing the complete message source as plain text. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailSourceResponse
{- data ( string ): The complete message source as plain text.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Note
By setting the query parameter
hdr
to 1 the response type of the request action changes. Then it is returned a JSON object with the fielddata
containing the (formatted) message headers as plain text. The parameters below specify the ones that have an effect on the request.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested mail (can be substituded by `message_id` parameter).
query string message_id (empty) The value of "Message-Id" header of the requested mail. This parameter is a substitute for "id" parameter.
query string unseen (empty) Use `true` to leave an unseen mail as unseen although its content is requested.
query boolean Responses:
200:
A JSON object containing the message headers as plain text. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailHeadersResponse
{- data ( string ): The (formatted) message headers as plain text.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Returns the data for the message that shall be replied.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested message.
query string view Content 'text' forces the server to deliver a text-only version of the requested mail's body, even if content is HTML. 'html' to allow a possible HTML mail body being transferred as it is (but white-list filter applied). NOTE: if set, the corresponding gui config setting will be ignored.
query string setFrom (empty) A flag (`true`/`false`) that signals if "From" header shall be pre-selected according to a suitable recipient address that matches one of user's E-Mail address aliases.
query boolean max_size (empty) A positive integer number (greater than 10000) to specify how many characters of the message content will be returned. If the number is smaller than 10000 the value will be ignored and 10000 used.
query integer decrypt (empty) If true, and the object is encrypted, an attempt will be made to decrypt the object. An error will be thrown if needed authentication isn't available. (Guard Required)
query boolean cryptoAuth (empty) Authentication token used for Guard in order to decrypt or sign items. Required if the token is not attached to the session and the decrypt flag was sent.
query string Responses:
200:
A JSON object containing all data of the requested mail. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailReplyResponse
{- data ( MailReplyData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailReplyData
{- msgref ( string ): Indicates the ID of the referenced original mail.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array[MailAttachment] ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
MailAttachment
{- id ( string ): Object ID (unique only inside the same message).
- content_type ( string ): MIME type.
- content ( string ): Content as text. Present only if easily convertible to text.
- filename ( string ): Displayed filename (mutually exclusive with content).
- size ( integer ): Size of the attachment in bytes.
-
disp
(
string
, possibleValues:
null
inline
attachment
alternative
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested mail (can be substituded by `message_id` parameter).
query string message_id (empty) The value of "Message-Id" header of the requested mail. This parameter is a substitute for "id" parameter.
query string edit (empty) 1 indicates that this request should fill the message compose dialog to edit a message and thus display-specific date is going to be withheld.
query integer view "Specifies the view of the mail's body: raw (returns the content as it is, meaning no preparation are performed and thus no guarantee for safe contents is given), text ( forces the server to deliver a text-only version of the requested mail's body, even if content is HTML), textNoHtmlAttach (is the same as 'text', but does not deliver the HTML part as attachment in case of multipart/alternative content), html (to allow a possible HTML mail body being transferred as it is (but white-list filter applied)), noimg (to allow a possible HTML content being transferred but without original image src attributes which references external images; can be used to prevent loading external linked images (spam privacy protection)). document (to have a inline HTML representation of message's content in a separate window) **If set, the corresponding gui config setting will be ignored.**"
query string forceImages (empty) Use `true` to enforce that images are allowed in HTML content. Only applicable in case `view` parameter is `document`
query boolean unseen (empty) Use `true` to leave an unseen mail as unseen although its content is requested.
query boolean max_size (empty) A positive integer number (greater than 10000) to specify how many characters of the message content will be returned. If the number is smaller than 10000 the value will be ignored and 10000 used.
query integer attach_src (empty) 1 to let the JSON mail representation being extended by "source" field containing the mail raw RFC822 source data.
query integer estimate_length (empty) If set to "true" the "size" field for mail attachments is adjusted by applying an estimation based on attachment's Content-Transfer-Encoding header
query boolean pregenerate_previews (empty) If set to "true" preview generation is triggered in the background for all file attachments of the referenced mail message
query boolean no_nested_message (empty) If set to "true" nested messages are handled as regular attachments
query boolean decrypt (empty) If true, and the object is encrypted, an attempt will be made to decrypt the object. An error will be thrown if needed authentication isn't available. (Guard Required)
query boolean cryptoAuth (empty) Authentication token used for Guard in order to decrypt or sign items. Required if the token is not attached to the session and the decrypt flag was sent.
query string Responses:
200:
A JSON object containing all data of the requested mail. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailResponse
{- data ( MailData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailData
{- nested_msgs ( array[object] ): An array containing additional mails that are attached to this mail.
- security_info ( GuardSecurityInfo ): Information if mail is encrypted or signed. Requires Guard
- security ( GuardSecurityResult ): Information regarding signature verification or decryption type after processed by Guard
- authenticity ( AuthenticationResult ): Informations about the authenticity of the sender domain.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array[MailAttachment] ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
GuardSecurityInfo - Information if mail is encrypted or signed. Requires Guard
{- encrypted ( boolean ): True if the mail is currently encrypted
- signed ( boolean ): True if the email has signatures
-
GuardSecurityResult - Information regarding signature verification or decryption type after processed by Guard
{- decrypted ( boolean ): True if the mail has been decrypted.
- type ( string ): Type of encryption. Currently only PGP supported
- pgpInline ( boolean ): True if the mail was encrypted using PGP Inline rather than PGP Mime
- signatures ( array[GuardSignatureResult] ): Array of signatures, if any, and the verification status
-
GuardSignatureResult
{- verified ( boolean ): True if the signature was verified and correct
- missing ( boolean ): True if the signature could not be verified due to missing public key
- date ( integer ): Date of the signature in ticks
-
AuthenticationResult - Informations about the authenticity of the sender domain.
{- dmarc ( dmarc ): The DMARC authentication results
- dkim ( dkim ): The DKIM authentication results
- spf ( spf ): The SPF authentication results
- unconsidered_results ( array[object] ): A list of unconsidered results
- trusted ( boolean ): Defines whether the sender is a trusted sender.
- image ( string ): In case the result is positive and the mail address of the sender is a trusted mail address this field contains the uid of the image if one exists. The image can be obtained from the image module.
- from_domain ( string ): The from domain
-
status
(
string
, possibleValues:
pass
neutral
fail
suspicious
not-analyzed
-
dmarc - The DMARC authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
dkim - The DKIM authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
spf - The SPF authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
MailAttachment
{- id ( string ): Object ID (unique only inside the same message).
- content_type ( string ): MIME type.
- content ( string ): Content as text. Present only if easily convertible to text.
- filename ( string ): Displayed filename (mutually exclusive with content).
- size ( integer ): Size of the attachment in bytes.
-
disp
(
string
, possibleValues:
null
inline
attachment
alternative
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string Responses:
200:
A JSON object with the value `true`. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailsAllSeenResponse
{- data ( boolean ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
PUT /mail?action=update Updates a mail or a folder's messages and/or moves a mail to another folder.
The update request can perform an update of the color label and flags of one mail object. Beside it is possible to change the mail's folder, meaning move the mail to another folder. Both operations can be performed at once too.
If neither parameter
id
nor parametermessage_id
is specified, all folder's messages are updated accordingly.Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested mail that shall be updated (**mandatory** if a mail shall be moved).
query string message_id (empty) The value of "Message-Id" header of the requested mail. This parameter is a substitute for "id" parameter.
query string Body:
Description:A JSON object containing the new values that ought to be applied to mail and/or the id of the destination folder (if the mail shall be moved, otherwise it must not be specified).
Content-type: application/json-
MailUpdateBody
{- folder_id ( string ): The object ID of the destination folder (if the mail shall be moved).
- color_label ( integer ): The color number between 0 and 10.
- flags ( integer ): A set of flags to add or remove. Note: Flags for "recent" (8) and "user" (64) are ignored.
- value ( boolean ): Use `true` to add the flags specified by flags (logical OR) and `false` to remove them (logical AND with the inverted value).
- set_flags ( integer ): A set of flags to add. Note: Flags for "recent" (8) and "user" (64) are ignored.
- clear_flags ( integer ): A set of flags to remove. Note: Flags for "recent" (8) and "user" (64) are ignored.
Responses:
200:
A JSON object containing the object ID and the folder ID of an updated and/or moved mail or only the folder ID if several mails are updated. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailDestinationResponse
{- data ( MailDestinationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailDestinationData
{- folder_id ( string ): Object ID of the destination folder.
- id ( string ): Object ID of the "new" mail.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
This request can be used to store a single or a lot of mails in the OX mail storage backend. This action should be used instead of /mail?action=new because it is faster and tolerant to 8-bit encoded emails.
To import multiple mails add further form-data fields.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) The ID of the folder into that the emails should be imported.
query string flags (empty) In case the mail should be stored with status "read" (e.g. mail has been read already in the client inbox), the parameter "flags" has to be included. For information about mail flags see Detailed mail data.
query string force (empty) If this parameter is set to `true`, the server skips checking the valid from address.
query boolean Body:
Description:No description available
Content-type: multipart/form-data
Responses:
200:
A JSON object containing an array of JSON objects each with the folder identifier and the object ID of the imported mail(s). In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailImportResponse
{- data ( array[MailDestinationData] ): An array of JSON objects each describing the folder ID and object ID of one imported mail.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailDestinationData
{- folder_id ( string ): Object ID of the destination folder.
- id ( string ): Object ID of the "new" mail.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested mail that shall be copied.
query string folder (empty) Object ID of the folder who contains the mails.
query string Body:
Description:A JSON object containing the id of the destination folder.
Content-type: application/json-
MailDestinationBody
{- folder_id ( string ): The object ID of the destination folder.
Responses:
200:
A JSON object containing the object ID and the folder ID of the copied mail. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailDestinationResponse
{- data ( MailDestinationData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailDestinationData
{- folder_id ( string ): Object ID of the destination folder.
- id ( string ): Object ID of the "new" mail.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Body:
Description:A JSON object providing the identifiers of the source and target folder.
Content-type: application/json-
MailMoveAllBody
{- source ( string ): The identifier of the source folder.
- target ( string ): The identifier of the target folder.
Responses:
200:
A JSON object containing an entry for each affected folder. Each entry in turn references a JSON object providing "total" and "unread" fields, which given the total number of mails and the number of unread mails in the folder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string columns (empty) A comma-separated list of either columns or header names to return, like "600,601,X-Custom-Header". Each column is specified by a numeric column identifier, see Detailed mail data.
query string headers (empty) A comma-separated list of header names to return, like "From,X-Custom-Header". This parameter can be used in addition to the columns parameter.
query string unseen (empty) If `true` only mails without the `\Seen` flag are returned.
query boolean deleted (empty) If `false` only mails without the `\Deleted` flag are returned.
query boolean sort (empty) The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified. Note: Applies only to root-level messages.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Note: Applies only to root-level messages.
query string Body:
Description:A JSON object describing the search term as described in Advanced search. Example: `{"filter":["and",["=", {"field":"to"},"test1@example.com"],["not",["=",{"attachment":"name"},"document.pdf"]]]}` which represents 'to = "test1@example.com" AND NOT from = "test2@example.com"'. Available field names are `from`, `to`, `cc`, `bcc`, `subject`, `received_date`, `sent_date`, `size`, `flags`, `content`, `content_type`, `disp`, and `priority`.
Content-type: application/json-
Unknown
Responses:
200:
'A JSON object containing an array with matching mails. Mails are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
MailsResponse
{- data ( array[array[string]] ): Array of mails. Each mail is described as an array itself.
- cache ( boolean ): If present and set to true, that parameter signals that response has been fetched from cache
- more ( integer ): If present that parameter signals how many items are totally available since client requested a certain chunk from overall result set
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of either columns or header names to return, like "600,601,X-Custom-Header". Each column is specified by a numeric column identifier, see Detailed mail data.
query string headers (empty) A comma-separated list of header names to return, like "From,X-Custom-Header". This parameter can be used in addition to the columns parameter.
query string Body:
Description:A JSON array of JSON objects with the id and folder of the requested mails.
Content-type: application/json-
MailListElement
{- id ( string , required ): The object ID of the mail.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
'A JSON object containing an array with mail data. Mails are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
MailsResponse
{- data ( array[array[string]] ): Array of mails. Each mail is described as an array itself.
- cache ( boolean ): If present and set to true, that parameter signals that response has been fetched from cache
- more ( integer ): If present that parameter signals how many items are totally available since client requested a certain chunk from overall result set
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Provides a list of updated mails.
Attention: This does not work for IMAP mail accounts. In case of imap accounts an empty list is returned.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string columns (empty) A comma-separated list of either columns or header names to return, like "600,601,X-Custom-Header". Each column is specified by a numeric column identifier, see Detailed mail data.
query string headers (empty) A comma-separated list of header names to return, like "From,X-Custom-Header". This parameter can be used in addition to the columns parameter.
query string ignore (empty) The type of updates which should be ignored. Currently known values are 'deleted' and 'changed'. E.g. if you only want to retrieve deleted mails you use 'ignore=changed'.
query string Responses:
200:
Just an empty JSON array is going to be returned since this action cannot be applied to IMAP. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailsResponse
{- data ( array[array[string]] ): Array of mails. Each mail is described as an array itself.
- cache ( boolean ): If present and set to true, that parameter signals that response has been fetched from cache
- more ( integer ): If present that parameter signals how many items are totally available since client requested a certain chunk from overall result set
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Not IMAP: timestamp of the last update of the deleted mails.
query long Body:
Description:A JSON array with object IDs of the mail folders that shall be cleared.
Content-type: application/json
Responses:
200:
A JSON array with IDs of mail folder that could not be cleared; meaning the response body is an empty JSON array if everything went well. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailsCleanUpResponse
{- data ( array[string] ): Not IMAP: An array with object IDs of mails which were modified after the specified timestamp and were therefore not deleted.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the mail which contains the attachments.
query string attachment (empty) A comma-separated list of IDs of the requested attachments.
query string scan (empty) Flag to request an Anti-Virus scan for the specified e-mail attachments before downloading them.
query boolean Responses:
200:
The raw byte data of the ZIP file.
Content-type: application/zip-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string columns (empty) A comma-separated list of either columns or header names to return, like "600,601,X-Custom-Header". Each column is specified by a numeric column identifier, see Detailed mail data.
query string headers (empty) A comma-separated list of header names to return, like "From,X-Custom-Header". This parameter can be used in addition to the columns parameter.
query string sort (empty) The identifier of a column which determines the sort order of the response or the string “thread” to return thread-sorted messages. If this parameter is specified and holds a column number, then the parameter order must be also specified. Note: Applies only to root-level messages.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified. Note: Applies only to root-level messages.
query string size (empty) The optional number of latest messages to consider.
query integer Body:
Description:A JSON object describing the search term as introducted in Advanced search. Example: `{"filter":["and",["=", {"field":"to"},"test1@example.com"],["not",["=",{"attachment":"name"},"document.pdf"]]]}` which represents 'to = "test1@example.com" AND NOT from = "test2@example.com"'. Available field names are `from`, `to`, `cc`, `bcc`, `subject`, `received_date`, `sent_date`, `size`, `flags`, `content`, `content_type`, `disp`, and `priority`.
Content-type: application/x-www-form-urlencoded-
Unknown
Responses:
200:
A JSON object containing an array of objects, each representing a message thread with informations about the root and last mail. The `thread` field is a JSON array of objects each representing a message in the conversation sorted by time-line and filled with the specified `columns`. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailThreadReferencesResponse
{- data ( array[MailThreadReferenceData] ): An array of JSON objects each representing a conversation.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailThreadReferenceData
{- rootMailId ( string ): The unique id of the root mail.
- rootOriginalMailId ( string ): The original unique id of the root mail.
- rootOriginalFolderId ( string ): The original folder id of the root mail.
- latestMailId ( string ): The unique id of the latest mail.
- latestOriginalMailId ( string ): The original unique id of the latest mail.
- latestOriginalFolderId ( string ): The original folder id of the latest mail.
- latestReceivedDate ( integer ): Date and time as measured by the receiving server of the latest mail.
- thread ( array[MailData] ): JSON array consisting of JSON objects, each representing a message in the conversation.
-
MailData
{- nested_msgs ( array[object] ): An array containing additional mails that are attached to this mail.
- security_info ( GuardSecurityInfo ): Information if mail is encrypted or signed. Requires Guard
- security ( GuardSecurityResult ): Information regarding signature verification or decryption type after processed by Guard
- authenticity ( AuthenticationResult ): Informations about the authenticity of the sender domain.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array[MailAttachment] ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
GuardSecurityInfo - Information if mail is encrypted or signed. Requires Guard
{- encrypted ( boolean ): True if the mail is currently encrypted
- signed ( boolean ): True if the email has signatures
-
GuardSecurityResult - Information regarding signature verification or decryption type after processed by Guard
{- decrypted ( boolean ): True if the mail has been decrypted.
- type ( string ): Type of encryption. Currently only PGP supported
- pgpInline ( boolean ): True if the mail was encrypted using PGP Inline rather than PGP Mime
- signatures ( array[GuardSignatureResult] ): Array of signatures, if any, and the verification status
-
GuardSignatureResult
{- verified ( boolean ): True if the signature was verified and correct
- missing ( boolean ): True if the signature could not be verified due to missing public key
- date ( integer ): Date of the signature in ticks
-
AuthenticationResult - Informations about the authenticity of the sender domain.
{- dmarc ( dmarc ): The DMARC authentication results
- dkim ( dkim ): The DKIM authentication results
- spf ( spf ): The SPF authentication results
- unconsidered_results ( array[object] ): A list of unconsidered results
- trusted ( boolean ): Defines whether the sender is a trusted sender.
- image ( string ): In case the result is positive and the mail address of the sender is a trusted mail address this field contains the uid of the image if one exists. The image can be obtained from the image module.
- from_domain ( string ): The from domain
-
status
(
string
, possibleValues:
pass
neutral
fail
suspicious
not-analyzed
-
dmarc - The DMARC authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
dkim - The DKIM authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
spf - The SPF authentication results
{- result ( string ): The result of the mechanism
- reason ( string ): The reason of the status
- from_domain ( string ): The origin domain of the sender
-
MailAttachment
{- id ( string ): Object ID (unique only inside the same message).
- content_type ( string ): MIME type.
- content ( string ): Content as text. Present only if easily convertible to text.
- filename ( string ): Displayed filename (mutually exclusive with content).
- size ( integer ): Size of the attachment in bytes.
-
disp
(
string
, possibleValues:
null
inline
attachment
alternative
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Returns the data for the message that shall be forwarded.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the mails.
query string id (empty) Object ID of the requested message.
query string view Content 'text' forces the server to deliver a text-only version of the requested mail's body, even if content is HTML. 'html' to allow a possible HTML mail body being transferred as it is (but white-list filter applied). NOTE: if set, the corresponding gui config setting will be ignored.
query string max_size (empty) A positive integer number (greater than 10000) to specify how many characters of the message content will be returned. If the number is smaller than 10000 the value will be ignored and 10000 used.
query integer decrypt (empty) If true, and the object is encrypted, an attempt will be made to decrypt the object. An error will be thrown if needed authentication isn't available. (Guard Required)
query boolean cryptoAuth (empty) Authentication token used for Guard in order to decrypt or sign items. Required if the token is not attached to the session and the decrypt flag was sent.
query string Responses:
200:
A JSON object containing all data of the requested mail. Not IMAP: with timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailReplyResponse
{- data ( MailReplyData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailReplyData
{- msgref ( string ): Indicates the ID of the referenced original mail.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive).
- id ( string ): Object ID of the mail.
- folder_id ( string ): Object ID of the parent folder.
- attachment ( boolean ): Indicates whether this mail has attachments.
- from ( array[array[string]] ): Each element is a two-element array specifying one sender (address). The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values.
- to ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one receiver.
- cc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one carbon-copy receiver.
- bcc ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver.
- sender ( array[array[string]] ): Each element is a two-element array (see the from field) specifying one sender.
- subject ( string ): The mail's subject.
- size ( integer ): The size if the mail in bytes.
- sent_date ( integer ): Date and time as specified in the mail by the sending client.
- received_date ( integer ): Date and time as measured by the receiving server.
-
flags
(
integer
, possibleValues:
1
2
4
8
16
32
64
128
256
* 1 (answered),
* 2 (deleted),
* 4 (draft),
* 8 (flagged),
* 16 (recent),
* 32 (seen),
* 64 (user),
* 128 (spam),
* 256 (forwarded)
- level ( integer ): Zero-based nesting level in a thread.
- disp_notification_to ( string ): Content of message's header "Disposition-Notification-To".
-
priority
(
integer
, possibleValues:
0
5
4
3
2
1
* 0 (no priority),
* 5 (very low),
* 4 (low),
* 3 (normal),
* 2 (high),
* 1 (very high)
- msg_ref ( string ): Message reference on reply/forward.
- flag_seen ( string ): Special field to sort mails by seen status.
- account_name ( string ): Message's account name.
- account_id ( integer ): Message's account identifier.
- user ( array[string] ): An array with user-defined flags as strings.
- headers ( headers ): A map with fields for every non-standard header. The header name is the field name. The header value is the value of the field as string.
- attachments ( array[MailAttachment] ): Each element is an attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative.
- truncated ( boolean ): `true` / `false` if the mail content was trimmed.
- source ( string ): RFC822 source of the mail. Only present for "?action=get&attach_src=true".
- cid ( string ): The value of the "Content-ID" header, if the header is present.
- original_id ( string ): The original mail identifier (e.g. if fetched from "virtual/all" folder).
- original_folder_id ( string ): The original folder identifier (e.g. if fetched from "virtual/all" folder).
- content_type ( string ): The MIME type of the mail.
- text_preview ( string ): The optional preview of the mail body
-
MailAttachment
{- id ( string ): Object ID (unique only inside the same message).
- content_type ( string ): MIME type.
- content ( string ): Content as text. Present only if easily convertible to text.
- filename ( string ): Displayed filename (mutually exclusive with content).
- size ( integer ): Size of the attachment in bytes.
-
disp
(
string
, possibleValues:
null
inline
attachment
alternative
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
Mail_categories
The module mail_categories allows to manage mail categories.-
Adds a new rule with the given mail addresses to the given category and optionally reorganize all existing mails in the inbox.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type category_id (empty) The identifier of a category.
query string apply-for-existing (empty) A flag indicating whether old mails should be reorganized. Defaults to 'false'.
query boolean apply-for-future-ones (empty) A flag indicating whether a rule should be created or not. Defaults to 'true'.
query boolean Body:
Description:'A JSON object containing a "from" field which contains an array of mail addresses.'
Content-type: application/json-
Mail_CategoriesTrainBody
{- from ( array[string] ): An array of email addresses
Responses:
200:
'An empty response if everything went well. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type category_ids (empty) A comma separated list of category identifiers. If set only the unread counters of this categories are retrieved.
query string Responses:
200:
'A JSON object with a field for each active category containing the number of unread messages. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
Mail_CategoriesUnreadResponse
{- data ( data ): A JSON object with a field for each active category containing the number of unread messages.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type category_id (empty) The identifier of a category.
query string Body:
Description:'A JSON array of mail identifier, e.g.: [{"id":ID, "folder_id":FID},{"id":ID2, "folder_id":FID2}, {...}]'
Content-type: application/json-
Mail_CategoriesMoveBody
{- id ( string ): The object ID of the mail
- folder_id ( string ): The folder ID of the mail
Responses:
200:
'An empty response if everything went well. In case of errors the responsible fields in the response are filled (see Error handling).'
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Mailaccount
The mailaccount module is used to manage multiple mail accounts held by a user.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mailaccount
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The optional account identifier to query the status for a single mail account. If not set the status for all accounts are returned
query integer Responses:
200:
A small JSON response providing the accounts' status information; such as "ok" or "invalid_credentials" In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAccountStatusResponse
{- data ( Status ): No description available
- warnings ( CommonResponse ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Status
{- status ( string ): The status' identifier, such as "ok" or "invalid_credentials"
- message ( string ): An optional human-readable status-related message
-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mailaccount
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Mail account data.
query string Responses:
200:
A JSON object containing an array with data for all mail accounts. Each array element describes one account and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAccountsResponse
{- data ( data ): Array of mail accounts. Each account is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mailaccount
Body:
Description:A JSON object describing the new account to create.
Content-type: application/json-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
Responses:
200:
A JSON object containing the data of the inserted mail account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAccountUpdateResponse
{- data ( MailAccountData ): No description available
- warnings ( array[CommonResponse] ): An array of error objects that occurred during the creation of the account.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mailaccount
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Account ID of the requested account.
query integer Responses:
200:
An object containing all data of the requested account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAccountResponse
{- data ( MailAccountData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mailaccount
Body:
Description:A JSON object identifying (by field `id`) and describing the account to update. Only modified fields are present.
Content-type: application/json-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
Responses:
200:
A JSON object containing the data of the updated mail account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAccountUpdateResponse
{- data ( MailAccountData ): No description available
- warnings ( array[CommonResponse] ): An array of error objects that occurred during the creation of the account.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type tree (empty) Indicates whether on successful validation the folder tree shall be returned (or `null`on failure) or if set to `false` or missing only a boolean is returned which indicates validation result.
query boolean Body:
Description:A JSON object describing the account to validate.
Content-type: application/json-
MailAccountData
{- id ( integer ): The account identifier.
- name ( string , required ): The account's display name.
- login ( string , required ): The login name.
- password ( string , required ): The (optional) password.
- mail_url ( string , required ): The mail server URL, e.g. "imap://imap.somewhere.com:143". **URL is preferred over single fields** (like `mail_server`, `mail_port`, etc.).
- mail_server ( string ): The mail server's hostname or IP address.
- mail_port ( integer ): The mail server's port.
- mail_protocol ( string ): The mail server's protocol. **Always use basic protocol name.** E.g. use "imap" instead of "imaps".
- mail_secure ( boolean ): Whether to establish a secure connection to mail server (SSL, TLS).
- mail_starttls ( boolean ): Whether to establish a secure connection to mail server via STARTTLS.
- mail_oauth ( integer ): Provides the identifier of the associated OAuth account (if any) or `-1`.
- transport_url ( string ): The transport server URL, e.g. "smtp://smtp.somewhere.com:25". **URL is preferred over single fields** (like `transport_server`, `transport_port`, etc.).
- transport_server ( string ): The transport server's hostname or IP address.
- transport_port ( integer ): The transport server's port.
- transport_protocol ( string ): The transport server's protocol. **Always use basic protocol name.** E.g. use "smtp" instead of "smtps".
- transport_secure ( boolean ): Whether to establish a secure connection to transport server (SSL, TLS).
- transport_login ( string ): The transport login. **Please see `transport_auth` for the handling of this field.**
- transport_password ( string ): The transport password. **Please see `transport_auth` for the handling of this field.**
- transport_auth ( string ): Specifies the source for mail transport (SMTP) credentials. Possible values are `mail`, `custom`, and `none`. `mail` signals to use the same credentials as given in associated mail store (IMAP, POP3). `custom` signals that individual credentials are supposed to be used (fields `transport_login`, `transport_password` and/or `transport_oauth` are considered). `none` means the mail transport does not support any authentication mechanism (rare case!)
- transport_starttls ( boolean ): Whether to establish a secure connection to transport server via STARTTLS.
- transport_oauth ( integer ): The identifier of the OAuth account to use for mail transport. **Please see `transport_auth` for the handling of this field.**
- root_folder ( string ): The fully-qualifying identifier of account's root folder, e.g. "default519".
- primary_address ( string , required ): The user's primary address in account, e.g. "someone@somewhere.com".
- spam_handler ( string ): The name of the spam handler used by account.
- trash ( string ): The name of the default trash folder.
- sent ( string ): The name of the default sent folder.
- drafts ( string ): The name of the default drafts folder.
- spam ( string ): The name of the default spam folder.
- confirmed_spam ( string ): The name of the default confirmed-spam folder.
- confirmed_ham ( string ): The name of the default confirmed-ham folder.
- unified_inbox_enabled ( boolean ): Whether Unified INBOX is enabled.
- trash_fullname ( string ): Path to default trash folder. Preferred over `trash`.
- sent_fullname ( string ): Path to default sent folder. Preferred over `sent`.
- drafts_fullname ( string ): Path to default drafts folder. Preferred over `drafts`.
- spam_fullname ( string ): Path to default spam folder. Preferred over `spam`.
- confirmed_spam_fullname ( string ): Path to default confirmed-spam folder. Preferred over `confirmed_spam`.
- confirmed_ham_fullname ( string ): Path to default confirmed-ham folder. Preferred over `confirmed_ham`.
- pop3_refresh_rate ( integer ): The interval in minutes the POP3 account is refreshed.
- pop3_expunge_on_quit ( boolean ): Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not.
- pop3_delete_write_through ( boolean ): If option `pop3_expunge_on_quite` is disabled, this field defines whether a deleted in local INBOX also deletes affected message in actual POP3 account.
- pop3_storage ( string ): The name of POP3 storage provider, default is "mailaccount".
- pop3_path ( string ): Path to POP3's virtual root folder in storage, default name of the POP3 account beside default folders.
- personal ( string ): The customizable personal part of the email address.
- reply_to ( string ): The customizable reply-to email address.
- addresses ( string ): The comma-separated list of available email addresses including aliases (**only available for primary mail account**).
- meta ( string ): Stores arbitrary JSON data as specified by client associated with the mail account.
- archive ( string ): The name of the archive folder. **Currently not functional!**
- archive_fullname ( string ): The full name of the archive folder. **Currently not functional!**
Responses:
200:
A JSON object that contains a value representing the validation result (may be a boolean or a folder tree object). If the validation fails then the error fields are filled and an additional `warnings` field might be added.
Content-type: application/json-
MailAccountValidationResponse
{- data ( data ): 'A boolean if parameter `tree` is not specified indicating the validation result otherwise the folder tree object FolderData extended by a field `subfolder_array` that contains possible subfolders. In the tree case a value of `null` indicating a failed validation.'
- warnings ( CommonResponse ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mailaccount
Body:
Description:A JSON array with the ID of the mail account that shall be deleted.
Content-type: application/json
Responses:
200:
A JSON object containing an array with identifiers of deleted accounts. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailAccountDeletionResponse
{- data ( array[integer] ): An array containing the identifiers of the mail accounts that were deleted.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
MailCompose
The MailCompose REST API.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Body:
Description:No description available
Content-type: multipart/form-data-
postAttachmentsBody
{- file ( string , required ): The file to add
Responses:
200:
A JSON object containing the newly added attachment.
Content-type: application/json-
MailComposeAttachmentResponse
{- data ( Attachment result ): An attachment object.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Attachment result - An attachment object.
{- attachments ( array[MailComposeAttachment] ): No description available
- compositionSpace ( Attachment ): A compositon space info object.
-
Attachment - An attachment object.
{- id ( string ): The attachment id
- name ( string ): The attachment name
- size ( integer ): The attachments size in bytes
- mimeType ( string ): The mime type
- cid ( string ): The attachments content identifier
-
contentDisposition
(
string
, possibleValues:
inline
attachment
-
origin
(
string
, possibleValues:
upload
mail
drive
contact
vcard
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Space gets deleted. Optionally deletes draft if referenced.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Body:
Description:No description available
Content-type: multipart/form-data-
postMailComposeSendBody
{- JSON ( string , required ): Represents the request body as JSON string containing the RequestMessageModel. Note that it is not possible to change the attachments collection during this call. Furthermore changing shared attachments or Guard options during this call is discouraged and might lead to unexpected results.
- file ( string ): The optional file to add
Responses:
200:
The path to the sent mail or {"success"=true}.
Content-type: application/json-
MailComposeSendResponse
{- data ( MailComposeMailPathModel ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailComposeMailPathModel
{- id ( string ): The mail identifier within the folder
- folderId ( string ): The mail folder identifier
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Responses:
200:
A JSON object containing the new attachment.
Content-type: application/json-
MailComposeAttachmentResponse
{- data ( Attachment result ): An attachment object.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Attachment result - An attachment object.
{- attachments ( array[MailComposeAttachment] ): No description available
- compositionSpace ( Attachment ): A compositon space info object.
-
Attachment - An attachment object.
{- id ( string ): The attachment id
- name ( string ): The attachment name
- size ( integer ): The attachments size in bytes
- mimeType ( string ): The mime type
- cid ( string ): The attachments content identifier
-
contentDisposition
(
string
, possibleValues:
inline
attachment
-
origin
(
string
, possibleValues:
upload
mail
drive
contact
vcard
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Responses:
200:
A JSON array containing the added attachments to concat.
Content-type: application/json-
MailComposeAttachmentPostResponse
{- data ( Attachment result ): An attachment object.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Attachment result - An attachment object.
{- attachments ( array[MailComposeAttachment] ): No description available
- compositionSpace ( Attachment ): A compositon space info object.
-
Attachment - An attachment object.
{- id ( string ): The attachment id
- name ( string ): The attachment name
- size ( integer ): The attachments size in bytes
- mimeType ( string ): The mime type
- cid ( string ): The attachments content identifier
-
contentDisposition
(
string
, possibleValues:
inline
attachment
-
origin
(
string
, possibleValues:
upload
mail
drive
contact
vcard
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string Responses:
200:
A JSON object containing the requested composition space.
Content-type: application/json-
MailComposeResponse
{- data ( MailComposeResponseMessageModel ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailComposeResponseMessageModel
{- id ( string ): The identifier
- from ( Address ): Flat array of two strings. First item is display name, second item is email address.
- to ( array[array[string]] ): An array of addresses
- cc ( array[array[string]] ): An array of addresses
- bcc ( array[array[string]] ): An array of addresses
- subject ( string ): The subject
- content ( string ): The text content
-
contentType
(
string
, possibleValues:
text/plain
text/html
- attachments ( array[object] ): An array of attachments
- meta ( Meta ): Object of meta information
- requestReadReceipt ( boolean ): Request read receipt flag
-
priority
(
string
, possibleValues:
low
normal
high
- sharedAttachments ( Shared Attachments ): The shared attachments object
- security ( Security ): The security settings
- customHeaders ( customHeaders ): No description available
- mailPath ( mailPath ): The path to the draft message reflecting composition space
-
Meta - Object of meta information
{-
type
(
string
, possibleValues:
NEW
REPLY
REPLY_ALL
FORWARD_INLINE
FORWARD_ATTACHMENT
RESEND
-
date
(
integer
):
The date we should use for "On 6.6.2018 someone
wrote:". Server decides whether this is sent or received date. Milliseconds since January 1, 1970, 00:00:00 GMT - originalFolderId ( string ): Original folder id during reply or forward
- originalId ( string ): Original message id during reply or forward
-
type
(
string
, possibleValues:
-
Shared Attachments - The shared attachments object
{- language ( string ): The locale string
- enabled ( boolean ): The enabled flag
- autodelete ( boolean ): The auto delete flag
- expiryDate ( integer ): The expiry date. Milliseconds since January 1, 1970, 00:00:00 GMT
- password ( string ): The password
-
Security - The security settings
{- encrypt ( boolean ): No description available
- pgpInline ( boolean ): No description available
- sign ( boolean ): No description available
- language ( string ): No description available
- message ( string ): No description available
- pin ( string ): No description available
- msgRef ( string ): No description available
- authentication ( string ): No description available
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Payload is JSON that reflects changes. Response is the current composition space message model after update.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Body:
Description:An object containing the attributes to update
Content-type: application/json-
MailComposeRequestMessageModel
{- id ( string ): An identifier
- from ( Address ): Flat array of two strings. First item is display name, second item is email address.
- to ( array[array[string]] ): An array of addresses
- cc ( array[array[string]] ): An array of addresses
- bcc ( array[array[string]] ): An array of addresses
- subject ( string ): The subject
- content ( string ): The text content
-
contentType
(
string
, possibleValues:
text/plain
text/html
- attachments ( array[object] ): An array of attachments
- meta ( Meta ): Object of meta information
- requestReadReceipt ( boolean ): Request read receipt flag
-
priority
(
string
, possibleValues:
low
normal
high
- sharedAttachments ( Shared Attachments ): The shared attachments object
- security ( Security ): The security settings
- claim ( string ): A unique client token to prevent conflicts due to concurrent editing. Must be a 16-character string consisting of [a-zA-Z0-9] only. If set, any request with a different token to check against will fail with MSGCS-0010. Note that requests with clientToken as query parameter will always succeed for backwards-compatibility!
-
Meta - Object of meta information
{-
type
(
string
, possibleValues:
NEW
REPLY
REPLY_ALL
FORWARD_INLINE
FORWARD_ATTACHMENT
RESEND
-
date
(
integer
):
The date we should use for "On 6.6.2018 someone
wrote:". Server decides whether this is sent or received date. Milliseconds since January 1, 1970, 00:00:00 GMT - originalFolderId ( string ): Original folder id during reply or forward
- originalId ( string ): Original message id during reply or forward
-
type
(
string
, possibleValues:
-
Shared Attachments - The shared attachments object
{- language ( string ): The locale string
- enabled ( boolean ): The enabled flag
- autodelete ( boolean ): The auto delete flag
- expiryDate ( integer ): The expiry date. Milliseconds since January 1, 1970, 00:00:00 GMT
- password ( string ): The password
-
Security - The security settings
{- encrypt ( boolean ): No description available
- pgpInline ( boolean ): No description available
- sign ( boolean ): No description available
- language ( string ): No description available
- message ( string ): No description available
- pin ( string ): No description available
- msgRef ( string ): No description available
- authentication ( string ): No description available
Responses:
200:
A JSON object containing the updated composition space.
Content-type: application/json-
MailComposeResponse
{- data ( MailComposeResponseMessageModel ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailComposeResponseMessageModel
{- id ( string ): The identifier
- from ( Address ): Flat array of two strings. First item is display name, second item is email address.
- to ( array[array[string]] ): An array of addresses
- cc ( array[array[string]] ): An array of addresses
- bcc ( array[array[string]] ): An array of addresses
- subject ( string ): The subject
- content ( string ): The text content
-
contentType
(
string
, possibleValues:
text/plain
text/html
- attachments ( array[object] ): An array of attachments
- meta ( Meta ): Object of meta information
- requestReadReceipt ( boolean ): Request read receipt flag
-
priority
(
string
, possibleValues:
low
normal
high
- sharedAttachments ( Shared Attachments ): The shared attachments object
- security ( Security ): The security settings
- customHeaders ( customHeaders ): No description available
- mailPath ( mailPath ): The path to the draft message reflecting composition space
-
Meta - Object of meta information
{-
type
(
string
, possibleValues:
NEW
REPLY
REPLY_ALL
FORWARD_INLINE
FORWARD_ATTACHMENT
RESEND
-
date
(
integer
):
The date we should use for "On 6.6.2018 someone
wrote:". Server decides whether this is sent or received date. Milliseconds since January 1, 1970, 00:00:00 GMT - originalFolderId ( string ): Original folder id during reply or forward
- originalId ( string ): Original message id during reply or forward
-
type
(
string
, possibleValues:
-
Shared Attachments - The shared attachments object
{- language ( string ): The locale string
- enabled ( boolean ): The enabled flag
- autodelete ( boolean ): The auto delete flag
- expiryDate ( integer ): The expiry date. Milliseconds since January 1, 1970, 00:00:00 GMT
- password ( string ): The password
-
Security - The security settings
{- encrypt ( boolean ): No description available
- pgpInline ( boolean ): No description available
- sign ( boolean ): No description available
- language ( string ): No description available
- message ( string ): No description available
- pin ( string ): No description available
- msgRef ( string ): No description available
- authentication ( string ): No description available
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string harddelete (empty) Flag to hard delete the associated draft message, meaning not to create a backup copy in default trash if set to `true`.
query boolean clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Responses:
200:
A JSON object containing the success status.
Content-type: application/json-
deleteMailComposeByIdResponse
{- success ( boolean ): True if such a composition space has been successfully closed; false otherwise
400:
Bad request, response contains error message.
401:
Not authorized
-
-
This URL pattern can be used for inline images.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string attachmentId (empty) The ID of the attachment
path string Responses:
200:
The attachment as file.
Content-type: application/json-
Unknown
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Uploads an attachment again and removes the old attachment from the server. Used for image resize.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string attachmentId (empty) The ID of the attachment
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Body:
Description:No description available
Content-type: multipart/form-data-
postAttachmentsBody
{- file ( string , required ): The file to add
Responses:
200:
A JSON object containing the newly added attachment.
Content-type: application/json-
MailComposeAttachmentResponse
{- data ( Attachment result ): An attachment object.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Attachment result - An attachment object.
{- attachments ( array[MailComposeAttachment] ): No description available
- compositionSpace ( Attachment ): A compositon space info object.
-
Attachment - An attachment object.
{- id ( string ): The attachment id
- name ( string ): The attachment name
- size ( integer ): The attachments size in bytes
- mimeType ( string ): The mime type
- cid ( string ): The attachments content identifier
-
contentDisposition
(
string
, possibleValues:
inline
attachment
-
origin
(
string
, possibleValues:
upload
mail
drive
contact
vcard
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string attachmentId (empty) The ID of the attachment
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Responses:
200:
A JSON object containing the current state of the mail compose
Content-type: application/json-
MailComposeAttachmentResponse
{- data ( Attachment result ): An attachment object.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
Attachment result - An attachment object.
{- attachments ( array[MailComposeAttachment] ): No description available
- compositionSpace ( Attachment ): A compositon space info object.
-
Attachment - An attachment object.
{- id ( string ): The attachment id
- name ( string ): The attachment name
- size ( integer ): The attachments size in bytes
- mimeType ( string ): The mime type
- cid ( string ): The attachments content identifier
-
contentDisposition
(
string
, possibleValues:
inline
attachment
-
origin
(
string
, possibleValues:
upload
mail
drive
contact
vcard
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the composition space
path string clientToken (empty) The client token to check against for preventing concurrent editing. Must be the one set during open or PATCH before.
query string Responses:
200:
The path to the mail.
Content-type: application/json-
MailComposeSendResponse
{- data ( MailComposeMailPathModel ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailComposeMailPathModel
{- id ( string ): The mail identifier within the folder
- folderId ( string ): The mail folder identifier
400:
Bad request, response contains error message.
401:
Not authorized
-
-
Returns a JSON array of compositions spaces
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return. Each column is specified by the name of the Composition Space attribute. If no columns are specified only the "id" column is set.
query string Responses:
200:
A JSON array containing message models.
Content-type: application/json-
MailComposeGetResponse
{- data ( array[MailComposeResponseMessageModel] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailComposeResponseMessageModel
{- id ( string ): The identifier
- from ( Address ): Flat array of two strings. First item is display name, second item is email address.
- to ( array[array[string]] ): An array of addresses
- cc ( array[array[string]] ): An array of addresses
- bcc ( array[array[string]] ): An array of addresses
- subject ( string ): The subject
- content ( string ): The text content
-
contentType
(
string
, possibleValues:
text/plain
text/html
- attachments ( array[object] ): An array of attachments
- meta ( Meta ): Object of meta information
- requestReadReceipt ( boolean ): Request read receipt flag
-
priority
(
string
, possibleValues:
low
normal
high
- sharedAttachments ( Shared Attachments ): The shared attachments object
- security ( Security ): The security settings
- customHeaders ( customHeaders ): No description available
- mailPath ( mailPath ): The path to the draft message reflecting composition space
-
Meta - Object of meta information
{-
type
(
string
, possibleValues:
NEW
REPLY
REPLY_ALL
FORWARD_INLINE
FORWARD_ATTACHMENT
RESEND
-
date
(
integer
):
The date we should use for "On 6.6.2018 someone
wrote:". Server decides whether this is sent or received date. Milliseconds since January 1, 1970, 00:00:00 GMT - originalFolderId ( string ): Original folder id during reply or forward
- originalId ( string ): Original message id during reply or forward
-
type
(
string
, possibleValues:
-
Shared Attachments - The shared attachments object
{- language ( string ): The locale string
- enabled ( boolean ): The enabled flag
- autodelete ( boolean ): The auto delete flag
- expiryDate ( integer ): The expiry date. Milliseconds since January 1, 1970, 00:00:00 GMT
- password ( string ): The password
-
Security - The security settings
{- encrypt ( boolean ): No description available
- pgpInline ( boolean ): No description available
- sign ( boolean ): No description available
- language ( string ): No description available
- message ( string ): No description available
- pin ( string ): No description available
- msgRef ( string ): No description available
- authentication ( string ): No description available
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
For any types but "new", the response provides ready-to-use values, e.g. to, cc, bcc, subject with prefix, attachments. Internally all mime headers are set properly (a..g to maintain threads). Only the content is still original, i.e. the client uses DOMPurify to sanitize and to quote the content.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type type (empty) One of new/reply/replyall/forward/resend/edit/copy
query string vcard (empty) Attach users vcard
query boolean sharedAttachmentsEnabled (empty) Whether to enable Drive Mail when opening a new composition space
query boolean claim (empty) A unique client token to prevent conflicts due to concurrent editing. Must be a 16-character string consisting of [a-zA-Z0-9] only.
query string Body:
Description:Array of Objects (id, folderId) to reference mails (reply or multiple on forward as example)
Content-type: application/json
Responses:
200:
A JSON object containing the newly created message model.
Content-type: application/json-
MailComposeResponse
{- data ( MailComposeResponseMessageModel ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailComposeResponseMessageModel
{- id ( string ): The identifier
- from ( Address ): Flat array of two strings. First item is display name, second item is email address.
- to ( array[array[string]] ): An array of addresses
- cc ( array[array[string]] ): An array of addresses
- bcc ( array[array[string]] ): An array of addresses
- subject ( string ): The subject
- content ( string ): The text content
-
contentType
(
string
, possibleValues:
text/plain
text/html
- attachments ( array[object] ): An array of attachments
- meta ( Meta ): Object of meta information
- requestReadReceipt ( boolean ): Request read receipt flag
-
priority
(
string
, possibleValues:
low
normal
high
- sharedAttachments ( Shared Attachments ): The shared attachments object
- security ( Security ): The security settings
- customHeaders ( customHeaders ): No description available
- mailPath ( mailPath ): The path to the draft message reflecting composition space
-
Meta - Object of meta information
{-
type
(
string
, possibleValues:
NEW
REPLY
REPLY_ALL
FORWARD_INLINE
FORWARD_ATTACHMENT
RESEND
-
date
(
integer
):
The date we should use for "On 6.6.2018 someone
wrote:". Server decides whether this is sent or received date. Milliseconds since January 1, 1970, 00:00:00 GMT - originalFolderId ( string ): Original folder id during reply or forward
- originalId ( string ): Original message id during reply or forward
-
type
(
string
, possibleValues:
-
Shared Attachments - The shared attachments object
{- language ( string ): The locale string
- enabled ( boolean ): The enabled flag
- autodelete ( boolean ): The auto delete flag
- expiryDate ( integer ): The expiry date. Milliseconds since January 1, 1970, 00:00:00 GMT
- password ( string ): The password
-
Security - The security settings
{- encrypt ( boolean ): No description available
- pgpInline ( boolean ): No description available
- sign ( boolean ): No description available
- language ( string ): No description available
- message ( string ): No description available
- pin ( string ): No description available
- msgRef ( string ): No description available
- authentication ( string ): No description available
-
mailPath - The path to the draft message reflecting composition space
{- id ( string ): The identifier of the draft message
- folderId ( string ): The identifier of the folder in which the draft message resides
400:
Bad request, response contains error message.
401:
Not authorized
-
-
-
Mailfilter
The mailfilter module is used to access all mail filter related options. First of all the main structure of a mail filter script is, that it has different rules. Each of them contains one command. This command takes a test condition which executes the actions given in that command if the test condition is true. The test condition consists of a test command and some arguments for this on the mail filter server, these tests must be determined at runtime. So that no test field is transferred to the server which it isn't able to handle. Examples for tests are `address`, `allof` and `anyof`. Each test has a special comparison. The list of available comparisons depends on the test given and the mail filter server configuration so they have to be determined at runtime too. See chapter Mail filter for more information.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON object describing the rule with the `id` set (which identifies the rule to change). Only modified fields are present.
Content-type: application/json-
MailFilterRule
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTest ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTest
{- test ( MailFilterNotTest ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): Containing the timezone of date or currentdate tests. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTest - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): Containing the timezone of date or currentdate tests. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
A mail filter can have different rules each containing one command. A command has a test condition and actions that are executed if the condition is true. The list of available comparisions (that can be used in test conditions) and the list of available actions depends on a given test and the mail filter server configuration and must be determined at runtime.
All those dynamic values can be fetched via a config object at startup, which shows the capabilities of the server to the client.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
A JSON object with the fields `tests` (containing an array of available test-objects, see Possible tests.) and `actioncommands` (containing an array of valid actions. See Possible action commands). In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterConfigResponse
{- data ( MailFilterConfigData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailFilterConfigData
{- tests ( array[MailFilterConfigTest] ): Array of available test-objects.
- actioncommands ( array[string] ): Array of available action commands.
- capabilities ( array[string] ): Array of supported imap capabilities
-
MailFilterConfigTest
{- test ( string ): The name of the test, see Possible tests.
- comparison ( array[string] ): An array of the valid comparison types for this test, see Possible comparisons.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string folderId (empty) The id of the folder the sieve rule should be applied to. If missing the rule will be applied to the inbox.
query string id (empty) The id of the sieve rule which should be applied.
query integer Responses:
200:
If the script was successfully applied the response contains just an empty array. In case of errors or warnings the array contains a result for each mail which contained an error or a warning. Those results contain further informations about the error or the warning. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterApplyResponse
{- data ( array[object] ): The results per mail
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string folderId (empty) The id of the folder the sieve rule should be applied to. If missing the rule will be applied to the inbox.
query string Body:
Description:A JSON object describing the mail filter rule. If the field `position` is included, it's taken as the position of the rule in the array on the server side (this value shouldn't be greater than the size of all rules).
Content-type: application/json-
MailFilterRulev2
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTestv2 ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTestv2
{- test ( MailFilterNotTestv2 ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTestv2 - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
Responses:
200:
If the script was successfully applied the response contains just an empty array. In case of errors or warnings the array contains a result for each mail which contained an error or a warning. Those results contain further informations about the error or the warning. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterApplyResponse
{- data ( array[object] ): The results per mail
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON object describing the rule with the `id` set (which identifies the rule to change). Only modified fields are present.
Content-type: application/json-
MailFilterRulev2
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTestv2 ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTestv2
{- test ( MailFilterNotTestv2 ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTestv2 - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
This call is only used as workaround for parsing errors in the backend, so that the user is able to get the plaintext of a complete script.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
A JSON object with the text of the complete sieve script. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterScriptResponse
{- data ( string ): The mail filter script.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
This call is only used as workaround for parsing errors in the backend, so that the user is able to get the plaintext of a complete script.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
A JSON object with the text of the complete sieve script. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterScriptResponse
{- data ( string ): The mail filter script.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON array with unique identifiers, which represents how the corresponding rules are order.
Content-type: application/json
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON object with the ID of the rule to delete.
Content-type: application/json-
MailFilterDeletionBody
{- id ( integer ): The ID of the rule that shall be deleted.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON array with unique identifiers, which represents how the corresponding rules are order.
Content-type: application/json
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON object with the ID of the rule to delete.
Content-type: application/json-
MailFilterDeletionBody
{- id ( integer ): The ID of the rule that shall be deleted.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
This call is only used as workaround for parsing errors in the backend, so that the user is able to kick a whole script if it contains errors in the grammar.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type flag (empty) If given, only rules with this flag are returned.
query string username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
A JSON object with an array of rule-objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterRulesResponse
{- data ( array[MailFilterRule] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailFilterRule
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTest ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTest
{- test ( MailFilterNotTest ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): Containing the timezone of date or currentdate tests. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTest - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): Containing the timezone of date or currentdate tests. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type flag (empty) If given, only rules with this flag are returned.
query string username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
A JSON object with an array of rule-objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterRulesResponsev2
{- data ( array[MailFilterRulev2] ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailFilterRulev2
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTestv2 ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTestv2
{- test ( MailFilterNotTestv2 ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTestv2 - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
A mail filter can have different rules each containing one command. A command has a test condition and actions that are executed if the condition is true. The list of available comparisions (that can be used in test conditions) and the list of available actions depends on a given test and the mail filter server configuration and must be determined at runtime.
All those dynamic values can be fetched via a config object at startup, which shows the capabilities of the server to the client.
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
A JSON object with the fields `tests` (containing an array of available test-objects, see Possible tests.) and `actioncommands` (containing an array of valid actions. See Possible action commands). In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterConfigResponsev2
{- data ( MailFilterConfigDatav2 ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MailFilterConfigDatav2
{- tests ( array[MailFilterConfigTestv2] ): Array of available test-objects.
- actioncmds ( array[MailFilterConfigAction] ): Array of available action-objects.
- options ( Options ): A options object containing additional information for the client.
-
MailFilterConfigTestv2
{- id ( string ): The name of the test, see Possible tests and Simplified tests.
- comparisons ( array[string] ): An array of the valid comparison types for this test, see Possible comparisons.
- headers ( array[string] ): An array of valid headers for the envelope and address tests.
- parts ( array[string] ): An array of valid address parts for the envelope and address tests.
-
Options - A options object containing additional information for the client.
{- allowNestedTests ( boolean ): Defines if nested rules should be allowed by the client or not.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
This call is only used as workaround for parsing errors in the backend, so that the user is able to kick a whole script if it contains errors in the grammar.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_mail
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON object describing the mail filter rule. If the field `position` is included, it's taken as the position of the rule in the array on the server side (this value shouldn't be greater than the size of all rules).
Content-type: application/json-
MailFilterRulev2
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTestv2 ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTestv2
{- test ( MailFilterNotTestv2 ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTestv2 - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests and Simplified tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): The timezone which should be used for a date or currentdate test. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
Responses:
200:
A JSON object containing the ID of the newly created rule. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterCreationResponse
{- data ( integer ): The id of the newly created rule.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type username (empty) Must contain the user name for **admin mode**. So the normal credentials are taken for authentication but the mail filter of the user with this username is being changed.
query string Body:
Description:A JSON object describing the mail filter rule. If the field `position` is included, it's taken as the position of the rule in the array on the server side (this value shouldn't be greater than the size of all rules).
Content-type: application/json-
MailFilterRule
{- id ( integer ): A unique identifier of the rule (once created must not be changed).
- position ( integer ): The position inside the mail filter list (starts with 0).
- rulename ( string ): A name describing the rule, can be empty but must not contain a line break.
- active ( boolean ): If this rule is active or not.
- flags ( array[string] ): An array containing flags which are set on this rule. Each flag can only contain the following characters: 1-9 a-z A-Z. Currently 3 flags are reserved here: "spam" which marks the default spam rule, "vacation" which marks the vacation rules and "autoforward" which marks an autoforwarding rule.
- test ( MailFilterTest ): No description available
- actioncmds ( array[MailFilterAction] ): An array of action commands.
- text ( string , read only ): If this rule cannot be read in this string is filled containing the whole lines of this command.
- errormsg ( string , read only ): If this rule cannot be read in this string is filled containing a message why, or what part of the rule isn't known.
-
MailFilterTest
{- test ( MailFilterNotTest ): A test object which result will be negated.
- id ( string ): The name of the test command, see Possible tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): Containing the timezone of date or currentdate tests. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterNotTest - A test object which result will be negated.
{- id ( string ): The name of the test command, see Possible tests.
- comparison ( string ): The comparison type, see Possible comparisons.
- addresspart ( string ): The addresspart which shall be used for envelope or address tests, see Possible address parts.
- headers ( array[string] ): An array containing the header fields (for address-, envelope-, exists- and header-test).
- header ( string ): The header field of the date test.
- values ( array[string] ): An array containing the value for the header fields or the values for the body. The test will be true if any of the strings matches (for address-, envelope-, header-test and body-test).
- size ( integer ): The size in bytes (for size-test).
- datepart ( string ): Type of the comparison, which can be "date", "weekday" or "time" (for currentdate-test).
- datevalue ( array[integer] ): Contains the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 (sunday) to 6 (saturday) reflecting the equivalent weekday (for currentdate-test).
- zone ( string ): Containing the timezone of date or currentdate tests. E.g. "+0100". If omitted the current timezone of the user is used.
- extensionskey ( string ): The extension key (for body-test).
- extensionsvalue ( string ): A value for the given key. If the key has no value the value given here is ignored (for body-test).
-
MailFilterAction
{- id ( string ): A string defining the object itself (e.g. "keep" or "discard").
- to ( string ): A string containing where the mail should be redirected to (for redirect-command).
- into ( string ): This string takes the object id of the destination mail folder (for move-command).
- text ( string ): A string containing the reason why the mail is rejected (for reject-command) or a string containing the vacation text itself (for vacation-command).
- days ( string ): The days for which a vacation text is returned (for vacation-command).
- addresses ( array[string] ): The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent.
-
from
(
from
):
Support for the ":from" tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear
. The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. (for vacation-command) - subject ( string ): The new subject for the returned message (can be left empty, when only adding RE:) (for vacation-command).
- flags ( array[string] ): An array containing the flags which should be added or set to a mail. A flag can either be a system flag or a user flag. System flags begin with a backslash and can be: "seen", "answered", "flagged", "deleted", "draft" or "recent". User flags begin with a dollar sign and can contain any ASCII characters between 0x21 ("!") and 0x7E ("~") (inclusive), except for 0x22 ("), 0x25 (%), 0x28 ((), 0x29 ()), 0x2A (*), 0x5C (backslash), 0x5D (]) and 0x7B ({). Mail color flags as used by OX are implemented by user flags of the form `$cl_n`, where "n" is a number between 1 and 10 (inclusive). (for addflags- and setflags-command)
- message ( string ): The content of the notification message (for notify-command).
- method ( string ): The method of the notification message, eg. `mailto:012345678@sms.gateway` (for notify-command).
- keys ( array[string] ): The public keys which should be used for encryption (for pgp-command).
- copy ( boolean ): An optional boolean flag indicating whether a copy tag should be added to the fileinto or redirect command or not.
Responses:
200:
A JSON object containing the ID of the newly created rule. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MailFilterCreationResponse
{- data ( integer ): The id of the newly created rule.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Messaging
The messaging module is divided into services which represent a messaging backend (they add a new folder module "messaging"), into accounts which represent the concrete configuration of accounts for a given messaging service, and into messages which represent single messages consisting of some metadata, headers and a content.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type recipients (empty) A list of recipients as defined in RFC822, like "Joe Doe
". If set the message is sent to the given list of recipients, otherwise this defaults to the "To" header of the message. query string Body:
Description:A JSON array of JSON arrays with the folder and ID as elements each identifying a message.
Content-type: spplication/json-
MessageDataBody
{- id ( string ): The ID of the message. Only unique in the given folder.
- folder ( string ): The folder ID.
- threadLevel ( integer ): The nesting level of this message according to the conversation it's belonged to. May not be set.
- flags ( integer ): Bitmask showing the state of this message. The same as in the module mail.
- receivedDate ( integer , read only ): The time this message was received.
- colorLabel ( integer ): An arbitrary number marking the message in a certain color. The same as the color label common to all groupware objects.
- user ( array[string] ): An array of strings representing user flags.
- size ( integer ): The size of the message in bytes.
- picture ( string ): The URL to a picture for this message.
- url ( string ): A link to the messages origin currently used in RSS messages.
- sectionId ( string ): The section ID of a certain message part, if the content-type is `multipart/*`.
- headers ( headers ): A JSON object of header data. Usually the value is either a string or an array (if it has more than one value). Certain headers are rendered as more complex structures.
- body ( body ): A JSON object representing the content of the message.
Responses:
200:
A JSON object containing the number 1 if message could be sent. In case of errors the responsible fields in the response are filled (see Error handling.
Content-type: application/json-
MessagingMessageUpdateResponse
{- data ( integer ): The response value.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type messagingService (empty) The messaging service ID that the account belongs to.
query string id (empty) The messaging account ID.
query integer Responses:
200:
A JSON object containing the number 1 if deletion was successful. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingAccountUpdateResponse
{- data ( integer ): The response value.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of column names, like "folder,headers,body". See Messaging fields for valid column names.
query string folder (empty) The folder ID, like "com.openexchange.messaging.twitter://535/defaultTimeline/directMessages".
query string sort (empty) A column name to sort by.
query string order (empty) The order direction which can be "asc" for ascending (default) or "desc" for descending.
query string Responses:
200:
A JSON object containing an array with data for all messages. Each array element describes one message and is itself an array. The elements of each array contain the information specified by the corresponding column names in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingMessagesResponse
{- data ( data ): Array of messages. Each message is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type messagingService (empty) The messaging service ID that the account belongs to.
query string id (empty) The messaging account ID.
query integer Responses:
200:
A JSON object containing the data of the requested account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingAccountResponse
{- data ( MessagingAccountData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MessagingAccountData
{- id ( integer ): Identifier of the messaging account.
- messagingService ( string ): The messaging service ID of the messaging service this account belongs to.
- displayName ( string ): User chosen string to identify a given account. Will also be translated into the folder name of the folder representing the accounts content.
- configuration ( configuration ): The configuration data according to the `formDescription` of the relevant messaging service.
-
-
On actions of type "message" the body should contain the JSON representation of the message the action should be applied to. To invoke a messaging action of type "storage" the folder and id are needed in URL parameters. Messaging actions of type "none" need a messaging message and account.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type messageAction (empty) The message action to invoke.
query string id (empty) The ID of the message the action shall be invoked on. Only used on actions of type "storage".
query string folder (empty) The folder ID of the message. Only used on actions of type "storage".
query string account (empty) The account ID. Only used on actions of type "none".
query integer Body:
Description:A JSON array of JSON arrays with the folder and ID as elements each identifying a message.
Content-type: spplication/json-
MessageDataBody
{- id ( string ): The ID of the message. Only unique in the given folder.
- folder ( string ): The folder ID.
- threadLevel ( integer ): The nesting level of this message according to the conversation it's belonged to. May not be set.
- flags ( integer ): Bitmask showing the state of this message. The same as in the module mail.
- receivedDate ( integer , read only ): The time this message was received.
- colorLabel ( integer ): An arbitrary number marking the message in a certain color. The same as the color label common to all groupware objects.
- user ( array[string] ): An array of strings representing user flags.
- size ( integer ): The size of the message in bytes.
- picture ( string ): The URL to a picture for this message.
- url ( string ): A link to the messages origin currently used in RSS messages.
- sectionId ( string ): The section ID of a certain message part, if the content-type is `multipart/*`.
- headers ( headers ): A JSON object of header data. Usually the value is either a string or an array (if it has more than one value). Certain headers are rendered as more complex structures.
- body ( body ): A JSON object representing the content of the message.
Responses:
200:
A JSON object containing the number 1 if message could be sent. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingMessageUpdateResponse
{- data ( integer ): The response value.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array of messaging service objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingServicesResponse
{- data ( array[MessagingServiceData] ): An array containing JSON objects representing messaging services.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MessagingServiceData
{- id ( string ): The identifier of the messaging service. This is usually a string in reverse domain name notation, like "com.openexchange.messaging.twitter".
- displayName ( string ): Human-readable display name of the service.
- formDescription ( array[MessagingFormDescription] ): An array of dynamic form fields. Same as in PubSub.
- messagingActions ( array[string] ): An array representing a dynamic set of actions that are possible with messages of this service.
-
MessagingFormDescription
{- widget ( string ): The name of the widget.
- name ( string ): The name of the field.
- displayName ( string ): The display name of the field.
- mandatory ( boolean ): Indicates whether the field is mandatory.
- options ( options ): A list of available options in the field.
- defaultValue ( defaultValue ): Can contain a default value.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the modified data of the account. The fields `id` and `messagingService` must always be set.
Content-type: application/json-
MessagingAccountData
{- id ( integer ): Identifier of the messaging account.
- messagingService ( string ): The messaging service ID of the messaging service this account belongs to.
- displayName ( string ): User chosen string to identify a given account. Will also be translated into the folder name of the folder representing the accounts content.
- configuration ( configuration ): The configuration data according to the `formDescription` of the relevant messaging service.
Responses:
200:
A JSON object containing the number 1 if update was successful. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingAccountUpdateResponse
{- data ( integer ): The response value.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object describing the account to create. The ID is generated by the server and must not be present.
Content-type: application/json-
MessagingAccountData
{- id ( integer ): Identifier of the messaging account.
- messagingService ( string ): The messaging service ID of the messaging service this account belongs to.
- displayName ( string ): User chosen string to identify a given account. Will also be translated into the folder name of the folder representing the accounts content.
- configuration ( configuration ): The configuration data according to the `formDescription` of the relevant messaging service.
Responses:
200:
A JSON object containing the ID of the newly created account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingAccountUpdateResponse
{- data ( integer ): The response value.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type messagingService (empty) List only those accounts that belong to the given `messagingService`.
query string Responses:
200:
A JSON object containing an array with account objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingAccountsResponse
{- data ( array[MessagingAccountData] ): An array containing JSON objects representing messaging accounts.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MessagingAccountData
{- id ( integer ): Identifier of the messaging account.
- messagingService ( string ): The messaging service ID of the messaging service this account belongs to.
- displayName ( string ): User chosen string to identify a given account. Will also be translated into the folder name of the folder representing the accounts content.
- configuration ( configuration ): The configuration data according to the `formDescription` of the relevant messaging service.
-
-
A messaging message consists of some metadata, headers and a content. The content attribute varies by the content-type header. If the content-type is
text/*
it is a string, if it ismultipart/*
it is an array of objects, each representing a part of the multipart. If it is anything else it is considered binary and is a Base64 encoded string.The folder ID of a message follows a predefined format:
[messagingService]://[accountId]/[path]
, likecom.openexchange.messaging.twitter://535/defaultTimeline/directMessages
.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the message to load.
query string folder (empty) The folder ID of the message.
query string peek (empty) If set to `true` the read/unread state of the message will not change. Default is `false`.
query boolean Responses:
200:
A JSON object containing the data of the message. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingMessageResponse
{- data ( MessageDataBody ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MessageDataBody
{- id ( string ): The ID of the message. Only unique in the given folder.
- folder ( string ): The folder ID.
- threadLevel ( integer ): The nesting level of this message according to the conversation it's belonged to. May not be set.
- flags ( integer ): Bitmask showing the state of this message. The same as in the module mail.
- receivedDate ( integer , read only ): The time this message was received.
- colorLabel ( integer ): An arbitrary number marking the message in a certain color. The same as the color label common to all groupware objects.
- user ( array[string] ): An array of strings representing user flags.
- size ( integer ): The size of the message in bytes.
- picture ( string ): The URL to a picture for this message.
- url ( string ): A link to the messages origin currently used in RSS messages.
- sectionId ( string ): The section ID of a certain message part, if the content-type is `multipart/*`.
- headers ( headers ): A JSON object of header data. Usually the value is either a string or an array (if it has more than one value). Certain headers are rendered as more complex structures.
- body ( body ): A JSON object representing the content of the message.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of column names, like "folder,headers,body". See Messaging fields for valid column names.
query string Body:
Description:A JSON array of JSON arrays with the folder and ID as elements each identifying a message.
Content-type: application/json
Responses:
200:
A JSON object containing an array with data for requested messages. Each array element describes one message and is itself an array. The elements of each array contain the information specified by the corresponding column names in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingMessagesResponse
{- data ( data ): Array of messages. Each message is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the messaging service to load.
query string Responses:
200:
A JSON object containing the data of the messaging service. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MessagingServiceResponse
{- data ( MessagingServiceData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MessagingServiceData
{- id ( string ): The identifier of the messaging service. This is usually a string in reverse domain name notation, like "com.openexchange.messaging.twitter".
- displayName ( string ): Human-readable display name of the service.
- formDescription ( array[MessagingFormDescription] ): An array of dynamic form fields. Same as in PubSub.
- messagingActions ( array[string] ): An array representing a dynamic set of actions that are possible with messages of this service.
-
MessagingFormDescription
{- widget ( string ): The name of the widget.
- name ( string ): The name of the field.
- displayName ( string ): The display name of the field.
- mandatory ( boolean ): Indicates whether the field is mandatory.
- options ( options ): A list of available options in the field.
- defaultValue ( defaultValue ): Can contain a default value.
-
-
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type providerName (empty) The name of the multifactor provider
query string deviceId (empty) The ID of the multifactor device
query string Body:
Description:The information required to finish the registration of a new multifactor device.
Content-type: application/json-
MultifactorFinishAuthenticationData - The provider specific parameters required for authentication.
{- secret_code ( string ): (SMS, TOTP, BACKUP_STRING provider only) The secret authentication token.
- clientData ( string ): (U2F provider only) The U2F client data.
- keyHandle ( string ): (U2F provider only) The U2F key handle.
- signatureData ( string ): (U2F provider only) The signed U2F challenge.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type providers (empty) A comma separated list of provider names to return. Omit to return all available providers.
query string Responses:
200:
A JSON object containing the result of the operation. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultifactorProvidersResponse
{- data ( array[MultifactorProvider] ): An array of providers.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MultifactorProvider
{- name ( string ): The name of the provider
- backupProvider ( boolean ): true, if the provider can act as "backup"-provider, false otherwise.
- backupOnlyProvider ( boolean ): true, if the provider can ONLY act as "backup"-provider, false otherwise.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A device which should be registered as new multifactor device.
Content-type: application/json-
MultifactorDevice
{- id ( string ): The unique ID of the device
- name ( string ): The user friendly name of the device
- backup ( boolean ): true, if the device is a "backup" device, false otherwise
- enabled ( boolean , read only ): true, if the device is enabled, false otherwise
- providerName ( string ): The name of the device's provider
- parameters ( parameters , read only ): The provider specific parameters required for starting a new registration.
-
parameters - The provider specific parameters required for starting a new registration.
{- phoneNumber ( string ): (SMS provider only) The phone number of the SMS device to register
Responses:
200:
A JSON object containing necessary information required to finish the registration process. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultifactorStartRegistrationResponse
{- data ( data ): Registration response data
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data - Registration response data
{- deviceId ( string ): A unique ID of the new device
- challenge ( challenge ): A challenge required to be solved for registering a new device
-
challenge - A challenge required to be solved for registering a new device
{- sharedSecret ( string ): (TOTP, BACKUP_STRING provider only) The TOTP secret
- base64Image ( string ): (TOTP provider only) A base64 encoded QR-Code containing all relevant information for setting up TOTP.
- url ( string ): (TOTP provider only) An URL containing all relevant information for setting up TOTP.
- requestId ( string ): (U2F provider only) The unique U2F request ID.
- registerRequests ( array[object] ): A list of challenge data
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type providerName (empty) The name of the multifactor provider
query string Body:
Description:A device containing the device ID, and the new name.
Content-type: application/json-
MultifactorDevice
{- id ( string ): The unique ID of the device
- name ( string ): The user friendly name of the device
- backup ( boolean ): true, if the device is a "backup" device, false otherwise
- enabled ( boolean , read only ): true, if the device is enabled, false otherwise
- providerName ( string ): The name of the device's provider
- parameters ( parameters , read only ): The provider specific parameters required for starting a new registration.
-
parameters - The provider specific parameters required for starting a new registration.
{- phoneNumber ( string ): (SMS provider only) The phone number of the SMS device to register
Responses:
200:
A dev
Content-type: application/json-
MultifactorDeviceResponse
{- data ( MultifactorDevice ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type providerName (empty) The name of the multifactor provider
query string deviceId (empty) The ID of the multifactor device
query string Body:
Description:The information required to finish the registration of a new multifactor device.
Content-type: application/json-
MultifactorFinishRegistrationData - The provider specific parameters required to finish a device registration.
{- secret_code ( string ): (SMS, TOTP provider only) The secret token required to finish the registration.
- clientData ( string ): (U2F provider only) The U2F client data required to finish the registration.
- registrationData ( string ): (U2F provider only) The U2F registration data data required to finish the registration.
Responses:
200:
A JSON object containing all device IDs deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultifactorFinishRegistrationResponse
{- data ( MultifactorDevice ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MultifactorDevice
{- id ( string ): The unique ID of the device
- name ( string ): The user friendly name of the device
- backup ( boolean ): true, if the device is a "backup" device, false otherwise
- enabled ( boolean , read only ): true, if the device is enabled, false otherwise
- providerName ( string ): The name of the device's provider
- parameters ( parameters , read only ): The provider specific parameters required for starting a new registration.
-
parameters - The provider specific parameters required for starting a new registration.
{- phoneNumber ( string ): (SMS provider only) The phone number of the SMS device to register
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type providerName (empty) The name of the multifactor provider
query string deviceId (empty) The ID of the multifactor device
query string Responses:
200:
A JSON object containing necessary information required to finish the authentication process. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultifactorStartAuthenticationResponse
{- data ( data ): Authentication response data
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data - Authentication response data
{- challenge ( challenge ): A challenge required to be solved for authentication
-
challenge - A challenge required to be solved for authentication
{- phoneNumberTail ( string ): (SMS provider only) The last digits of the phone number where the secret token was sent to
- backupStringLength ( integer ): (BACKUP_STRING provider only) The length of the secret token required for authentication
- requestId ( string ): (U2F provider only) The U2F request ID
- signRequests ( array[object] ): (U2F provider only) A list of U2F challenges which needs to be solved for authentication
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type providerName (empty) The name of the multifactor provider
query string deviceId (empty) The ID of the multifactor device
query string Responses:
200:
A JSON object containing all device IDs deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultifactorDeleteResponse
{- data ( array[string] ): Array of device IDs which where deleted.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the result of the operation. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
MultifactorDevicesResponse
{- data ( array[MultifactorDevice] ): Array of multifactor devices.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
MultifactorDevice
{- id ( string ): The unique ID of the device
- name ( string ): The user friendly name of the device
- backup ( boolean ): true, if the device is a "backup" device, false otherwise
- enabled ( boolean , read only ): true, if the device is enabled, false otherwise
- providerName ( string ): The name of the device's provider
- parameters ( parameters , read only ): The provider specific parameters required for starting a new registration.
-
parameters - The provider specific parameters required for starting a new registration.
{- phoneNumber ( string ): (SMS provider only) The phone number of the SMS device to register
-
-
-
Multiple
The multiple module allows to bundle multiple requests to most other modules in a single request.-
Not supported requests are:
- the ones from modules login and multiple
- POST requests with a multipart encoding (uploads)
- GET requests which do not use an object as described in Low level protocol
Request body
A JSON array with JSON objects describing the requests. Each object contains a field
module
with the name of the request's module and the fieldaction
with the concrete request action to execute. Additionally the parameters of the request are added as fields too. A session parameter is not included! If the request has a request body itself, this body is stored as a JSON object in a fielddata
.Example: query reminder range and update a reminder's alarm
[{"module":"reminder","action":"range","end":1497461067180},{"module":"reminder","action":"remindAgain","id":51,"data":{"alarm":1459478800000}}]
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type continue (empty) Specifies whether processing of requests should stop when an error occurs, or whether all request should be processed regardless of errors.
query boolean Body:
Description:A JSON array with JSON objects, each describing one request.
Content-type: application/json-
SingleRequest - Contains all currently available (resp. possible) parameters that could be specified to perform a request in the multiple module except `action`, `module`, and `data` which are part of the actual request itself.
{- module ( string , required ): The name of the request's module like "mail", "folders", etc.
- action ( string , required ): The name of the request's action like "all", "list", etc.
- data ( data ): The request's body as a JSON object.
- columns ( string ): The "columns" parameter of a request.
- tree ( string ): The "tree" parameter of a request.
- allowed_modules ( string ): The "allowed_modules" parameter of a request.
- parent ( string ): The "parent" parameter of a request.
- all ( integer ): The "all" parameter of a request.
- errorOnDuplicateName ( boolean ): The "errorOnDuplicateName" parameter of a request.
- id ( string ): The "id" parameter of a request.
- timestamp ( integer ): The "timestamp" parameter of a request.
- ignore ( string ): The "ignore" parameter of a request.
- cascadePermissions ( string ): The "cascadePermissions" parameter of a request.
- hardDelete ( boolean ): The "hardDelete" parameter of a request.
- content_type ( string ): The "content_type" parameter of a request.
- sort ( string ): The "sort" parameter of a request.
- order ( string ): The "order" parameter of a request.
- folder ( string ): The "folder" parameter of a request.
- start ( integer ): The "start" parameter of a request.
- end ( integer ): The "end" parameter of a request.
- email ( string ): The "email" parameter of a request.
- query ( string ): The "query" parameter of a request.
- left_hand_limit ( integer ): The "left_hand_limit" parameter of a request.
- right_hand_limit ( integer ): The "right_hand_limit" parameter of a request.
- recurrence_master ( boolean ): The "recurrence_master" parameter of a request.
- showPrivate ( boolean ): The "showPrivate" parameter of a request.
- occurrence ( string ): The "occurrence" parameter of a request.
- type ( integer ): The "type" parameter of a request.
- limit ( integer ): The "limit" parameter of a request.
- uid ( string ): The "uid" parameter of a request.
- includeSent ( boolean ): The "includeSent" parameter of a request.
- headers ( string ): The "headers" parameter of a request.
- message_id ( string ): The "message_id" parameter of a request.
- edit ( integer ): The "edit" parameter of a request.
- hdr ( integer ): The "hdr" parameter of a request.
- src ( integer ): The "src" parameter of a request.
- save ( integer ): The "save" parameter of a request.
- view ( string ): The "view" parameter of a request.
- unseen ( boolean ): The "unseen" parameter of a request.
- max_size ( integer ): The "max_size" parameter of a request.
- attach_src ( boolean ): The "attach_src" parameter of a request.
- attachment ( string ): The "attachment" parameter of a request.
- cid ( string ): The "cid" parameter of a request.
- filter ( integer ): The "filter" parameter of a request.
- lineWrapAfter ( integer ): The "lineWrapAfter" parameter of a request.
- flags ( integer ): The "falgs" parameter of a request.
- force ( boolean ): The "force" parameter of a request.
- setFrom ( boolean ): The "setFrom" parameter of a request.
- version ( integer ): The "version" parameter of a request.
- recursive ( string ): The "recursive" parameter of a request.
- diff ( integer ): The "diff" parameter of a request.
- attached ( integer ): The "attached" parameter of a request.
- accountId ( integer ): The "accountId" parameter of a request.
- password ( string ): The "password" parameter of a request.
- force_secure ( string ): The "force_secure" parameter of a request.
- name ( string ): The "name" parameter of a request.
- setIfAbsent ( string ): The "setIfAbsent" parameter of a request.
- serviceId ( string ): The "serviceId" parameter of a request.
- oauth_token ( string ): The "oauth_token" parameter of a request.
- uuid ( string ): The "uuid" parameter of a request.
- oauth_verifier ( string ): The "oauth_verifier" parameter of a request.
- displayName ( string ): The "displayName" parameter of a request.
- client ( string ): The "client" parameter of a request.
- participant ( string ): The "participant" parameter of a request.
- from ( integer ): The "from" parameter of a request.
- until ( integer ): The "until" parameter of a request.
- merged ( boolean ): The "merged" parameter of a request.
- messagingService ( string ): The "messagingService" parameter of a request.
- peek ( string ): The "peek" parameter of a request.
- recipients ( string ): The "recipients" parameter of a request.
- messageAction ( string ): The "messageAction" parameter of a request.
- attachmentid ( string ): The "attachmentid" parameter of a request.
- provider ( string ): The "provider" parameter of a request.
- timezone ( string ): The "timezone" parameter of a request.
- internal_userid ( integer ): The "internal_userid" parameter of a request.
- userid ( integer ): The "userid" parameter of a request.
- user_id ( integer ): The "user_id" parameter of a request.
- email1 ( string ): The "email1" parameter of a request.
- email2 ( string ): The "email2" parameter of a request.
- email3 ( string ): The "email3" parameter of a request.
- system ( string ): The "system" parameter of a request.
- filestorageService ( string ): The "filestorageService" parameter of a request.
Responses:
200:
A JSON array containing the response data of the processed requests where response[0] corresponds to request[0], response[1] to request[1], and so on.
Content-type: application/json-
MultipleResponse
{- data ( data ): An array of the data of the requests that was processed with the multiple module.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
400:
Syntactically incorrect request.
-
-
OAuth
The Open-Xchange server can act as an OAuth client or be an OAuth provider itself. The OAuth module supports both aspects: * Manage multiple OAuth accounts for certain online services for a user. The OAuth mechanism allows the Open-Xchange application to act as behalf of this user using previously obtained access tokens granted by user. The according interface is divided into two parts: Account access and service's meta data access. * Manage granted accesses of external services that can access a users data on his behalf, called "grants".-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array of JSON objects each describing a granted access. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthGrantsResponse
{- data ( array[OAuthGrantData] ): An array containing one object for every granted access.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthGrantData
{- client ( OAuthClientData ): No description available
- scopes ( scopes ): A mapping from scope tokens to translated, human-readable descriptions for every scope that was granted to the external service (example: {"read_contacts":"See all your contacts"}).
- date ( integer ): The time when the access was granted.
-
OAuthClientData
{- id ( string ): The client's ID.
- name ( string ): The client's/service's name.
- description ( string ): A description of the client.
- website ( string ): A URL to the client's website.
- icon ( string ): A URL or path to obtain the client's icon via the image module.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array of JSON objects each describing an OAuth service's meta data. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthServicesResponse
{- data ( array[OAuthServiceMetaData] ): An array with OAuth service meta data.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthServiceMetaData
{- id ( string ): The identifier of the service meta data, e.g. "com.openexchange.oauth.twitter".
- displayName ( string ): The service's display name.
- availableScopes ( array[string] ): The available scopes for the OAuth provider
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type serviceId (empty) The service meta data identifier. If missing all accounts of all services are returned; otherwise all accounts of specified service are returned.
query string Responses:
200:
A JSON object containing an array of JSON objects each describing an OAuth account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthAccountsResponse
{- data ( array[OAuthAccountData] ): An array of OAuth account objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthAccountData
{- id ( integer ): The numeric identifier of the OAuth account.
- displayName ( string ): The account's display name.
- serviceId ( string ): The identifier of the associated service meta data, e.g. "com.openexchange.oauth.twitter".
- token ( string ): The token.
- secret ( string ): The token secret.
- enabledScopes ( array[string] ): The enabled scopes for this OAuth account
- availableScopes ( array[string] , read only ): The available scopes for the OAuth provider of this OAuth account
- associations ( array[object] , read only ): The account associations of the OAuth account.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type client (empty) The ID of the client whose access shall be revoked.
query string Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The account identifier. May also be provided in request body's JSON object by field `id`.
query integer Body:
Description:A JSON object providing the OAuth account data to update. Currently the only values which make sense being updated are `displayName` and the `token`-`secret`-pair.
Content-type: application/json-
OAuthAccountData
{- id ( integer ): The numeric identifier of the OAuth account.
- displayName ( string ): The account's display name.
- serviceId ( string ): The identifier of the associated service meta data, e.g. "com.openexchange.oauth.twitter".
- token ( string ): The token.
- secret ( string ): The token secret.
- enabledScopes ( array[string] ): The enabled scopes for this OAuth account
- availableScopes ( array[string] , read only ): The available scopes for the OAuth provider of this OAuth account
- associations ( array[object] , read only ): The account associations of the OAuth account.
Responses:
200:
A JSON object indicating whether the update was successful. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthAccountUpdateResponse
{- data ( boolean ): Indicates whether the the account was updated successfully.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
This action is typically called by provided call-back URL and is only intended for manual invocation if "outOfBand" interaction is returned by preceeding /oauth/account?action=init step.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type oauth_token (empty) The request token from preceeding OAuth interaction.
query string uuid (empty) The UUID of the preceeding OAuth interaction.
query string displayName (empty) The display name for the new account.
query string oauth_verifier (empty) The verifier string which confirms that user granted access.
query string scopes (empty) A space-separated list of scopes to be added. Valid scopes are 'calendar', 'contacts', 'mail', 'drive', 'generic'. Note that not all scopes are applicable to every OAuth provider.
query string Responses:
200:
A JSON object containing the newly created OAuth account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthAccountResponse
{- data ( OAuthAccountData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthAccountData
{- id ( integer ): The numeric identifier of the OAuth account.
- displayName ( string ): The account's display name.
- serviceId ( string ): The identifier of the associated service meta data, e.g. "com.openexchange.oauth.twitter".
- token ( string ): The token.
- secret ( string ): The token secret.
- enabledScopes ( array[string] ): The enabled scopes for this OAuth account
- availableScopes ( array[string] , read only ): The available scopes for the OAuth provider of this OAuth account
- associations ( array[object] , read only ): The account associations of the OAuth account.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The account identifier.
query integer Responses:
200:
A JSON object indicating whether the deletion was successful. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthAccountDeletionResponse
{- data ( boolean ): Indicates whether the the account was deleted successfully.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type serviceId (empty) The service meta data identifier, e.g. "com.openexchange.oauth.twitter".
query string displayName (empty) The display name of the account.
query string scopes (empty) A space-separated list of scopes to be added. Valid scopes are 'calendar', 'contacts', 'mail', 'drive', 'generic'. Note that not all scopes are applicable to every OAuth provider.
query string Responses:
200:
A JSON object containing the resulting interaction providing information to complete account creation. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthAccountInteractionResponse
{- data ( OAuthAccountInteraction ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthAccountInteraction
{- authUrl ( string ): The numeric identifier of the OAuth account.
- type ( string ): The interaction type name, which can be "outOfBand" or "callback".
- token ( string ): The token.
- uuid ( string ): The UUID for this OAuth interaction.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The account identifier.
query integer Responses:
200:
A JSON object containing the data of the OAuth account. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthAccountResponse
{- data ( OAuthAccountData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthAccountData
{- id ( integer ): The numeric identifier of the OAuth account.
- displayName ( string ): The account's display name.
- serviceId ( string ): The identifier of the associated service meta data, e.g. "com.openexchange.oauth.twitter".
- token ( string ): The token.
- secret ( string ): The token secret.
- enabledScopes ( array[string] ): The enabled scopes for this OAuth account
- availableScopes ( array[string] , read only ): The available scopes for the OAuth provider of this OAuth account
- associations ( array[object] , read only ): The account associations of the OAuth account.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The service's identifier.
query string Responses:
200:
A JSON object containing the meta data of the OAuth service. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
OAuthServiceResponse
{- data ( OAuthServiceMetaData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
OAuthServiceMetaData
{- id ( string ): The identifier of the service meta data, e.g. "com.openexchange.oauth.twitter".
- displayName ( string ): The service's display name.
- availableScopes ( array[string] ): The available scopes for the OAuth provider
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The account identifier. May also be provided in request body's JSON object by field `id`.
query integer serviceId (empty) The service meta data identifier, e.g. "com.openexchange.oauth.twitter".
query string scopes (empty) A space-separated list of scopes to be added. Valid scopes are 'calendar', 'contacts', 'mail', 'drive', 'generic'. Note that not all scopes are applicable to every OAuth provider.
query string Responses:
200:
The boolean value true if the account was successfully re-authorised.
-
-
OpenID
This module supports the Single Sign On mechanism known as OpenId and therefore a few requests are needed to initiate an authentication and trigger the end of the session.-
The logout request will terminate everx session for the current user and redirect him to the configured after logout page.
Parameters:
Parameter Value Description Parameter Type Data Type state (empty) The state which started the logout process.
query string Responses:
302:
A redirect to the after logout page.
-
The init request is used to initiate communication with the OpenID module from a UI client. It may be used to login or logout a user or to initiate the authorization process from a third party.
Parameters:
Parameter Value Description Parameter Type Data Type hash (empty) The hash value from where the request was triggered for later deeplink purposes.
query string version (empty) The client version.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
init_get_reqBody
{- flow ( string , required ): One of the three following strings can be used, {login, logout, thirdParty}. Either one will start the corresponding process in the OpenID module.
- redirect ( boolean , required ): Describes wether the response will be in form of a redirect or an URL placed in a 'redirect' parameter in a JSON body.
- client ( string ): The client identifier.
Responses:
200:
A JSON object containing the redirect URL in an own 'redirect' parameter.
Content-type: application/json-
InitResponse
{- redirect ( string ): The location where to redirect the user to.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
302:
A redirect to the OpenID provider for user authentication.
-
-
The init request as a POST is for thirdParty flow only. Will directly inititate the login process.
Parameters:
Parameter Value Description Parameter Type Data Type hash (empty) The hash value from where the request was triggered for later deeplink purposes.
query string version (empty) The client version.
query string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
init_put_reqBody
{- flow ( string , required ): Only 'thirdParty' as value possible.
- redirect ( boolean , required ): Describes wether the response will be in form of a redirect or an URL placed in a 'redirect' parameter in a JSON body.
- client ( string ): The client identifier.
Responses:
200:
A JSON object containing the redirect URL in an own 'redirect' parameter.
Content-type: application/json-
InitResponse
{- redirect ( string ): The location where to redirect the user to.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
302:
A redirect to the OpenID provider for user authentication.
-
-
-
Passwordchange
Via the passwordchange module the users can change their password.-
Note
The new password will be set without any checks. The client must ensure that it is the password the user wants to set.
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the old and the new password.
Content-type: application/json-
PasswordChangeBody
{- old_password ( string ): The user's current password or `null` if the password wasn't set before (especially for guest users).
- new_password ( string ): The new password the user wants to set or `null` to remove the password (especially for guest users).
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Pns
The interface to add/remove notification subscriptions associated with a token for certain topics-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object describing the subscription
Content-type: application/x-www-form-urlencoded-
SubscriptionData
{- client ( string ): The client identifier; e.g. "open-xchange-appsuite". If not specified, session-associated client identifier is considered
- token ( string , required ): The token to use when sending out notifications using specified transport
- transport ( string , required ): The identifer of the transport; currently supported: - "apn" - "fcm" - "wns" and - "websocket" The 'gcm' transport was deprecated and superseded by 'fcm'. If 'gcm' is supplied, a warning will be returned to the client. The subscription request will go through but with the new 'fcm' transport id.
- topics ( array[string] , required ): An array of topic identifiers or wild-cards, to which the subscription signals interest. E.g. ["ox:mail:*","ox:calendar:new"] interest for all mail-related events and for newly created appointments
Responses:
200:
A JSON object signaling success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
PnsResponse
{- data ( PnsData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
PnsData
{- success ( boolean ): The flag signaling success
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object describing the subscription to remove
Content-type: application/x-www-form-urlencoded-
UnsubscriptionData
{- client ( string ): The client identifier; e.g. "open-xchange-appsuite". If not specified, session-associated client identifier is considered
- token ( string , required ): The token to use when sending out notifications using specified transport
- transport ( string , required ): The identifer of the transport; currently supported: - "apn" - "fcm" - "wns" and - "websocket" The 'gcm' transport was deprecated and superseded by 'fcm'. If 'gcm' is supplied, a warning will be returned to the client. The subscription request will go through but with the new 'fcm' transport id.
Responses:
200:
A JSON object signaling success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
PnsResponse
{- data ( PnsData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
PnsData
{- success ( boolean ): The flag signaling success
-
-
-
Quota
The quota module allows accessing information about the limit and current usage of a certain storage type.-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the unified quota. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
QuotaResponse
{- data ( QuotaData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
QuotaData
{- quota ( integer ): Represents the maximum storage (-1 represents an unlimited quota).
- use ( integer ): Represents the used storage.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the filestore quota. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
QuotaResponse
{- data ( QuotaData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
QuotaData
{- quota ( integer ): Represents the maximum storage (-1 represents an unlimited quota).
- use ( integer ): Represents the used storage.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type module (empty) The module identifier (e.g. "share_links", "filestorage", ...) to get quota information for, required if account is set.
query string account (empty) The account identifier within the module to get quota information for.
query string folder (empty) The folder to get the quota for.
query string Responses:
200:
If `module` is not specified it is returned a JSON object containing all quota modules as fields. Each field is an object itself consisting of a field `display_name` and a field `accounts`. `accounts` is an array of JSON objects containing the properties `account_id`, `account_name`, `countquota` (account's quota limit for the number of items, or not set if not defined), `countuse` (account's actual usage for the number of items, or not set if no count quota defined), `quota` (account's quota limit for the storage in bytes, or not set if not defined) and `use` (account's actual usage for the storage in bytes, or not set if no storage quota defined). In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
QuotasResponse
{- data ( data ): Dependent on the request parameters: the payload may be a JSON object containing the quota modules as fields that represent JSON objects itself with the properties "display_name" and "accounts" (array of account data objects) or it may be a JSON array of account data objects if the parameter "module" specifies a certain quota module.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
400:
If a specified `module` is not existing.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the mail quota. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
QuotaResponse
{- data ( QuotaData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
QuotaData
{- quota ( integer ): Represents the maximum storage (-1 represents an unlimited quota).
- use ( integer ): Represents the used storage.
-
-
-
Reminder
The reminder module provides the ability to fetch all active reminders for a user between two dates.-
Gets all reminders which are scheduled until the specified time (end date).
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_reminder
Parameters:
Parameter Value Description Parameter Type Data Type end (empty) The end date of the reminder range.
query long modules (empty) A comma separated list of module ids to retrieve (e.g. "1,4" for tasks and appointments). If the parameter is missing or empty then all modules are retrieved.
query string Responses:
200:
A JSON object containing an array with data for each reminder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
RemindersResponse
{- data ( ReminderData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ReminderData
{- id ( integer ): The ID of the reminder.
- target_id ( integer ): The object ID of the target this reminder is attached to.
- folder ( integer ): The ID of the folder through that the object can be read.
- alarm ( integer ): The time of the alarm.
-
module
(
integer
, possibleValues:
1
4
7
137
- server_time ( integer ): The time on the server.
- user_id ( integer ): The ID of the user.
- last_modified ( integer ): The last modification timestamp of the reminder.
- recurrence_position ( integer ): The recurrence position for series appointments or 0 if no series.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_reminder
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the reminder whose alarm date shall be changed.
query long Body:
Description:A JSON object containing the field `alarm` which provides the new reminder date.
Content-type: application/json-
ReminderUpdateBody
{- alarm ( integer ): The new time of the alarm.
Responses:
200:
A JSON object containing the data of the updated reminder. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ReminderResponse
{- data ( ReminderData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ReminderData
{- id ( integer ): The ID of the reminder.
- target_id ( integer ): The object ID of the target this reminder is attached to.
- folder ( integer ): The ID of the folder through that the object can be read.
- alarm ( integer ): The time of the alarm.
-
module
(
integer
, possibleValues:
1
4
7
137
- server_time ( integer ): The time on the server.
- user_id ( integer ): The ID of the user.
- last_modified ( integer ): The last modification timestamp of the reminder.
- recurrence_position ( integer ): The recurrence position for series appointments or 0 if no series.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_reminder
Body:
Description:A JSON array with JSON objects containing the field `id` of the reminders to delete.
Content-type: application/json-
ReminderListElement
{- id ( integer ): The ID of the reminder.
Responses:
200:
A JSON object containing an array with identifiers of reminders that were not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
RemindersResponse
{- data ( ReminderData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ReminderData
{- id ( integer ): The ID of the reminder.
- target_id ( integer ): The object ID of the target this reminder is attached to.
- folder ( integer ): The ID of the folder through that the object can be read.
- alarm ( integer ): The time of the alarm.
-
module
(
integer
, possibleValues:
1
4
7
137
- server_time ( integer ): The time on the server.
- user_id ( integer ): The ID of the user.
- last_modified ( integer ): The last modification timestamp of the reminder.
- recurrence_position ( integer ): The recurrence position for series appointments or 0 if no series.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
Resources
The resource module allows to query available resources. It is mainly used by the dialog for the selection of participants.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) ID of the resource that shall be updated.
query integer timestamp (empty) Timestamp of the last update of the resource to update. If the resource was modified after the specified timestamp, then the update must fail.
query long Body:
Description:A JSON object containing the resource data fields to change. Only modified fields are present and the field id is omitted.
Content-type: application/json-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing an array of resource identifiers. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AllResourcesResponse
{- data ( array[integer] ): Array of resource identifiers.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the resource data. The field `id` is not present.
Content-type: application/json-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
Responses:
200:
A JSON object with the ID of the newly created resource. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ResourceUpdateResponse
{- data ( ResourceUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ResourceUpdateData
{- id ( integer ): The ID of a newly created rsource.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object with the search parameters.
Content-type: application/json-
ResourceSearchBody
{- pattern ( string ): Search pattern to find resources. In the pattern, the character "*" matches zero or more characters and the character "?" matches exactly one character. All other characters match only themselves.
Responses:
200:
A JSON object containing an array of resource objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ResourcesResponse
{- data ( array[ResourceData] ): Array of resource objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the resource.
query integer Responses:
200:
A JSON object containing the resource data. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ResourceResponse
{- data ( ResourceData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array of JSON objects with the id of the requested resources.
Content-type: application/json-
ResourceListElement
{- id ( integer ): ID of a resource.
Responses:
200:
A JSON object containing an array of resource objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ResourcesResponse
{- data ( array[ResourceData] ): Array of resource objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the group to delete.
query long Body:
Description:A JSON array of objects with the field `id` containing the unique identifier of the resource.
Content-type: application/json-
ResourceListElement
{- id ( integer ): ID of a resource.
Responses:
200:
A JSON object with an empty array if the resources were deleted successfully. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ResourcesResponse
{- data ( array[ResourceData] ): Array of resource objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the requested resources.
query long Responses:
200:
A JSON object with fields `new`, `modified` and `deleted` representing arrays of new, modified and deleted resource objects. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ResourceUpdatesResponse
{- data ( ResourceUpdatesData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ResourceUpdatesData
{- new ( array[ResourceData] ): Array of new resource objects.
- modified ( array ): Array of modified resource objects.
- deleted ( array ): Array of deleted resource objects.
-
ResourceData
{- id ( integer ): The resource ID.
- display_name ( string ): Display name of the resource.
- name ( string ): Internal name with character restrictions.
- mailaddress ( string ): Email address of the resource.
- availability ( boolean ): Can be false to mark the resource currently unavailable.
- description ( string ): The description of the resource.
- last_modified ( string , read only ): Date and time of the last modification.
- last_modified_utc ( string , read only ): Timestamp of the last modification.
-
-
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type feedUrl (empty) An array containing all RSS Feeds to load. Array can consist of one element.
query array limit (empty) Limitation of elements returned (in total).
query integer sort (empty) The identifier which determines the sort order of the response.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order.
query string Responses:
200:
A JSON object containing an array with data for the rss feed. Each array element describes one article and is an array itself. The elements of each array contain the information provided by the RSS Feed. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
RssResponse
{- data ( array[string] ): Array containing the differnet articles provided by the rss feed.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
SAML
Endpoints of the built-in SAML 2.0 service provider. See https://documentation.open-xchange.com/latest/middleware/login/02_saml.html.-
SAML 2.0 Single Logout Service. Accepts
<LogoutRequest>
messages from the IdP perHTTP-Redirect
binding.Parameters:
Parameter Value Description Parameter Type Data Type tenant (empty) In a multi-tenant environment, where different tenants might connect to different identity providers, this parameter denotes the tenant to start a SAML flow for. In single-tenant environments this parameter is superfluous.
path string SAMLRequest (empty) Base64 encoded SAML 2.0 `
` message. query string SigAlg (empty) Message signature algorithm ID
query string Signature (empty) Message signature
query string RelayState (empty) Message exchange relay state
query string Responses:
200:
HTML response with a self-submitting from that POSTs the `
` back to the IdP. 302:
Redirect URI that submits the `
` back to the IdP per `HTTP-Redirect` binding. 400:
In case of a missing `SAMLRequest` parameter
500:
In case of internal server errors
-
SAML 2.0 Single Logout Service. Accepts
<LogoutResponse>
messages of the Single Logout Profile perHTTP-POST
binding.Parameters:
Parameter Value Description Parameter Type Data Type tenant (empty) In a multi-tenant environment, where different tenants might connect to different identity providers, this parameter denotes the tenant to start a SAML flow for. In single-tenant environments this parameter is superfluous.
path string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
slsRespBody
{-
SAMLResponse
(
string
,
required
):
Base64 encoded SAML 2.0 `
` message. - RelayState ( string , required ): Message exchange relay state
-
SAMLResponse
(
string
,
required
):
Base64 encoded SAML 2.0 `
Responses:
302:
Redirect to `/login?action=samlLogout`
default:
Environment specific exit path (HTML page or redirect) on any error
-
-
SAML 2.0 Metadata Service. Provides an
<EntityDescriptor>
XML document describing the built-in service provider configuration.Parameters:
Parameter Value Description Parameter Type Data Type tenant (empty) In a multi-tenant environment, where different tenants might connect to different identity providers, this parameter denotes the tenant to start a SAML flow for. In single-tenant environments this parameter is superfluous.
path string Responses:
200:
The metadata response
500:
HTML error page
-
SAML 2.0 Assertion Consumer Service. Accepts
<Response>
messages of the Web Browser SSO Profile perHTTP-POST
binding.Parameters:
Parameter Value Description Parameter Type Data Type tenant (empty) In a multi-tenant environment, where different tenants might connect to different identity providers, this parameter denotes the tenant to start a SAML flow for. In single-tenant environments this parameter is superfluous.
path string Body:
Description:No description available
Content-type: application/x-www-form-urlencoded-
acsBody
{-
SAMLResponse
(
string
,
required
):
Base64 encoded SAML 2.0 `
` message. - RelayState ( string ): Message exchange relay state. Optional on unsolicited responses.
-
SAMLResponse
(
string
,
required
):
Base64 encoded SAML 2.0 `
Responses:
302:
Redirect to `/login?action=samlLogin`
default:
Environment specific exit path (HTML page or redirect) on any error
-
-
Initiates any supported SAML 2.0 login and logout flow as described in https://documentation.open-xchange.com/latest/middleware/login/02_saml.html.
Parameters:
Parameter Value Description Parameter Type Data Type tenant (empty) In a multi-tenant environment, where different tenants might connect to different identity providers, this parameter denotes the tenant to start a SAML flow for. In single-tenant environments this parameter is superfluous.
path string flow (empty) One of `login`, `relogin` or `logout` to start the respective flow.
query string session (empty) Required for flow `logout`. A session ID to determine the correct session.
query string redirect (empty) Responds with `302 Found` and sets the response header `Location` to the actual redirect URI.
query string Responses:
200:
Request was successful. Response JSON contains a redirect URI that the client must follow to continue.
Content-type: application/json-
initResponse
{- redirect_uri ( string , required ): A redirect URI that the client must follow to continue
302:
In case a redirect was requested
400:
In case of missing or invalid query parameters
500:
In case of an internal server error
-
-
-
sessionmanagement
The session management module-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object containing the sessions that were found. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AllSessionsResponse
{- data ( array[SessionManagementData] ): An array of active sessions and information about those sessions.
-
SessionManagementData
{- sessionId ( string ): The session identifier
- ipAddress ( string ): The IP address associated with the session
- client ( string ): The client associated with the session
- ctxId ( integer ): The context identifier
- userId ( integer ): The user identifier
- loginTime ( integer ): Time of login in UTC
- lastActive ( integer ): Time of last activity in UTC
- location ( string ): Guessed location based on IP address
- device ( DeviceInfo ): No description available
-
DeviceInfo
{- info ( string ): Localized string describing the device which is associated with this session
- type ( string ): Describing the device type which is associated with this session, possible values are "browser", "oxapp", "sync" and "other"
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object signaling success. In case of errors the responsible fields in the response are filled (see Error handling).
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array containing all session Ids to delete
Content-type: application/json
Responses:
200:
A JSON object signaling success. In case of errors the responsible fields in the response are filled (see Error handling).
-
-
Share/Management
The share/management module can create and manage share links via different actions. Dedicated actions to list all shares of a user can be found in the corresponding modules, like `/folders?action=shares` of module "folders" or `/infostore?action=shares` of module "infostore".-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) The timestamp of the last modification of the link. Used to detect concurrent modifications.
query long Body:
Description:A JSON object containing the share target and share link properties of the link to update. Only modified fields should be set but at least the share target ones.
Content-type: application/json-
ShareLinkUpdateBody
{- url ( string , read only ): The link to share.
- entity ( integer , read only ): The identifier of the anonymous user entity for the share.
- is_new ( boolean , read only ): Whether the share link is new, i.e. it has been created by the `/share/management?action=getLink` request, or if it already existed.
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible.
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share.
- meta ( meta ): Can be used by the client to save arbitrary JSON data along with the share.
- includeSubfolders ( boolean ): An optional flag indicating whether subfolders should be included or not. Only applicable for Drive folders.
- module ( string ): The folder's module name, i.e. one of "tasks", "calendar", "contacts" or "infostore".
- folder ( string ): The folder identifier.
- item ( string ): The object identifier, in case the share target is a single item. This must not be present to share a complete folder.
Responses:
200:
An empty json object in case of success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string Body:
Description:A JSON object containing the data for the update
Content-type: application/json-
SubscribeShareBody
{- link ( string ): The link to a share
Responses:
200:
A JSON object containing data of the analyzed share link. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ShareLinkAnalyzeResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{-
state
(
string
, possibleValues:
SUBSCRIBED
CREDENTIALS_REFRESH
ADDABLE
ADDABLE_WITH_PASSWORD
INACCESSIBLE
REMOVED
UNRESOLVABLE
UNSUPPORTED
FORBIDDEN
UNSUBSCRIBED
- error ( error ): Further details in case a share isn't `SUBSCRIBED`, `ADDABLE` or `ADDABLE_WITH_PASSWORD`
- account ( string ): The account ID of the newly created account
- module ( string ): The module of the subscription
- folder ( string ): The folder ID of the subscrition
-
state
(
string
, possibleValues:
-
error - Further details in case a share isn't `SUBSCRIBED`, `ADDABLE` or `ADDABLE_WITH_PASSWORD`
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string Body:
Description:A JSON object containing the data for the update
Content-type: application/json-
ExtendedSubscribeShareBody
{- link ( string ): The link to a share
- password ( string ): The password to the share
- name ( string ): The display name of the subsription
Responses:
200:
An json object holding the account information in case of success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SubscribeShareResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- account ( string ): The account ID of the newly created account
- module ( string ): The module of the subscription
- folder ( string ): The folder ID of the subscrition
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string Body:
Description:A JSON object containing the data for the update
Content-type: application/json-
ExtendedSubscribeShareBody
{- link ( string ): The link to a share
- password ( string ): The password to the share
- name ( string ): The display name of the subsription
Responses:
200:
An json object holding the account information in case of success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SubscribeShareResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- account ( string ): The account ID of the newly created account
- module ( string ): The module of the subscription
- folder ( string ): The folder ID of the subscrition
-
-
Parameters:
Parameter Value Description Parameter Type Data Type session (empty) A session ID previously obtained from the login module.
query string Body:
Description:A JSON object containing the data for the update
Content-type: application/json-
SubscribeShareBody
{- link ( string ): The link to a share
Responses:
200:
An empty json object in case of success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the share target and a list of recipients specified in a field `recipients` that is a JSON array with a nested two-elements array containing the recipient information (first element is personal name, second is email address). An optional field `message` can contain a notification.
Content-type: application/json-
ShareLinkSendBody
{- recipients ( array[array[string]] ): An array that lists the recipients. Each element is itself a two-element array specifying one recipient. The first element represents the personal name, the second element is the email address.
- message ( string ): Can contain an optional custom message.
- module ( string ): The folder's module name, i.e. one of "tasks", "calendar", "contacts" or "infostore".
- folder ( string ): The folder identifier.
- item ( string ): The object identifier, in case the share target is a single item. This must not be present to share a complete folder.
Responses:
200:
Transport warnings that occurred during sending the notifications are available in a `warnings` array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ShareLinkSendResponse
{- warnings ( warnings ): An array of possible warnings during sending of the notifications.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) The timestamp of the last modification of the link. Used to detect concurrent modifications.
query long Body:
Description:A JSON object containing the share target where the link should be deleted for.
Content-type: application/json-
ShareTargetData
{- module ( string ): The folder's module name, i.e. one of "tasks", "calendar", "contacts" or "infostore".
- folder ( string ): The folder identifier.
- item ( string ): The object identifier, in case the share target is a single item. This must not be present to share a complete folder.
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object containing the share target where the link should be generated for.
Content-type: application/json-
ShareTargetData
{- module ( string ): The folder's module name, i.e. one of "tasks", "calendar", "contacts" or "infostore".
- folder ( string ): The folder identifier.
- item ( string ): The object identifier, in case the share target is a single item. This must not be present to share a complete folder.
Responses:
200:
A JSON object containing data of the (newly created) share link. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
ShareLinkResponse
{- data ( ShareLinkData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
ShareLinkData
{- url ( string ): The link to share (read-only).
- entity ( integer ): The identifier of the anonymous user entity for the share (read-only).
- is_new ( boolean ): Whether the share link is new, i.e. it has been created by the `/share/management?action=getLink` request, or if it already existed (read-only).
- expiry_date ( integer ): The end date / expiration time after which the share link is no longer accessible.
- password ( string ): An additional secret / pin number an anonymous user needs to enter when accessing the share.
- includeSubfolders ( boolean ): An optional flag indicating if subfolders are included or not. Only applicable for shared infostore folders.
- meta ( meta ): Can be used by the client to save arbitrary JSON data along with the share.
-
-
-
Share/Redeem
The share/redeem module is used to redeem previously reserved tokens during the share login workflow.-
Parameters:
Parameter Value Description Parameter Type Data Type token (empty) The token as received when accessing the share link.
query string language (empty) Optional locale to use instead of the currently configured locale of the user.
query string Responses:
200:
A JSON object containing the extended parameters of the redirect location.
Content-type: application/json-
Unknown
-
-
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_userconfig
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the snippet.
query string Body:
Description:A JSON object providing the fields that should be changed, excluding its attachments. For deleting attachments see `/snippet?action=detach` request.
Content-type: application/json-
SnippetData
{- id ( string ): The ID of the snippet.
- accountid ( integer ): The identifier of the account.
- createdby ( integer , read only ): The user ID of the creator.
- displayname ( string ): The display name of the snippet.
- type ( string ): The type of the snippet, like "signature".
- content ( string ): Contains the snippet's content.
- module ( string ): The module identifier, like "com.openexchange.mail".
- shared ( boolean ): The shared flag.
- misc ( misc ): Contains miscellaneous data as JSON object.
- props ( props ): Contains custom properties as JSON object.
- files ( array[SnippetAttachment] ): An array of attachments.
-
SnippetAttachment
{- id ( string ): The ID of the attachment.
- filename ( string ): The file name of the attachment.
- mimetype ( string ): The MIME type of the attachment.
- contentid ( string ): The content ID of the attachment.
- size ( integer ): The size of the attachment in bytes.
Responses:
200:
A JSON object containing the data of the updated snippet. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SnippetResponse
{- data ( SnippetData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
SnippetData
{- id ( string ): The ID of the snippet.
- accountid ( integer ): The identifier of the account.
- createdby ( integer , read only ): The user ID of the creator.
- displayname ( string ): The display name of the snippet.
- type ( string ): The type of the snippet, like "signature".
- content ( string ): Contains the snippet's content.
- module ( string ): The module identifier, like "com.openexchange.mail".
- shared ( boolean ): The shared flag.
- misc ( misc ): Contains miscellaneous data as JSON object.
- props ( props ): Contains custom properties as JSON object.
- files ( array[SnippetAttachment] ): An array of attachments.
-
SnippetAttachment
{- id ( string ): The ID of the attachment.
- filename ( string ): The file name of the attachment.
- mimetype ( string ): The MIME type of the attachment.
- contentid ( string ): The content ID of the attachment.
- size ( integer ): The size of the attachment in bytes.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes oauth
Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the snippet.
query string Responses:
200:
A JSON object containing the data of the snippet. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SnippetResponse
{- data ( SnippetData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
SnippetData
{- id ( string ): The ID of the snippet.
- accountid ( integer ): The identifier of the account.
- createdby ( integer , read only ): The user ID of the creator.
- displayname ( string ): The display name of the snippet.
- type ( string ): The type of the snippet, like "signature".
- content ( string ): Contains the snippet's content.
- module ( string ): The module identifier, like "com.openexchange.mail".
- shared ( boolean ): The shared flag.
- misc ( misc ): Contains miscellaneous data as JSON object.
- props ( props ): Contains custom properties as JSON object.
- files ( array[SnippetAttachment] ): An array of attachments.
-
SnippetAttachment
{- id ( string ): The ID of the attachment.
- filename ( string ): The file name of the attachment.
- mimetype ( string ): The MIME type of the attachment.
- contentid ( string ): The content ID of the attachment.
- size ( integer ): The size of the attachment in bytes.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
It can be uploaded multiple files at once. Each file must be specified in an own form field (the form field name is arbitrary).
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_userconfig
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the snippet.
query string type The file type filter to define which file types are allowed during upload. Currently supported filters are: file (for all), text (for `text/*`), media (for image, audio or video), image (for `image/*`), audio (for `audio/*`), video (for `video/*`) and application (for `application/*`).
query string Body:
Description:No description available
Content-type: multipart/form-data-
addSnippetAttachmentBody
{- file ( string , required ): The attachment file.
Responses:
200:
A HTML page as described in File uploads containing a JSON object with the ID of the updated snippet or errors if some occurred.
Content-type: text/html-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_userconfig
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the snippet.
query string Body:
Description:A JSON array with JSON objects each containing a field `id` with the identifier of an attachment that shall be removed.
Content-type: application/json-
SnippetAttachmentListElement
{- id ( string ): The identifier of an attachment.
Responses:
200:
A JSON object containing the ID of the updated snippet. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SnippetUpdateResponse
{- data ( string ): The ID of the new snippet.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes oauth
Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type type (empty) A list of comma-separated types to filter, e.g. "signature".
query string Responses:
200:
A JSON object containing an array with data for all snippets. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SnippetsResponse
{- data ( array[SnippetData] ): An array of snippet objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
SnippetData
{- id ( string ): The ID of the snippet.
- accountid ( integer ): The identifier of the account.
- createdby ( integer , read only ): The user ID of the creator.
- displayname ( string ): The display name of the snippet.
- type ( string ): The type of the snippet, like "signature".
- content ( string ): Contains the snippet's content.
- module ( string ): The module identifier, like "com.openexchange.mail".
- shared ( boolean ): The shared flag.
- misc ( misc ): Contains miscellaneous data as JSON object.
- props ( props ): Contains custom properties as JSON object.
- files ( array[SnippetAttachment] ): An array of attachments.
-
SnippetAttachment
{- id ( string ): The ID of the attachment.
- filename ( string ): The file name of the attachment.
- mimetype ( string ): The MIME type of the attachment.
- contentid ( string ): The content ID of the attachment.
- size ( integer ): The size of the attachment in bytes.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_userconfig
Body:
Description:A JSON object describing the snippet excluding its attachment(s). For adding attachments see `/snippet?action=attach` request.
Content-type: application/json-
SnippetData
{- id ( string ): The ID of the snippet.
- accountid ( integer ): The identifier of the account.
- createdby ( integer , read only ): The user ID of the creator.
- displayname ( string ): The display name of the snippet.
- type ( string ): The type of the snippet, like "signature".
- content ( string ): Contains the snippet's content.
- module ( string ): The module identifier, like "com.openexchange.mail".
- shared ( boolean ): The shared flag.
- misc ( misc ): Contains miscellaneous data as JSON object.
- props ( props ): Contains custom properties as JSON object.
- files ( array[SnippetAttachment] ): An array of attachments.
-
SnippetAttachment
{- id ( string ): The ID of the attachment.
- filename ( string ): The file name of the attachment.
- mimetype ( string ): The MIME type of the attachment.
- contentid ( string ): The content ID of the attachment.
- size ( integer ): The size of the attachment in bytes.
Responses:
200:
A JSON object containing the ID of the newly created snippet. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SnippetUpdateResponse
{- data ( string ): The ID of the new snippet.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_userconfig
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the snippet. Otherwise provide one or more identifiers in the request body's JSON array.
query string Body:
Description:A JSON array containing the identifiers of the snippets to delete.
Content-type: application/json
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Body:
Description:A JSON array of snippet identifiers.
Content-type: application/json
Responses:
200:
A JSON object containing an array with data for the requested snippets. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
SnippetsResponse
{- data ( array[SnippetData] ): An array of snippet objects.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
SnippetData
{- id ( string ): The ID of the snippet.
- accountid ( integer ): The identifier of the account.
- createdby ( integer , read only ): The user ID of the creator.
- displayname ( string ): The display name of the snippet.
- type ( string ): The type of the snippet, like "signature".
- content ( string ): Contains the snippet's content.
- module ( string ): The module identifier, like "com.openexchange.mail".
- shared ( boolean ): The shared flag.
- misc ( misc ): Contains miscellaneous data as JSON object.
- props ( props ): Contains custom properties as JSON object.
- files ( array[SnippetAttachment] ): An array of attachments.
-
SnippetAttachment
{- id ( string ): The ID of the attachment.
- filename ( string ): The file name of the attachment.
- mimetype ( string ): The MIME type of the attachment.
- contentid ( string ): The content ID of the attachment.
- size ( integer ): The size of the attachment in bytes.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The identifier of the snippet.
query string attachmentid (empty) The identifier of the attachment.
query string Responses:
200:
The attachment's raw data.
Content-type: application/json-
Unknown
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
500:
A HTML page in case of errors.
Content-type: application/json-
Unknown
-
-
-
Sync
The module sync delivers several core API extensions to support common operations used in a mobile synchronization environment.-
Note
Although the request offers to clear multiple folders at once it is recommended to clear only one folder per request since if any exception occurs (e.g. missing permissions) the complete request is going to be aborted.
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON array containing the folder ID(s).
Content-type: application/x-www-form-urlencoded
Responses:
200:
A JSON object containing an array of folder IDs that could not be cleared due to a concurrent modification. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
FoldersCleanUpResponse
{- data ( array[string] ): An array with object IDs of folders that could not be processed because of a concurrent modification or something else. If the extendedResponse parameter is set to `true` the array contains json objects instead.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
System
The module for API related to the middelware system-
Responses:
200:
A JSON object containing the value "TRUE". This indicates that the server is still running and ready to handle more requests
Content-type: application/json-
PingResponse
{- data ( boolean ): true
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object signaling success. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
WhoAmIResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- random ( string ): The random token
- session ( string ): The session identifier
- user ( string ): The user
- user_id ( string ): The user identifier
- context_id ( string ): The context identifier
- requires_multifactor ( boolean ): An value indicating whether multifactor has been enabled or not
- locale ( string ): The locale of the user
-
-
Responses:
200:
A JSON object containing the time value as long. The time is measured in milliseconds and is the difference between the current time and midnight, January 1, 1970 UTC
Content-type: application/json-
TimeResponse
{- data ( integer ): The system time of the node as long
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
Tasks
The tasks module is used to access task information.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested task.
query string folder (empty) Object ID of the folder who contains the tasks.
query string Responses:
200:
An object containing all data of the requested task. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TaskResponse
{- data ( TaskData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
TaskData
{-
status
(
integer
, possibleValues:
1
2
3
4
5
* 1 (not started),
* 2 (in progress),
* 3 (done),
* 4 (waiting),
* 5 (deferred) - percent_completed ( integer ): How much of the task is completed. An integer number between 0 and 100.
- actual_costs ( number ): A monetary attribute to store actual costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99.
- actual_duration ( string ): Actual duration of the task, e.g. in minutes.
- after_complete ( integer ): (DEPRECATED) Only present in AJAX interface. Value will not be stored on OX server.
- billing_information ( string ): Billing information of the task.
- target_costs ( number ): A monetary attribute to store target costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99.
- target_duration ( string ): Target duration of the task, e.g. in minutes.
-
priority
(
integer
, possibleValues:
1
2
3
* 1 (low),
* 2 (medium),
* 3 (high) - currency ( string ): The currency, e.g. "EUR".
- trip_meter ( string ): The trip meter.
- companies ( string ): Companies.
- date_completed ( integer ): No description available
- start_time ( integer ): Inclusive start as Date for whole day tasks and Time for normal tasks.
- end_time ( integer ): Exclusive end as Date for whole day tasks and as Time for normal tasks.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
status
(
integer
, possibleValues:
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_tasks
Parameters:
Parameter Value Description Parameter Type Data Type timestamp (empty) Timestamp of the last update of the deleted tasks.
query long Body:
Description:A JSON array of JSON objects with the id and folder of the tasks.
Content-type: application/json-
TaskListElement
{- id ( string , required ): The object ID of the task.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
A JSON array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TaskDeletionsResponse
{- data ( array[string] ): An array with object IDs of tasks which were modified after the specified timestamp and were therefore not deleted.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_tasks
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the task that shall be confirmed.
query string folder (empty) Object ID of the folder who contains the tasks.
query string timestamp (empty) Timestamp of the last update of the task.
query long Body:
Description:A JSON object with the fields `confirmation` and `confirmmessage`.
Content-type: application/json-
TaskConfirmationBody
{-
confirmation
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative).
- confirmmessage ( string ): The confirmation message or comment.
-
confirmation
(
integer
, possibleValues:
Responses:
200:
Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated task, and maybe errors. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the tasks.
query string columns (empty) A comma-separated list of columns to return, like "1,200". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed task data.
query string timestamp (empty) Timestamp of the last update of the requested tasks.
query long ignore Which kinds of updates should be ignored. Omit this parameter or set it to "deleted" to not have deleted tasks identifier in the response. Set this parameter to `false` and the response contains deleted tasks identifier.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
An array with new, modified and deleted tasks. New and modified tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. Deleted tasks would be identified by their object IDs as integers, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TaskUpdatesResponse
{- data ( data ): Array of tasks.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,200". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed task data.
query string Body:
Description:A JSON array of JSON objects with the id and folder of the tasks.
Content-type: application/json-
TaskListElement
{- id ( string , required ): The object ID of the task.
- folder ( string , required ): The object ID of the related folder.
Responses:
200:
A JSON object containing an array with data for the requested tasks. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TasksResponse
{- data ( data ): Array of tasks. Each task is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_tasks
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the tasks.
query string id (empty) Object ID of the requested task.
query string timestamp (empty) Timestamp of the last update of the requested tasks.
query long Body:
Description:A JSON object containing the task's data. Only modified fields are present.
Content-type: application/json-
TaskData
{-
status
(
integer
, possibleValues:
1
2
3
4
5
* 1 (not started),
* 2 (in progress),
* 3 (done),
* 4 (waiting),
* 5 (deferred) - percent_completed ( integer ): How much of the task is completed. An integer number between 0 and 100.
- actual_costs ( number ): A monetary attribute to store actual costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99.
- actual_duration ( string ): Actual duration of the task, e.g. in minutes.
- after_complete ( integer ): (DEPRECATED) Only present in AJAX interface. Value will not be stored on OX server.
- billing_information ( string ): Billing information of the task.
- target_costs ( number ): A monetary attribute to store target costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99.
- target_duration ( string ): Target duration of the task, e.g. in minutes.
-
priority
(
integer
, possibleValues:
1
2
3
* 1 (low),
* 2 (medium),
* 3 (high) - currency ( string ): The currency, e.g. "EUR".
- trip_meter ( string ): The trip meter.
- companies ( string ): Companies.
- date_completed ( integer ): No description available
- start_time ( integer ): Inclusive start as Date for whole day tasks and Time for normal tasks.
- end_time ( integer ): Exclusive end as Date for whole day tasks and as Time for normal tasks.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
status
(
integer
, possibleValues:
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
Responses:
200:
A JSON object with a timestamp. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TaskUpdateResponse
{- data ( TaskUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
TaskUpdateData
{- id ( string ): ID of a newly created task.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
write_tasks
Body:
Description:A JSON object containing the task's data.
Content-type: application/json-
TaskData
{-
status
(
integer
, possibleValues:
1
2
3
4
5
* 1 (not started),
* 2 (in progress),
* 3 (done),
* 4 (waiting),
* 5 (deferred) - percent_completed ( integer ): How much of the task is completed. An integer number between 0 and 100.
- actual_costs ( number ): A monetary attribute to store actual costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99.
- actual_duration ( string ): Actual duration of the task, e.g. in minutes.
- after_complete ( integer ): (DEPRECATED) Only present in AJAX interface. Value will not be stored on OX server.
- billing_information ( string ): Billing information of the task.
- target_costs ( number ): A monetary attribute to store target costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99.
- target_duration ( string ): Target duration of the task, e.g. in minutes.
-
priority
(
integer
, possibleValues:
1
2
3
* 1 (low),
* 2 (medium),
* 3 (high) - currency ( string ): The currency, e.g. "EUR".
- trip_meter ( string ): The trip meter.
- companies ( string ): Companies.
- date_completed ( integer ): No description available
- start_time ( integer ): Inclusive start as Date for whole day tasks and Time for normal tasks.
- end_time ( integer ): Exclusive end as Date for whole day tasks and as Time for normal tasks.
- title ( string ): Short description.
- start_date ( integer ): (DEPRECATED) Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time).
- end_date ( integer ): (DEPRECATED) Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time).
- note ( string ): Long description.
- alarm ( integer ): Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified.
-
recurrence_type
(
integer
, possibleValues:
0
1
2
3
4
* 0 (none, single event),
* 1 (daily),
* 2 (weekly),
* 3 (monthly),
* 4 (yearly) - days ( integer ): Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
- day_in_month ( integer ): Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
- month ( integer ): Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
- interval ( integer ): Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
- until ( integer ): Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
- notification ( boolean ): If `true`, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.
- participants ( array[TaskParticipant] ): Each element identifies a participant, user, group or booked resource.
- users ( array[TaskUser] ): Each element represents a participant. User groups are resolved and are represented by their members. Any user can occur only once.
- occurrences ( integer ): Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID.
- organizer ( string ): Contains the email address of the appointment organizer which is not necessarily an internal user. **Not implemented for tasks**.
- sequence ( integer ): iCal sequence number. **Not implemented for tasks**. Must be incremented on update. Will be incremented by the server, if not set.
- confirmations ( array[TaskConfirmation] ): Each element represents a confirming participant. This can be internal and external user. Not implemented for tasks.
- organizerId ( integer , read only ): Contains the userId of the appointment organizer if it is an internal user. **Not implemented for tasks**.
- principal ( string ): Contains the email address of the appointment principal which is not necessarily an internal user. **Not implemented for tasks**.
- principalId ( integer , read only ): Contains the userIId of the appointment principal if it is an internal user. **Not implemented for tasks**.
- full_time ( boolean ): `True` if the event is a whole day appointment or task, `false` otherwise.
- id ( string ): Object ID.
- created_by ( integer , read only ): User ID of the user who created this object.
- modified_by ( integer , read only ): User ID of the user who last modified this object.
- creation_date ( integer , read only ): Date and time of creation.
- last_modified ( integer , read only ): Date and time of the last modification.
- folder_id ( string ): Object ID of the parent folder.
- categories ( string ): String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects.
- private_flag ( boolean ): Overrides folder permissions in shared private folders: When `true`, this object is not visible to anyone except the owner. Not present in folder objects.
- color_label ( integer ): Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects.
- number_of_attachments ( integer ): Number of attachments.
- lastModifiedOfNewestAttachmentUTC ( integer ): Timestamp of the newest attachment written with UTC time zone.
-
status
(
integer
, possibleValues:
-
TaskParticipant
{- id ( integer ): User ID.
-
type
(
integer
, possibleValues:
1
2
3
4
5
* 1 (user),
* 2 (user group),
* 3 (resource),
* 4 (resource group),
* 5 (external user) - mail ( string ): Mail address of an external participant.
-
TaskUser
{- id ( integer ): User ID. Confirming for other users only works for appointments and not for tasks.
- display_name ( string ): Displayable name of the participant.
-
confirm
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - confirmmessage ( string ): Confirm message of the participant.
-
TaskConfirmation
{-
type
(
integer
, possibleValues:
0
5
* 0 (user),
* 5 (external user) - mail ( string ): Email address of external participant.
- display_name ( string ): Display name of external participant.
-
status
(
integer
, possibleValues:
0
1
2
3
* 1 (accepted),
* 2 (declined),
* 3 (tentative) - message ( string ): Confirm message of the participant.
-
type
(
integer
, possibleValues:
Responses:
200:
A JSON object containing the id of the newly created task. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TaskUpdateResponse
{- data ( TaskUpdateData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
TaskUpdateData
{- id ( string ): ID of a newly created task.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks
Parameters:
Parameter Value Description Parameter Type Data Type folder (empty) Object ID of the folder who contains the tasks.
query string columns (empty) A comma-separated list of columns to return, like "1,200". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed task data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
A JSON object containing an array with data for all tasks. Each array element describes one task and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TasksResponse
{- data ( data ): Array of tasks. Each task is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
read_tasks
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,200". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed task data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string start (empty) Inclusive start date for a time range the tasks should end in. If start is omitted end is ignored.
query long end (empty) Exclusive end date for a time range the tasks should end in. If this parameter is omitted the time range has an open end.
query long Body:
Description:A JSON object containing search parameters.
Content-type: application/json-
TaskSearchBody
{- pattern ( string , required ): Search pattern to find tasks. In the pattern, the character "*" matches zero or more characters and the character "?" matches exactly one character. All other characters match only themselves.
- folder ( string ): Defines the folder to search for tasks in. If this is omitted in all task folders will be searched.
Responses:
200:
A JSON object containing an array with matching tasks. Tasks are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
TasksResponse
{- data ( data ): Array of tasks. Each task is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
401:
In case the oauth token is missing or is invalid
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
403:
In case the scope of the oauth token is insufficient
Content-type: application/json-
OAuthErrorResponse
{-
error
(
string
, possibleValues:
invalid_token
insufficient_scope
- error_description ( string ): The error description
- scope ( string ): The missing scope
-
error
(
string
, possibleValues:
-
-
-
Token
The module token delivers several core API extensions to support token based logins.-
With a valid session it is possible to acquire a secret. Using this secret another system is able to generate a valid session (see login?action=redeemToken).
Security:
This security scheme must be used:Name Scopes session
Responses:
200:
A JSON object with the timestamp of the creation date and a token which can be used to create a new session. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
AcquireTokenResponse
{- data ( data ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
data
{- token ( string ): The token that can be used for a new session.
-
-
-
-
Security:
This security scheme must be used:Name Scopes session
Body:
Description:A JSON object providing the use-count incrementation arguments.
Content-type: application/json-
UseCountIncrement
{-
type
(
string
, possibleValues:
contact
user
group
resource
- id ( string ): The identifier of the entity; either contact identifier, user identifier, group identifier or resource identifier
- folderId ( string ): The identifier of the folder in which the entity resides. Only needed for "contact" entity type and if no email is provided.
- mail ( string ): The mail address of the contact. Only needed for "contact" entity type and if id and folderId are not provided.
- accountId ( integer ): The numeric identifier of the account if not specified through a composite folder identifier
- moduleId ( integer ): The numeric identifier of the module if not specified through a composite folder identifier
-
type
(
string
, possibleValues:
Responses:
200:
A JSON object containing the success status.
Content-type: application/json-
incrementUseCountResponse
{- data ( data ): No description available
-
data
{- success ( boolean ): True if use-count has been successfully incremented; false otherwise
400:
Bad request, response contains error message.
401:
Not authorized
-
-
-
User
The user module is used to access user information.-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested user.
query string timestamp (empty) Timestamp of the last update of the requested user. If the user was modified after the specified timestamp, then the update must fail.
query long Body:
Description:A JSON object containing the user's data. Only modified fields are present. From Detailed user data only the fields `timezone` and `locale` are allowed to be updated.
Content-type: application/json-
UserData Composed Schema
ALLOF: Object Object -
Unknown
{- aliases ( array[string] ): The user's aliases.
- timezone ( string ): The time zone.
- locale ( string ): The name of user's entire locale, with, language, country and variant separated by underbars (e.g. "en", "de_DE").
- groups ( array[integer] ): The IDs of user's groups.
- contact_id ( string ): The contact ID of the user.
- login_info ( string ): The user's login information.
- guest_created_by ( integer , read only ): The ID of the user who has created this guest in case this user represents a guest user. 0 represents regular users.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
Responses:
200:
In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CommonResponse
{- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Gets a custom user attribute that was previously set with the
/user?action=setAttribute
request.Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the user.
query string name (empty) The name of the attribute.
query string Responses:
200:
A JSON object containing the attribute data. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
UserAttributeResponse
{- data ( UserAttribute ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
UserAttribute
{- name ( string ): The name of the attribute.
- value ( string ): The value of the attribute.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,501,610". Each column is specified by a numeric column identifier, see Common object data, Detailed contact data and Detailed user data.
query string Body:
Description:A JSON array of identifiers of the requested users. A `null` value in the array is interpreted as the currently logged in user.
Content-type: application/json
Responses:
200:
A JSON object containing an array with data for the requested users. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
UsersResponse
{- data ( data ): Array of user. Each user is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Sets a custom user attribute consisting of a name and a value. The attribute can later be retrieved using the /user?action=getAttribute request.
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) The ID of the user.
query string setIfAbsent (empty) Set to `true` to put the value only if the specified name is not already associated with a value, otherwise `false` to put value in any case.
query boolean Body:
Description:A JSON object providing the name and the value of the attribute. If the `value` field is missing or `null`, the attribute is removed.
Content-type: application/json-
UserAttribute
{- name ( string ): The name of the attribute.
- value ( string ): The value of the attribute.
Responses:
200:
A JSON object providing the information whether the attribute could be set. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
UserAttributionResponse
{- data ( boolean ): Indicates whether the attribute could be set.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type id (empty) Object ID of the requested user. This parameter is optional and the default is the currently logged in user.
query string Responses:
200:
An object containing all data of the requested user. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
UserResponse
{- data ( UserData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
UserData Composed Schema
ALLOF: Object Object -
Unknown
{- aliases ( array[string] ): The user's aliases.
- timezone ( string ): The time zone.
- locale ( string ): The name of user's entire locale, with, language, country and variant separated by underbars (e.g. "en", "de_DE").
- groups ( array[integer] ): The IDs of user's groups.
- contact_id ( string ): The contact ID of the user.
- login_info ( string ): The user's login information.
- guest_created_by ( integer , read only ): The ID of the user who has created this guest in case this user represents a guest user. 0 represents regular users.
- uid ( string ): Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID.
- display_name ( string ): The display name.
- first_name ( string ): The given name.
- last_name ( string ): The sur name.
- second_name ( string ): The middle name.
- suffix ( string ): The suffix.
- title ( string ): The title.
- street_home ( string ): The street of the home address.
- postal_code_home ( string ): The postal code of the home address.
- city_home ( string ): The city of the home address.
- state_home ( string ): The state of the home address.
- country_home ( string ): The country of the home address.
- birthday ( integer ): The date of birth.
- marital_status ( string ): The marital status.
- number_of_children ( string ): The number of children.
- profession ( string ): The profession.
- nickname ( string ): The nickname.
- spouse_name ( string ): The name of the spouse.
- anniversary ( integer ): The anniversary.
- note ( string ): A note.
- department ( string ): The department.
- position ( string ): The position.
- employee_type ( string ): The type of the employee.
- room_number ( string ): The room number.
- street_business ( string ): The street of the business address.
- postal_code_business ( string ): The postal code of the business address.
- city_business ( string ): The city of the business address.
- state_business ( string ): The state of the business address.
- country_business ( string ): The country of the business address.
- user_id ( integer , read only ): The internal user id.
- number_of_employees ( string ): The number of employees.
- sales_volume ( string ): The sales volume.
- tax_id ( string ): The tax id.
- commercial_register ( string ): The commercial register.
- branches ( string ): The branches.
- business_category ( string ): The business category.
- info ( string ): An information.
- manager_name ( string ): The manager's name.
- assistant_name ( string ): The assistant's name.
- street_other ( string ): The street of another address.
- postal_code_other ( string ): The postal code of another address.
- city_other ( string ): The city of another address.
- state_other ( string ): The state of another address.
- country_other ( string ): The country of another address.
- telephone_business1 ( string ): The business telephone number 1.
- telephone_business2 ( string ): The business telephone number 2.
- fax_business ( string ): The business fax number.
- telephone_callback ( string ): The callback telephone number.
- telephone_car ( string ): The car telephone number.
- telephone_company ( string ): The company telephone number.
- telephone_home1 ( string ): The home telephone number 1.
- telephone_home2 ( string ): The home telephone number 2.
- fax_home ( string ): The home fax number.
- cellular_telephone1 ( string ): The cellular telephone number 1.
- cellular_telephone2 ( string ): The cellular telephone number 2.
- telephone_other ( string ): The other telephone number.
- fax_other ( string ): The other fax number.
- email1 ( string ): The email address 1.
- email2 ( string ): The email address 2.
- email3 ( string ): The email address 3.
- url ( string ): The url address or homepage.
- telephone_isdn ( string ): The ISDN telephone number.
- telephone_pager ( string ): The pager telephone number.
- telephone_primary ( string ): The primary telephone number.
- telephone_radio ( string ): The radio telephone number.
- telephone_telex ( string ): The telex telephone number.
- telephone_ttytdd ( string ): The TTY/TDD telephone number.
- instant_messenger1 ( string ): The instant messenger address 1.
- instant_messenger2 ( string ): The instant messenger address 2.
- telephone_ip ( string ): The IP telephone number.
- telephone_assistant ( string ): The assistant telephone number.
- company ( string ): The company name.
- image1 ( string ): No description available
- image1_content_type ( string ): The content type of the image (like "image/png").
- image1_url ( string ): The url to the image.
- number_of_images ( integer ): The number of images.
- image_last_modified ( integer ): The last modification of the image.
- distribution_list ( array[DistributionListMember] ): If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list.
- number_of_distribution_list ( integer ): The number of objects in the distribution list.
- mark_as_distributionlist ( boolean ): No description available
- file_as ( string ): The file name.
- default_address ( integer ): The default address.
- useCount ( integer ): In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored.
- yomiFirstName ( string ): Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiLastName ( string ): Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues.
- yomiCompany ( string ): Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues.
- addressHome ( string ): Support for Outlook 'home' address field.
- addressBusiness ( string ): Support for Outlook 'business' address field.
- addressOther ( string ): Support for Outlook 'other' address field.
- userfield01 ( string ): Dynamic Field 1.
- userfield02 ( string ): Dynamic Field 2.
- userfield03 ( string ): Dynamic Field 3.
- userfield04 ( string ): Dynamic Field 4.
- userfield05 ( string ): Dynamic Field 5.
- userfield06 ( string ): Dynamic Field 6.
- userfield07 ( string ): Dynamic Field 7.
- userfield08 ( string ): Dynamic Field 8.
- userfield09 ( string ): Dynamic Field 9.
- userfield10 ( string ): Dynamic Field 10.
- userfield11 ( string ): Dynamic Field 11.
- userfield12 ( string ): Dynamic Field 12.
- userfield13 ( string ): Dynamic Field 13.
- userfield14 ( string ): Dynamic Field 14.
- userfield15 ( string ): Dynamic Field 15.
- userfield16 ( string ): Dynamic Field 16.
- userfield17 ( string ): Dynamic Field 17.
- userfield18 ( string ): Dynamic Field 18.
- userfield19 ( string ): Dynamic Field 19.
- userfield20 ( string ): Dynamic Field 20.
-
DistributionListMember
{- id ( string ): Object ID of the member's contact if the member is an existing contact.
- folder_id ( string ): Parent folder ID of the member's contact if the member is an existing contact.
- display_name ( string ): The display name.
- sort_name ( string ): A name which can be used for sorting.
- mail ( string ): The email address (optional if you are referring to an internal contact).
-
mail_field
(
integer
, possibleValues:
0
1
2
3
* 0 (independent contact),
* 1 (default email field, email1),
* 2 (second email field, email2),
* 3 (third email field, email3)
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,501,610". Each column is specified by a numeric column identifier, see Common object data, Detailed contact data and Detailed user data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.
query string order (empty) "asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Responses:
200:
A JSON object containing an array with data for all users. Each array element describes one user and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
UsersResponse
{- data ( data ): Array of user. Each user is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type columns (empty) A comma-separated list of columns to return, like "1,501,610". Each column is specified by a numeric column identifier, see Common object data, Detailed contact data and Detailed user data.
query string sort (empty) The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.
query string order (empty) "asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.
query string Body:
Description:A JSON object containing search parameters.
Content-type: application/json-
UserSearchBody
{- pattern ( string ): Search pattern to find tasks. In the pattern, the character "*" matches zero or more characters and the character "?" matches exactly one character. All other characters match only themselves.
- startletter ( boolean ): Search users with the given startletter. If this field is present, the pattern is matched against the user field which is specified by the property "contact_first_letter_field" on the server (default: last name). Otherwise, the pattern is matched against the display name.
- last_name ( string ): Searches users where the last name matches with the given last name. The character "*" matches zero or more characters and the character "?" matches exactly one character. This field is ignored if `pattern` is specified.
- first_name ( string ): Searches users where the first name matches with the given first name. The character "*" matches zero or more characters and the character "?" matches exactly one character. This field is ignored if `pattern` is specified.
- display_name ( string ): Searches users where the display name matches with the given display name. The character "*" matches zero or more characters and the character "?" matches exactly one character. This field is ignored if `pattern` is specified.
- orSearch ( boolean ): If set to `true`, the fields `last_name`, `first_name` and `display_name` are connected through an OR search habit. This field is ignored if `pattern` is specified.
- emailAutoComplete ( boolean ): If set to `true`, results are guaranteed to contain at least one email adress and the search is performed by connecting the relevant fields through an OR search habit. This field is ignored if `pattern` is specified.
Responses:
200:
A JSON object containing an array with matching users. Users are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the `columns` parameter. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
UsersResponse
{- data ( data ): Array of user. Each user is described as an array itself.
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
-
-
User/Me
The module user/me is used to access formal information about current user.-
Security:
One of these security schemes must be used:Name Scopes session
Name Scopes oauth
Responses:
200:
A JSON object containing the data of the current user. In case of errors the responsible fields in the response are filled (see Error handling).
Content-type: application/json-
CurrentUserResponse
{- data ( CurrentUserData ): No description available
- timestamp ( integer ): The latest timestamp of the returned data (see Updates).
- error ( string ): The translated error message. Present in case of errors.
- error_params ( array[string] ): Empty JSON array.
- error_id ( string ): Unique error identifier to help finding this error instance in the server logs.
- error_desc ( string ): The technical error message (always English) useful for debugging the problem. Might be the same as error message if there is no more information available.
- error_stack ( array[string] ): If configured (see com.openexchange.ajax.response.includeStackTraceOnError) this field provides the stack trace of associated Java exception represented as a JSON array.
- code ( string ): Error code consisting of an upper-case module identifier and a four-digit message number, separated by a dash; e.g. "MSG-0012"
- categories ( string ): Either a single (String) or list (Array) of upper-case category identifiers to which the error belongs.
- category ( integer ): Maintained for legacy reasons: The numeric representation of the first category.
-
CurrentUserData
{- context_id ( integer ): The unique identifier of the user's context.
- user_id ( integer ): The unique identifier of the user himself.
- context_admin ( integer ): The ID of the context administrator user.
- login_name ( string ): The login name of the user.
- display_name ( string ): The display name of the user.
- mail_login ( string ): The username used to authenticate at the primary mail server. Can be absent in temporary error situations.
- email_address ( string ): The users' primary email address
- email_aliases ( array[string] ): All email aliases of the user
-
-
-
userfeedback
The user feedback module-
Security:
This security scheme must be used:Name Scopes session
Parameters:
Parameter Value Description Parameter Type Data Type type (empty) The feedback type
query string Body:
Description:A JSON object describing the feedback
Content-type: application/json-
Unknown
Responses:
200:
A JSON object signaling success. In case of errors the responsible fields in the response are filled (see Error handling).
-
-
Column identifiers
Below you find the identifiers for object fields of certain data objects (models) that can be used in the columns
parameter of a request to return
specific field data of single or multiple objects.
Common object data
ID | Name | Type | Value |
---|---|---|---|
1 | id | String | Object ID |
2 | created_by | String | User ID of the user who created this object. |
3 | modified_by | String | User ID of the user who last modified this object. |
4 | creation_date | Time | Date and time of creation. |
5 | last_modified | Time | Date and time of the last modification. |
20 | folder_id | String | Object ID of the parent folder. |
100 | categories | String | String containing comma separated the categories. Order is preserved. Changing the order counts as modification of the object. Not present in folder objects. |
101 | private_flag | Boolean | Overrides folder permissions in shared private folders: When true, this object is not visible to anyone except the owner. Not present in folder objects. |
102 | color_label | Number | Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). Not present in folder objects. |
104 | number_of_attachments | Number | Number of attachments |
105 | lastModifiedOfNewestAttachmentUTC | Time | Date and time of the newest attachment written with UTC time zone. |
Permission object
Name | Type | Value |
---|---|---|
bits | Number | For non-mail folders, a number as described in Permission flags. |
rights | String | For mail folders, the rights string as defined in RFC 2086. |
entity | Number | User ID of the user or group to which this permission applies (ignored for type "anonymous" or "guest"). |
group | Boolean | true if entity refers to a group, false if it refers to a user (ignored for type "anonymous" or "guest"). |
type | String | The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined). |
password | String | An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional) . |
email_address | String | The e-mail address of the recipient (for type "guest"). |
display_name | String | The display name of the recipient (for type "guest", optional). |
contact_id | String | The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional). |
contact_folder | String | The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set). |
expiry_date | Time | The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional). |
Extended permission object
Name | Type | Value |
---|---|---|
entity | Number | Identifier of the permission entity (i.e. user-, group- or guest-ID). |
bits | Number | A number as described in Permission flags. |
type | String | "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity. |
display_name | String | A display name for the permission entity. |
contact | Object | A (reduced) set of Detailed contact data for "user" and "guest" entities. |
share_url | String | The share link for "anonymous" entities. |
password | String | The optionally set password for "anonymous" entities. |
expiry_date | Date | The optionally set expiry date for "anonymous" entities. |
includeSubfolders | Boolean | The optionally set "include subfolders" option for "anonymous" entities. |
isInherited | boolean | A flag indicating whether the permissions is inherited from the parent folder or not. The client must not allow the user to delete or update inherited permissions. |
Common folder data
ID | Name | Type | Value |
---|---|---|---|
1 | id | String | Object ID |
2 | created_by | String | User ID of the user who created this object. |
3 | modified_by | String | User ID of the user who last modified this object. |
4 | creation_date | Time | Date and time of creation. |
5 | last_modified | Time | Date and time of the last modification. |
6 | last_modified_utc | Timestamp | Timestamp of the last modification. Note that the type is Timestamp, not Time. See Date and time for details. (added 2008-10-17, with SP5, temporary workaround) |
20 | folder_id | String | Object ID of the parent folder. |
Detailed folder data
ID | Name | Type | Value |
---|---|---|---|
300 | title | String | Name of this folder. |
301 | module | String | Name of the module which implements this folder; e.g. "tasks", "calendar", "contacts", "infostore", or "mail" |
302 | type | Number | See Type of folder |
304 | subfolders | Boolean | true if this folder has subfolders. |
305 | own_rights | Number or String | Permissions which apply to the current user, as described either in Permission flags or in RFC 2086. |
306 | permissions | Array | Each element is an object described in Permission object. |
307 | summary | String | Information about contained objects. |
308 | standard_folder | Boolean | Indicates whether or not folder is marked as a default folder (only OX folder) |
309 | total | Number | The number of objects in this Folder. |
310 | new | Number | The number of new objects in this Folder. |
311 | unread | Number | The number of unread objects in this Folder. |
312 | deleted | Number | The number of deleted objects in this Folder. |
313 | capabilities | Number | Bit mask containing information about mailing system capabilites, as described in capabilities. |
314 | subscribed | Boolean | Indicates whether this folder should appear in folder tree or not. Note: Standard folders cannot be unsubscribed. |
315 | subscr_subflds | Boolean | Indicates whether subfolders should appear in folder tree or not. |
316 | standard_folder_type | Number | Indicates the default folder type. Zero for non-default folder. See Standard folder types |
317 | supported_capabilities | Array | Each element is a String identifying a supported folder capability as described in supported capabilities. Only applicable for non-mail folders. Read Only. |
318 | account_id | String | Will be null if the folder does not belong to any account (i.e. if its module doesn't support multiple accounts), is a virtual folder or an account-agnostic system folder. |
319 | folder_name | String | The raw and therefore untranslated name of this folder |
320 | origin | String | The folder's origin path. |
321 | used_for_sync | Object | A json object containing the fields 'value' and 'protected'. The value field indicates whether this folder is used for sync or not. And the 'protected' field shows if the client can change this value or not. |
3010 | DEPRECATED com.openexchange.publish.publicationFlag | Boolean | DEPRECATED The publication feature has been removed with v7.10.2. This column is igonred. |
3020 | com.openexchange.subscribe.subscriptionFlag | Boolean | Indicates whether this folder has subscriptions storing their content in this folder. Direct write operations on the content of this folder is forbidden. Clients should therefore not offer those options to the user. Read Only, provided by the com.openexchange.subscribe plugin |
3030 | com.openexchange.folderstorage.displayName | String | Provides the display of the folder's owner. Read Only |
3031 | com.openexchange.folderstorage.accountError | Object | In case the account has errors this field contains a json object with fields related to this error. |
3060 | com.openexchange.share.extendedPermissions | Array | Each element is an object described in Extended permission object. Read Only. |
3201 | com.openexchange.calendar.extendedProperties | Object | A json object containing the extended properties of an calendar folder as key value pairs. Each value can be an object, an array or a simple value itself. |
3203 | com.openexchange.calendar.provider | String | The name of the calendar provider. |
3204 | com.openexchange.calendar.accountError | Object | In case the account has errors this field contains a json object with fields related to this error. |
3205 | com.openexchange.calendar.config | Object | A json object containing configuration data for the calendar account. |
3220 | com.openexchange.caldav.url | String | The caldav url to this calendar folder. |
3301 | com.openexchange.contacts.extendedProperties | Object | A json object containing the extended properties of an contacts folder as key value pairs. Each value can be an object, an array or a simple value itself. |
Type of folder
Number | Type |
---|---|
1 | private |
2 | public |
3 | shared |
5 | system folder |
7 | This type is no more in use (legacy type). Will be removed with a future update! |
16 | trash |
20 | pictures |
21 | documents |
22 | music |
23 | videos |
24 | templates |
Detailed task and appointment data
ID | Name | Type | Value |
---|---|---|---|
200 | title | String | Short description. |
201 | start_date | Date or Time | Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequencies always start at this date. (deprecated for tasks since v7.6.1, replaced by start_time and full_time) |
202 | end_date | Date or Time | Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments. (deprecated for tasks since v7.6.1, replaced by end_time and full_time) |
203 | note | String | Long description. |
204 | alarm | Number or Time | Specifies when to notify the participants as the number of minutes before the start of the appointment (-1 for "no alarm"). For tasks, the Time value specifies the absolute time when the user should be notified. |
209 | recurrence_type | Number | Specifies the type of the recurrence for a task sequence. See Task sequence type |
212 | days | Number | Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days). |
213 | day_in_month | Number | Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2. |
214 | month | Number | Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4. |
215 | interval | Number | Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4. |
216 | until | Date | Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included. |
217 | notification | Boolean | If true, all participants are notified of any changes to this object. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client. |
220 | participants | Array | Each element identifies a participant, user, group or booked resource as described in Participant identifier. |
221 | users | Array | Each element represents a participant as described in User participant object. User groups are resolved and are represented by their members. Any user can occur only once. |
222 | occurrences | Number | Specifies how often a recurrence should appear. May be present only if recurrence_type > 0. |
223 | uid | String | Can only be written when the object is created. Internal and external globally unique identifier of the appointment or task. Is used to recognize appointments within iCal files. If this attribute is not written it contains an automatic generated UUID. |
224 | organizer | String | Contains the email address of the appointment organizer which is not necessarily an internal user. Not implemented for tasks. |
225 | sequence | Number | iCal sequence number. Not implemented for tasks. Must be incremented on update. Will be incremented by the server, if not set. |
226 | confirmations | Array | Each element represents a confirming participant as described in Confirming participant. This can be internal and external user. Not implemented for tasks. |
227 | organizerId | Number | Contains the userId of the appointment organizer if it is an internal user. Not implemented for tasks. (Introduced with 6.20.1) |
228 | principal | String | Contains the email address of the appointment principal which is not necessarily an internal user. Not implemented for tasks. (Introduced with 6.20.1) |
229 | principalId | Number | Contains the userId of the appointment principal if it is an internal user. Not implemented for tasks. (Introduced with 6.20.1) |
401 | full_time | Boolean | True if the event is a whole day appointment or task, false otherwise. |
Task sequence type
Number | Description |
---|---|
0 | none (single event) |
1 | daily |
2 | weekly |
3 | monthly |
4 | yearly |
Participant identifier
Name | Type | Value |
---|---|---|
id | Number | User ID |
type | Number | See Participant types |
String | mail address of an external participant |
Participant types
Number | Type |
---|---|
1 | user |
2 | user group |
3 | resource |
4 | resource group |
5 | external user |
User participant object
Name | Type | Value |
---|---|---|
id | Number | User ID. Confirming for other users only works for appointments and not for tasks. |
display_name | String | Displayable name of the participant. |
confirmation | Number | See Confirmation status |
confirmmessage | String | Confirm Message of the participant |
Confirmation status
Number | Status |
---|---|
0 | none |
1 | accepted |
2 | declined |
3 | tentative |
Confirming participant
Name | Type | Value |
---|---|---|
type | Number | Either 1 = user or 5 = external user. |
String | email address of external participant | |
display_name | String | display name of external participant |
status | Number | See Confirmation status |
message | String | Confirm Message of the participant |
Detailed task data
ID | Name | Type | Value |
---|---|---|---|
300 | status | Number | Status of the task. See Task status |
301 | percent_completed | Number | How much of the task is completed. An integer number between 0 and 100. |
302 | actual_costs | Number | A monetary attribute to store actual costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99. |
303 | actual_duration | ||
304 | after_complete | Date | Deprecated. Only present in AJAX interface. Value will not be stored on OX server. |
305 | billing_information | ||
307 | target_costs | Number | A monetary attribute to store target costs of a task. Allowed values must be in the range -9999999999.99 and 9999999999.99. |
308 | target_duration | ||
309 | priority | Number | 1 = LOW, 2 = MEDIUM, 3 = HIGH |
312 | currency | ||
313 | trip_meter | ||
314 | companies | ||
315 | date_completed | ||
316 | start_time | Date or Time | Inclusive start as Date for whole day tasks and Time for normal tasks. |
317 | end_time | Date or Time | Exclusive end as Date for whole day tasks and as Time for normal tasks. |
Task status
Number | Status |
---|---|
1 | not started |
2 | in progress |
3 | done |
4 | waiting |
5 | deferred |
Detailed contact data
ID | Displayed name | Name | Type | Description |
---|---|---|---|---|
223 | uid | String | Can only be written when the object is created. Internal and external globally unique identifier of the contact. Is used to recognize contacts within vCard files. If this attribute is not written it contains an automatic generated UUID. | |
500 | Display name | display_name | String | |
501 | Given name | first_name | String | First name. |
502 | Sur name | last_name | String | Last name. |
503 | Middle name | second_name | String | |
504 | Suffix | suffix | String | |
505 | Title | title | String | |
506 | Street home | street_home | String | |
507 | Postal code home | postal_code_home | String | |
508 | City home | city_home | String | |
509 | State home | state_home | String | |
510 | Country home | country_home | String | |
511 | Birthday | birthday | Date | |
512 | Marital status | marital_status | String | |
513 | Number of children | number_of_children | String | |
514 | Profession | profession | String | |
515 | Nickname | nickname | String | |
516 | Spouse name | spouse_name | String | |
517 | Anniversary | anniversary | Date | |
518 | Note | note | String | |
519 | Department | department | String | |
520 | Position | position | String | |
521 | Employee type | employee_type | String | |
522 | Room number | room_number | String | |
523 | Street business | street_business | String | |
524 | Internal user id | user_id | Number | |
525 | Postal code business | postal_code_business | String | |
526 | City business | city_business | String | |
527 | State business | state_business | String | |
528 | Country business | country_business | String | |
529 | Number of employee | number_of_employees | String | |
530 | Sales volume | sales_volume | String | |
531 | Tax id | tax_id | String | |
532 | Commercial register | commercial_register | String | |
533 | Branches | branches | String | |
534 | Business category | business_category | String | |
535 | Info | info | String | |
536 | Manager's name | manager_name | String | |
537 | Assistant's name | assistant_name | String | |
538 | Street other | street_other | String | |
539 | City other | city_other | String | |
540 | Postal code other | postal_code_other | String | |
541 | Country other | country_other | String | |
542 | Telephone business 1 | telephone_business1 | String | |
543 | Telephone business 2 | telephone_business2 | String | |
544 | FAX business | fax_business | String | |
545 | Telephone callback | telephone_callback | String | |
546 | Telephone car | telephone_car | String | |
547 | Telephone company | telephone_company | String | |
548 | Telephone home 1 | telephone_home1 | String | |
549 | Telephone home 2 | telephone_home2 | String | |
550 | FAX home | fax_home | String | |
551 | Cellular telephone 1 | cellular_telephone1 | String | |
552 | Cellular telephone 2 | cellular_telephone2 | String | |
553 | Telephone other | telephone_other | String | |
554 | FAX other | fax_other | String | |
555 | Email 1 | email1 | String | |
556 | Email 2 | email2 | String | |
557 | Email 3 | email3 | String | |
558 | URL | url | String | |
559 | Telephone ISDN | telephone_isdn | String | |
560 | Telephone pager | telephone_pager | String | |
561 | Telephone primary | telephone_primary | String | |
562 | Telephone radio | telephone_radio | String | |
563 | Telephone telex | telephone_telex | String | |
564 | Telephone TTY/TDD | telephone_ttytdd | String | |
565 | Instantmessenger 1 | instant_messenger1 | String | |
566 | Instantmessenger 2 | instant_messenger2 | String | |
567 | Telephone IP | telephone_ip | String | |
568 | Telephone assistant | telephone_assistant | String | |
569 | Company | company | String | |
570 | image1 | String | Deprecated. Use 606 instead. | |
571 | Dynamic Field 1 | userfield01 | String | |
572 | Dynamic Field 2 | userfield02 | String | |
573 | Dynamic Field 3 | userfield03 | String | |
574 | Dynamic Field 4 | userfield04 | String | |
575 | Dynamic Field 5 | userfield05 | String | |
576 | Dynamic Field 6 | userfield06 | String | |
577 | Dynamic Field 7 | userfield07 | String | |
578 | Dynamic Field 8 | userfield08 | String | |
579 | Dynamic Field 9 | userfield09 | String | |
580 | Dynamic Field 10 | userfield10 | String | |
581 | Dynamic Field 11 | userfield11 | String | |
582 | Dynamic Field 12 | userfield12 | String | |
583 | Dynamic Field 13 | userfield13 | String | |
584 | Dynamic Field 14 | userfield14 | String | |
585 | Dynamic Field 15 | userfield15 | String | |
586 | Dynamic Field 16 | userfield16 | String | |
587 | Dynamic Field 17 | userfield17 | String | |
588 | Dynamic Field 18 | userfield18 | String | |
589 | Dynamic Field 19 | userfield19 | String | |
590 | Dynamic Field 20 | userfield20 | String | Contains a UUID if one was assigned (after 6.18.2) |
592 | distribution_list | Array | If this contact is a distribution list, then this field is an array of objects. Each object describes a member of the list as defined in Distribution list member. | |
594 | Number of distributionlists | number_of_distribution_list | Number | |
596 | number_of_images | Number | ||
597 | image_last_modified | Timestamp | ||
598 | State other | state_other | String | |
599 | file_as | String | ||
601 | image1_content_type | String | ||
602 | mark_as_distributionlist | Boolean | ||
605 | Default address | default_address | Number | |
606 | image1_url | String | ||
608 | useCount | Number | This column is only used for sorting purposes, if requested within an get or list request this column will always have the value 0. In case of sorting purposes the column 609 is also available, which places global address book contacts at the beginning of the result. If 609 is used, the order direction (ASC, DESC) is ignored. | |
616 | yomiFirstName | String | Kana based representation for the First Name. Commonly used in japanese environments for searchin/sorting issues. (since 6.20) | |
617 | yomiLastName | String | Kana based representation for the Last Name. Commonly used in japanese environments for searchin/sorting issues. (since 6.20) | |
618 | yomiCompany | String | Kana based representation for the Company. Commonly used in japanese environments for searchin/sorting issues. (since 6.20) | |
619 | addressHome | String | Support for Outlook 'home' address field. (since 6.20.1) | |
620 | addressBusiness | String | Support for Outlook 'business' address field. (since 6.20.1) | |
621 | addressOther | String | Support for Outlook 'other' address field. (since 6.20.1) |
Distribution list member
Name | Type | Value |
---|---|---|
id | String | Object ID of the member's contact if the member is an existing contact. |
folder_id | String | Parent folder ID of the member's contact if the member is an existing contact (preliminary, from 6.22 on). |
display_name | String | Display name |
String | Email address (mandatory before 6.22, afterwards optional if you are referring to an internal contact) | |
mail_field | Number | Which email field of an existing contact (if any) is used for the mail field. See Mail fields. |
Mail fields
Number | Field |
---|---|
0 | independent contact |
1 | default email field (email1) |
2 | second email field (email2) |
3 | third email field (email3) |
Detailed appointment data
ID | Name | Type | Value |
---|---|---|---|
206 | recurrence_id | Number | Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions. |
207 | recurrence_position | Number | 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0. |
208 | recurrence_date_position | Date | Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0. |
210 | change_exceptions | Array | An array of Dates, representing all change exceptions of a sequence. |
211 | delete_exceptions | Array | An array of Dates, representing all delete exceptions of a sequence. |
400 | location | String | Location |
402 | shown_as | Number | Describes, how this appointment appears in availability queries. See Appointment availability |
408 | timezone | String | Timezone |
410 | recurrence_start | Date | Start of a sequence without time |
ignore_conflicts | Boolean | Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client. |
Appointment availability
Number | Value |
---|---|
1 | reserved |
2 | temporary |
3 | absent |
4 | free |
Detailed mail data
ID | Name | Type | Value |
---|---|---|---|
102 | color_label | Number | Color number used by Outlook to label the object. The assignment of colors to numbers is arbitrary and specified by the client. The numbers are integer numbers between 0 and 10 (inclusive). |
600 | id | String | Object ID |
601 | folder_id | String | Object ID of the parent folder |
602 | attachment | Boolean | Specifies whether this mail has attachments. |
603 | from | Array | Each element is a two-element array specifying one from. The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values. |
604 | to | Array | Each element is a two-element array (see the from field) specifying one receiver. |
605 | cc | Array | Each element is a two-element array (see the from field) specifying one carbon-copy receiver. |
606 | bcc | Array | Each element is a two-element array (see the from field) specifying one blind carbon-copy receiver. |
607 | subject | String | Subject line. |
608 | size | Number | Size of the mail in bytes. |
609 | sent_date | Time | Date and time as specified in the mail by the sending client. |
610 | received_date | Time | Date and time as measured by the receiving server. |
611 | flags | Number | Various system flags. A sum of zero or more of values described in Mail system flags. See javax.mail.Flags.Flag for details. |
612 | level | Number | Zero-based nesting level in a thread. |
613 | disp_notification_to | String | Content of message's header “Disposition-Notification-To” |
614 | priority | Number | Value of message's “X-Priority” header. See X-Priority header. |
615 | msg_ref | String | Message reference on reply/forward. |
651 | flag_seen | String | Special field to sort mails by seen status |
652 | account_name | String | Message's account name. |
653 | account_id | int | Message's account identifier. Since v6.20.2 |
user | Array | An array with user-defined flags as strings. | |
headers | Object | An object with a field for every non-standard header. The header name is the field name. The header value is the value of the field as string. | |
attachments | Array | Each element is an attachment as described in Attachment. The first element is the mail text. If the mail has multiple representations (multipart-alternative), then the alternatives are placed after the mail text and have the field disp set to alternative. | |
nested_msgs | Array | Each element is a mail object as described in this table, except for fields id, folder_id and attachment. | |
truncated | boolean | true/false if the mail content was trimmed. Since v7.6.1 | |
source | String | RFC822 source of the mail. Only present for action=get&attach_src=true |
|
cid | String | The value of the "Content-ID" header, if the header is present. | |
654 | original_id | String | The original mail identifier (e.g. if fetched from "virtual/all" folder). |
655 | original_folder_id | String | The original folder identifier (e.g. if fetched from "virtual/all" folder). |
656 | content_type | String | The Content-Type of a mail; e.g. multipart/mixed; boundary="-0123456abcdefg--" . |
657 | answered | String | Special field to sort mails by answered status. |
658 | forwarded | String | Special field to sort mails by forwarded status. Note that mail service needs either support a \Forwarded system flag or a $Forwarded user flag |
659 | draft | String | Special field to sort mails by draft flag. |
660 | flagged | String | Special field to sort mails by flagged status. |
661 | date | String | The date of a mail message. As configured, either the internal received date or mail's sent date (as given by "Date" header). Supposed to be the replacement for sent_date (609) or received_date (610) to let the Open-Xchange Middleware decide based on configuration for com.openexchange.mail.preferSentDate property what to consider. Supported at both - columns parameter and sort parameter. |
662 | text_preview_if_available | String | A mail's text preview. Only returned if immediately available from mail server. An empty string signals that mail has no body content. NULL signals not available. |
663 | text_preview | String | A mail's text preview. An empty string signals that mail has no body content. Might be slow. |
664 | authenticity_preview | JSON | The light-weighted version of the authenticity status result, i.e. the status string. |
665 | authenticity | JSON | The heavy-weighted version of the authenticity status results as described in MailData. |
666 | sender | Array | Each element is a two-element array specifying one sender. The first element of each address is the personal name, the second element is the email address. Missing address parts are represented by null values. |
Mail system flags
Number | Description |
---|---|
1 | answered |
2 | deleted |
4 | draft |
8 | flagged |
16 | recent |
32 | seen |
64 | user |
128 | spam |
256 | forwarded |
512 | read acknowledged |
X-Priority header
Number | Description |
---|---|
0 | No priority |
5 | Very Low |
4 | Low |
3 | Normal |
2 | High |
1 | Very High |
Attachment
Name | Type | Value |
---|---|---|
id | String | Object ID (unique only inside the same message) |
content_type | String | MIME type |
content | String | Content as text. Present only if easily convertible to text. |
filename | String | Displayed filename (mutually exclusive with content). |
size | Number | Size of the attachment in bytes. |
disp | String | Attachment's disposition: null, inline, attachment or alternative. |
Detailed infoitem data
ID | Name | Type | Value |
---|---|---|---|
108 | object_permissions | Array | Each element is an object described in Object Permission object (preliminary, available with 7.8.0). |
109 | shareable | Boolean | (read-only) Indicates if the item can be shared (preliminary, available with 7.8.0). |
700 | title | String | Title |
701 | url | String | Link/URL |
702 | filename | String | Displayed filename of the document. |
703 | file_mimetype | String | MIME type of the document. The client converts known types to more readable names before displaying them. |
704 | file_size | Number | Size of the document in bytes. |
705 | version | Number | Version number of the document. New documents start at 1. Every update increments the version by 1. |
706 | description | String | Description |
707 | locked_until | Time | The time until which this item will presumably be locked. Only set if the document is currently locked, 0 otherwise. |
708 | file_md5sum | String | MD5Sum of the document, if available. |
709 | version_comment | String | A version comment is used to file a changelog for the file. |
710 | current_version | Boolean | “true” if this version is the current version “false” otherwise. Note: This is not writeable |
711 | number_of_versions | Number | The number of versions of the infoitem. In case the number is unknown this field is set to -1. Note: This is not writeable. |
712 | origin | String | The file's origin path. Since 7.10.0. |
713 | capture_date | Time | The capture/creation date of the media resource. Since 7.10.2. |
714 | geolocation | String | The geo location of the media resource as a parenthesized latitude and longitude pair. Since 7.10.2. |
715 | width | Number | Thhe width of the media resource. Since 7.10.2. |
716 | height | Number | The height of the media resource. Since 7.10.2. |
717 | camera_make | Time | The name of the camera manufacturer. Since 7.10.2. |
718 | camera_model | Time | The name of the camera model. Since 7.10.2. |
719 | camera_iso_speed | Number | The ISO speed value of a camera or input device. Since 7.10.2. |
720 | camera_aperture | Number | The aperture used to create the photo (f-number). Since 7.10.2. |
721 | camera_exposure_time | Number | The length of the exposure, in seconds. Since 7.10.2. |
722 | camera_focal_length | Number | The focal length used to create the photo, in millimeters. Since 7.10.2. |
723 | media_meta | JSON | The meta information for the media resource. Since 7.10.2. |
724 | media_status | String | The status of parsing/analyzing media meta-data from the media resource. Since 7.10.2. |
725 | media_date | Time | The media date represents the capture date, which falls-back to last-modified date if there is capture date. Useful for sorting. Since 7.10.2. |
726 | unique_id | String | (read-only) Lifetime unique identifier of the file that does not change e.g. after move or rename operations. |
751 | sequence_number | Number | Sequence number of the infoitem. |
7010 | com.openexchange.share.extendedObjectPermissions | Array | Each element is an object described in Extended object permission object. Read Only, Since 7.8.0. |
7020 | com.openexchange.realtime.resourceID | String | The resource identifier for the infoitem for usage within the realtime component. Read Only, Since 7.8.0. |
7030 | com.openexchange.file.storage.mail.mailMetadata | Object | Additional metadata for items in the mail file storage. Read Only. |
7040 | com.openexchange.file.sanitizedFilename | String | A sanitized version of the filename. Which prevents end users from being confused by special characters, e.g. RTLO (0x202E). Read Only. |
Object Permission object
Name | Type | Value |
---|---|---|
bits | Number | A number as described in Object Permission flags. |
entity | Number | User ID of the user or group to which this permission applies. |
group | Boolean | true if entity refers to a group, false if it refers to a user. |
type | String | The recipient type, i.e. one of "user", "group", "guest", "anonymous" (required if no internal "entity" defined). |
password | String | An additional secret / pin number an anonymous user needs to enter when accessing the share (for type "anonymous", optional) . |
email_address | String | The e-mail address of the recipient (for type "guest"). |
display_name | String | The display name of the recipient (for type "guest", optional). |
contact_id | String | The object identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", optional). |
contact_folder | String | The folder identifier of the corresponding contact entry if the recipient was chosen from the address book (for type "guest", required if "contact_id" is set). |
expiry_date | Time | The end date / expiration time after which the share link is no longer accessible (for type "anonymous", optional). |
Extended object permission object
Name | Type | Value |
---|---|---|
entity | Number | Identifier of the permission entity (i.e. user-, group- or guest-ID). |
bits | Number | A number as described in Object Permission flags. |
type | String | "user" for an internal user, "group" for a group, "guest" for a guest, or "anonymous" for an anonymous permission entity. |
display_name | String | A display name for the permission entity. |
contact | Object | A (reduced) set of Detailed contact data for "user" and "guest" entities. |
share_url | String | The share link for "anonymous" entities. |
password | String | The optionally set password for "anonymous" entities. |
expiry_date | Date | The optionally set expiry date for "anonymous" entities. |
Object permission flags
Bits | Value |
---|---|
0 | The numerical value indicating no object permissions. |
1 | The numerical value indicating read object permissions. |
2 | The numerical value indicating write object permissions. This implicitly includes the “read” permission (this is no bitmask). |
Attachment object
ID | Name | Type | Description |
---|---|---|---|
800 | folder | Number | The ID of the first Folder in which the attached object resides. |
801 | attached | Number | The object id of the object this attachement is attached to. |
802 | module | Number | The Module of this Object. Possible values are described in Attachment module |
803 | filename | String | The filename of the attached file. |
804 | file_size | Number | The file size (in bytes) of the attached file. |
805 | file_mimetype | String | The MIME-Type of the attached file |
806 | rft_flag | Boolean | If the attachment is a RTF Attachment of Outlook. (Outlook descriptions can be stored as RTF Documents). |
Attachment module
Number | Name |
---|---|
1 | Appointment |
4 | Task |
7 | Contact |
137 | Infostore |
Mail account data
ID | Name | Type | Value |
---|---|---|---|
1001 | id | Number | Account ID |
1002 | login | String | The login. |
1003 | password | String | The (optional) password. |
1004 | mail_url | String | The mail server URL; e.g. "imap://imap.somewhere.com:143". URL is preferred over single fields (like mail_server, mail_port, etc.) |
1005 | transport_url | String | The transport server URL; e.g. "smtp://smtp.somewhere.com:25". URL is preferred over single fields (like transport_server, transport_port, etc.) |
1006 | name | String | Account's display name. |
1007 | primary_address | String | User's primary address in account; e.g. "someone@somewhere.com" |
1008 | spam_handler | String | The name of the spam handler used by account. |
1009 | trash | String | The name of the default trash folder. |
1010 | sent | String | The name of the default sent folder. |
1011 | drafts | String | The name of the default drafts folder. |
1012 | spam | String | The name of the default spam folder. |
1013 | confirmed_spam | String | The name of the default confirmed-spam folder. |
1014 | confirmed_ham | String | The name of the default confirmed-ham folder. |
1015 | mail_server | String | The mail server's hostname or IP address. |
1016 | mail_port | Number | The mail server's port. |
1017 | mail_protocol | String | The mail server's protocol. Always use basic protocol name. E.g. use "imap" instead of "imaps" |
1018 | mail_secure | Boolean | Whether to establish a secure connection to mail server (SSL, TLS). |
1019 | transport_server | String | The transport server's hostname or IP address. |
1020 | transport_port | Number | The transport server's port. |
1021 | transport_protocol | String | The transport server's protocol. Always use basic protocol name. E.g. use "smtp" instead of "smtps" |
1022 | transport_secure | Boolean | Whether to establish a secure connection to transport server (SSL, TLS). |
1023 | transport_login | String | The transport login. Please see "transport_auth" for the handling of this field. |
1024 | transport_password | String | The transport password. Please see "transport_auth" for the handling of this field. |
1025 | unified_inbox_enabled | Boolean | If enabled for Unified INBOX |
1026 | trash_fullname | String | Path to default trash folder. Preferred over "trash" |
1027 | sent_fullname | String | Path to default sent folder. Preferred over "sent" |
1028 | drafts_fullname | String | Path to default drafts folder. Preferred over "drafts" |
1029 | spam_fullname | String | Path to default spam folder. Preferred over "spam" |
1030 | confirmed_spam_fullname | String | Path to default confirmed-spam folder. Preferred over "confirmed_spam" |
1031 | confirmed_ham_fullname | String | Path to default confirmed-ham folder. Preferred over "confirmed_ham" |
1032 | pop3_refresh_rate | Number | The interval in minutes the POP3 account is refreshed |
1033 | pop3_expunge_on_quit | Boolean | Whether POP3 messages shall be deleted on actual POP3 account after retrieval or not |
1034 | pop3_delete_write_through | Boolean | If option "pop3_expunge_on_quit" is disabled, this property defines whether a delete in local INBOX also deletes affected message in actual POP3 account |
1035 | pop3_storage | String | The name of POP3 storage provider, default is "mailaccount" |
1036 | pop3_path | String | Path to POP3's virtual root folder in storage, default is name of the POP3 account beside default folders |
1037 | personal | String | The customizable personal part of email address |
1038 | reply_to | String | The customizable reply-to email address |
1039 | addresses | String | The comma-separated list of available E-Mail addresses including aliases. !! Only available for primary mail account !! |
1040 | meta | JSON | data Stores arbitrary JSON data as specified by client associated with the mail account |
1041 | archive | String | The name of the archive folder. Currently not functional! |
1042 | archive_fullname | String | The full name of the archive folder. Currently not functional! |
1043 | transport_auth | String | Available since v7.6.1 Specifies the source for mail transport (SMTP) credentials. See Credential source. |
1044 | mail_starttls | Boolean | Available since v7.8.2 Whether to establish a secure connection to mail server via STARTTLS. |
1045 | transport_starttls | Boolean | Available since v7.8.2 Whether to establish a secure connection to transport server via STARTTLS. |
1046 | root_folder | String | Available since v7.8.3 Specifies the identifier of an account's root folder |
1047 | mail_oauth | Integer | Available since v7.8.3 Specifies the identifier of the associated OAuth account for mail access |
1048 | transport_oauth | Integer | Available since v7.8.3 Specifies the identifier of the associated OAuth account for mail transport |
1049 | mail_disabled | Boolean | Available since v7.8.4 Signals whether mail account is currently disabled due to too many failed login attempts |
1050 | transport_disabled | Boolean | Available since v7.8.4 Signals whether transport account is currently disabled due to too many failed login attempts |
1051 | secondary | Boolean | Available since v7.10.6 Signals whether the account is a secondary mail/transport account |
1052 | deactivated | Boolean | Available since v7.10.6 Signals whether the account has been deactivated by the user |
Credential source
Value | Description |
---|---|
Signals to use the same credentials as given in associated mail store (IMAP, POP3). | |
custom | Signals that individual credentials are supposed to be used (fields "transport_login" and "transport_password" are considered). |
none | Means the mail transport does not support any authentication mechanism (rare case!) |
Detailed user data
ID | Displayed name | Name | Type | Value |
---|---|---|---|---|
610 | Aliases | aliases | Array | The user's aliases |
611 | Time zone | timezone | String | The time zone ID. |
612 | Locale | locale | String | The name of user's entire locale, with the language, country and variant separated by underbars. E.g. "en", "de_DE" |
613 | Groups | groups | Array | The IDs of user's groups |
614 | Contact ID | contact_id | Number | The contact ID of the user |
615 | Login info | login_info | String | The user's login information |
616 | Guest Created By | guest_created_by | Number | The ID of the user who has created this guest in case this user represents a guest user; it is 0 for regular users (preliminary, available with v7.8.0) |
Messaging message columns
Name | Description |
---|---|
id | The id attribute |
folderId | The folder attribute |
contentType | The "Content-Type" header |
from | The "From" header |
to | The "To" header |
cc | The "Cc" header |
bcc | The "Bcc" header |
subject | The "Subject" header |
size | The size attribute |
sentDate | The "Date" header |
receivedDate | The receivedDate attribute |
flags | The flags attribute |
threadLevel | The threadLevel attribute |
dispositionNotificationTo | The "Disposition-Notification-To" header. |
priority | The "X-Priority" header |
colorLabel | The colorLabel attribute |
url | The url attribute |
body | The content attribute |
headers | The headers attribute |
picture | The url to the message picture. |
Group data
ID | Name | Type | Value |
---|---|---|---|
1 | id | String | Object ID |
5 | last_modified | Time | Date and time of the last modification. |
700 | name | String | The name of the group. |
701 | display_name | String | The display name of the group. |
702 | members | String | A comma separated list of user ids. |
Flags and bitmasks
Permission flags
Bits | Value |
---|---|
0-6 | Folder permissions: |
0 (no permissions) | |
1 (see the folder) | |
2 (create objects in folder) | |
4 (create subfolders) | |
64 (all permissions) | |
7-13 | Read permissions for objects in folder: |
0 (no permissions) | |
1 (read only own objects) | |
2 (read all objects) | |
64 (all permissions) | |
14-20 | Write permissions for objects in folder: |
0 (no permissions) | |
1 (modify only own objects) | |
2 (modify all objects) | |
64 (all permissions) | |
21-27 | Delete permissions for objects in folder: |
0 (no permissions) | |
1 (delete only own objects) | |
2 (delete all objects) | |
64 (all permissions) | |
28 | Admin flag: |
0 (no permissions) | |
1 (every operation modifying the folder in some way requires this permission (e.g. changing the folder name) | |
29 | User flag support: (for Mail folder only) |
0 (no user flag support) | |
1 (user flag support) | |
30 | Rename support: (for Mail folder only) |
0 (not allowed to rename) | |
1 (allowed to rename) |
Capabilities
Bit | Description |
---|---|
0 | Mailing system supports permissions. |
1 | Mailing system supports ordering mails by their thread reference. |
2 | Mailing system supports quota restrictions. |
3 | Mailing system supports sorting. |
4 | Mailing system supports folder subscription. |
Note: Capabilities describe the entire mailing system (mail account), not the specific folder in which they are transmitted. E.g. bit 4 of the capabilities on the user's inbox describes whether subscriptions are supported by the default account, even though the inbox itself cannot be unsubscribed because it's a standard folder.
Standard Folder Types
Bit | Description |
---|---|
0 | No default folder. |
1 | Task. |
2 | Calendar. |
3 | Contact. |
7 | Inbox. |
8 | Infostore. |
9 | Drafts. |
10 | Sent. |
11 | Spam. |
12 | Trash. |
Supported Capabilities
Name | Description |
---|---|
permissions | Folder storage supports permissions. |
publication | Folder storage supports folder publication. Deprecated with v7.10.2! |
quota | Folder storage supports quota restrictions. |
sort | Folder storage supports sorting. |
subscription | Folder storage supports folder subscription. |
Event Flags
Name | Description |
---|---|
attachments | The event contains at least one attachment. |
alarms | The calendar user has at least one alarm associated with the event. |
scheduled | Event is a group-scheduled meeting with an organizer. |
organizer | The calendar user is the organizer of the meeting. |
organizer_on_behalf | The calendar user is the organizer of the meeting, and the current user acts on behalf of him. |
attendee | The calendar user is attendee of the meeting. |
attendee_on_behalf | The calendar user is attendee of the meeting, and the current user acts on behalf of him. |
private | Event is classified private, so is invisible for others. |
confidential | Event is classified as confidential, so only start and end time are visible for others. |
transparent | Event is transparent for the calendar user, i.e. invisible to free/busy time searches. |
event_tentative | Indicates that the event's overall status is tentative. |
event_confirmed | Indicates that the event's overall status is definite. |
event_cancelled | Indicates that the event's overall status is cancelled. |
needs_action | The calendar user's participation status is needs action. |
accepted | The calendar user's participation status is accepted. |
declined | The calendar user's participation status is declined. |
tentative | The calendar user's participation status is tentative. |
delegated | The calendar user's participation status is delegated. |
series | The event represents the master of a recurring event series, or an expanded (regular) occurrence of a series. |
overridden | The event represents an exception / overridden instance of a recurring event series. |
first_occurrence | The event represents the first occurrence of a recurring event series. |
last_occurrence | The event represents the last occurrence of a recurring event series. |
Mail filter
This chapter gives a detailed description of the mail filter module. It should be uses as a source of information in addition to the http api.
First of all the main structure of a mail filter script is, that it has different rules. Each of them contains one command. This command takes a test condition which executes the actions given in that command if the test condition is true.
The test condition consists of a test command and some arguments for this command depending on the command itself. Because the available tests depend on the mail filter server, these tests must be determined at runtime. So that no test field is transferred to the server which it isn't able to handle. Examples for tests are address, allof and anyof.
Each test has a special comparison. The list of available comparisons depends on the test given and the mail filter server configuration so they have to be determined at runtime too.
Each time you want to do some action on a mail you need a so called action command. This describes what to do with a mail. To action commands the same applies as to the test commands and their comparison types, they must be determined at runtime.
All those dynamical values can be fetched via a config object at startup. This object shows the capabilities of the server to the client. This allows the client to show only the capabilities the server actually has to the user and to send only objects to the server which produce no errors on the server side.
To deal with this high flexibility of mail filters this specification can be roughly divided into 2 parts. A non-changing core and dynamical extensions. The core specification is that each rule consists of a name, an ID, a value showing if this rule is active or not and a tag which can be set on a rule to mark that rule for a special purpose. Furthermore each rule takes a test object, specifying in what case the following actions are triggered, and one or many actioncommands, specifying the actions itself.
The objects for the tests and the actions are dynamical, so the set presented in this specification may be changed over the time, but only compatible changes are allowed to the objects, otherwise new test or action objects have to be introduced. Due to the fact that not every sieve implementation will offer all the capabilities written in this document, the server will sent his configuration if a special request is made. This configuration will show which of the tests and which of the actions are allowed. So for example if the server signals that it is capable of handling vacation, sending a vacation object as action is safe.
Furthermore some tests use a comparison field as stated above which specifies how the fields are compared. The values of this field must also be determined at runtime. So in the configuration object there is a special part which shows the comparisons which are available. Note that not all comparisons can be used with every test. Some of them are denoted to a special test, which is described in Possible comparisons.
Possible tests
Name | Description |
---|---|
address | This test type applies to addresses only. So it may be used for all header fields which contain addresses. This test returns true if any combination of the header-list and values-list arguments match. |
envelope | This test applies to the envelope of a mail. This test isn't used under normal circumstances as the envelope isn't accessible in all mail setups. This test returns true if any combination of the header-list and values-list arguments match. |
true | A test for a true result (can be used if an action command should be executed every time). |
not | Negates a given test. |
size | Deals with the size of the mail. |
currentdate | Compares a given date with the current date. |
header | Tests against all headers of a mail. So with this test in contrast to the address test also fields such as subject can be handled. This test returns true if any combination of the header-list and values-list arguments match. |
body | Tests against the content of a mail. |
allof | Defines an AND condition between several tests. |
anyof | Defines an OR condition between several tests. |
date | Compares a given date with the given date header. |
exists | Tests whether a list of headers exist or not. |
Simplified tests
The mailfilter v2 api suppports some simplified rules.
Name | Description |
---|---|
subject | A convenience test to match against a mails subject. |
from | A convenience test to match against a mails From header. |
to | A convenience test to match against a mails To header. |
cc | A convenience test to match against a mails Cc header. |
anyRecipient | A convenience test to match against a mails To and Cc headers. |
mailingList | Matches against common mailing list headers for simple filtering of mailing list mails. |
Possible comparisons
Name | Description |
---|---|
is | If a field is equal to a given value. |
not is | If a field is unequal to a given value. |
contains | If a field contains a given value at any position. |
not contains | If a field not contains a given value at any position. |
matches | Tests if the value matches the value in the specified field ("*" matches zero or more characters, "?" matches a single character, to use these characters themselves they have to be escaped via backslash). |
not matches | Tests if the value doesn't matches the value in the specified field ("*" matches zero or more characters, "?" matches a single character, to use these characters themselves they have to be escaped via backslash). |
regex | Tests if a given regular expression matches with the value present in the specified field. |
not regex | Tests if a given regular expression doesn't matches with the value present in the specified field. |
startswith | Like matches but adds an additional wildcard character at the end of the value. |
not startswith | Like 'not matches' but adds an additional wildcard character at the end of the value. |
endswith | Like matches but adds an additional wildcard character at the beginning of the value. |
not endswith | Like 'not matches' but adds an additional wildcard character at the beginning of the value. |
Possible currentdate comparisons
Name | Description |
---|---|
is | Used in the date test to check for a value equal to the given one. |
not is | Used in the date test to check for a value unequal to the given one. |
ge | Used in the date test to check for a value greater or equal to the given one. |
not ge | Used in the date test to check for a value smaller to the given one. |
le | Used in the date test to check for a value less or equal to the given one. |
not le | Used in the date test to check for a value greater to the given one. |
Possible address parts
Name | Description |
---|---|
all | The hole mail address. This is also the default. |
localpart | The local part of the mail address. |
domain | The domain part of the mail address. |
Possible size comparisons
Name | Description |
---|---|
over | Used in the size test to check for a value greater than the given one. |
not over | Used in the size test to check for a value smaller or equal to the given one. |
under | Used in the size test to check for a value less than the given one. |
not under | Used in the size test to check for a value greater or equal to the given one. |
Possible extensions
Name | Description |
---|---|
content | An extension used in conjunction with the body test to define the content which should be considered. This extension will need a parameter specifying the mime-type of the part of the message which will be searched. |
text | An extension used in conjunction with the body test to define that only the text of the body should be considered in this test. This extension takes no parameter. |
Structure of tests
This section describes the structures of tests.
address-test
Name | Type | Value | Description |
---|---|---|---|
id | String | address | A string describing the test command. |
comparison | String | Available types can be found in the config object. (see Possible comparisons). | |
addresspart | String | The address part which should be tested, see Possible address parts. | |
headers | Array | A string array containing the header fields. | |
values | Array | A string array containing the value for the header fields. The test will be true if any of the strings matches. |
envelope-test
Name | Type | Value | Description |
---|---|---|---|
id | String | envelope | A string describing the test command. |
comparison | String | Available types can be found in the config object. (see Possible comparisons). | |
addresspart | String | The address part which should be tested, see Possible address parts. | |
headers | Array | A string array containing the header fields. | |
values | Array | A string array containing the value for the header fields. The test will be true if any of the strings matches. |
true-test
Name | Type | Value | Description |
---|---|---|---|
id | String | true | A string describing the test command. |
not-test
Name | Type | Value | Description |
---|---|---|---|
id | String | not | A string describing the test command. |
test | Object | One of the test objects which result will be negated. |
size-test
Name | Type | Value | Description |
---|---|---|---|
id | String | size | A string describing the test command. |
comparison | String | Only two types are valid here. A description can be found in Possible size comparisons. | |
size | Number | A number specifying the size for this comparison, in bytes. |
currentdate-test
Name | Type | Value | Description |
---|---|---|---|
id | String | currentdate | A string describing the test command. |
comparison | String | Only three types are valid here. A description can be found in Possible currentdate comparisons. | |
datepart | String | A string containing the string "date", "weekday" or "time" as we only allow fix date, time and weekday comparisions for now. | |
datevalue | Array | A value array containing the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 to 6, reflecting the equivalent weekday, starting from Sunday through Saturday, i.e. 0 - Sunday, ..., 6 - Saturday. The test will be true if any of the values matches | |
zone | String | The optional timezone which should be used for the test. E.g. "+0100". If omitted the current timezone of the user is used. |
header-test
Name | Type | Value | Description |
---|---|---|---|
id | String | header | A string describing the test command. |
comparison | String | Available types can be found in the config object. (see Possible comparisons). | |
headers | Array | A string array containing the header fields. | |
values | Array | A string array containing the values for the header fields. The test will be true if any of the strings matches. |
allof-test
Name | Type | Value | Description |
---|---|---|---|
id | String | allof | A string describing the test command. |
tests | Array | A array of tests. |
anyof-test
Name | Type | Value | Description |
---|---|---|---|
id | String | anyof | A string describing the test command. |
tests | Array | A array of tests. |
body-test
Name | Type | Value | Description |
---|---|---|---|
id | String | body | A string describing the test command. |
comparison | String | Available types can be found in the config object. (see Possible comparisons). | |
extensionskey | String | The extension key can be one of the value found in Possible extensions. | |
extensionsvalue | String | A value for the given key. If the key has no value (see Possible extensions for this information) the value given here is ignored. | |
values | Array | A string array containing the values for the body. The test will be true if any of the strings matches. |
date-test
Name | Type | Value | Description |
---|---|---|---|
id | String | date | A string describing the test command. |
comparison | String | Only three types are valid here. A description can be found in Possible currentdate comparisons. | |
header | String | The header field to test against. | |
datepart | String | A string containing the string "date", "weekday" or "time" as we only allow fix date, time and weekday comparisions for now. | |
datevalue | Array | A value array containing the corresponding value to the datepart. For "date" and "time" this will be an array of "Date" (unix timestamp). For "weekday", it will be an array of integers ranging from 0 to 6, reflecting the equivalent weekday, starting from Sunday through Saturday, i.e. 0 - Sunday, ..., 6 - Saturday. The test will be true if any of the values matches | |
zone | String | The optional timezone which should be used for the test. E.g. "+0100". If omitted the current timezone of the user is used. |
exists-test
Name | Type | Value | Description |
---|---|---|---|
id | String | exists | A string describing the test command. |
headers | Array | A string array containing the header fields. |
simplified-header-test
Name | Type | Value | Description |
---|---|---|---|
id | String | A string describing a simplified test command. | |
comparison | String | Available types can be found in the config object (see Possible comparisons). Defaults to "contains". | |
values | Array | A string array containing the values for the header fields. The test will be true if any of the strings matches. |
Possible action commands
Name | Description |
---|---|
keep | Keeps a mail non-changed. |
discard | Discards a mail without any processing. |
redirect | Redirects a mail to a given e-mail address. |
move | Moves a mail into a given subfolder (the syntax of the subfolder given here must be the correct syntax of the underlying IMAP-server and is up to the GUI to detect things such as altnamespace or unixhierarchysep). |
reject | Rejects the mail with a given text. |
stop | Stops any further progressing of a mail. |
vacation | Creates a vacation mail. |
setflag | Set flags of a mail. |
addflag | Adds flags to a mail. |
notify | Adds a notification. |
pgp | Encrypts a mail via pgp. |
Structure of action commands
This section describes the structures of action commands.
keep-command
Name | Type | Value | Description |
---|---|---|---|
id | String | keep | A string defining the object itself. |
discard-command
Name | Type | Value | Description |
---|---|---|---|
id | String | discard | A string defining the object itself. |
redirect-command
Name | Type | Value | Description |
---|---|---|---|
id | String | redirect | A string defining the object itself. |
to | String | A string containing where the mail should be redirected to. | |
copy | Boolean | An optional boolean flag. If set the :copy argument will be added to the redirect command. See RFC 3894 for further details. |
move-command
Name | Type | Value | Description |
---|---|---|---|
id | String | move | A string defining the object itself. |
into | String | This string takes the object id of the destination mail folder as specified in the HTTP API of the groupware. | |
copy | Boolean | An optional boolean flag. If set the :copy argument will be added to the fileinto command. See RFC 3894 for further details. |
reject-command
Name | Type | Value | Description |
---|---|---|---|
id | String | reject | A string defining the object itself. |
text | String | A string containing the reason why the mail is rejected. |
stop-command
Name | Type | Value | Description |
---|---|---|---|
id | String | stop | A string defining the object itself. |
vacation-command
Name | Type | Value | Description |
---|---|---|---|
id | String | vacation | A string defining the object itself. |
days | Integer | The days for which a vacation text is returned. | |
addresses | Array | The addresses for which this vacation is responsible. That means for which addresses out of the aliases array of the user defining this filter, vacations will be sent. | |
from | String or Array | Support for the ':from' tag. Specifies the value of the from header for the auto-reply mail, e.g. Foo Bear foo.bear@ox.io (Since 7.8.1). The array of strings should be a simple JSONArray with length 2; the first element should include the personal part of the e-mail address and the second element the actual e-mail address. If only the e-mail address is available, that should be the only element of the array. | |
subject | String | The new subject for the returned message (can be left empty, when only adding RE:). | |
text | String | The vacation text itself. |
addflag-command
Name | Type | Value | Description |
---|---|---|---|
id | String | addflags | A string defining the object itself. |
flags | Array | An array containing the flags which should be added to that mail. A flag can be either a system flag or a user flag. System flags begin with a backslash (\) and can be one of the ones describes in Flags. System flags are case-insensitive. User flags begin with a dollar sign ($) and can contain any ASCII characters between 0x21 (!) and 0x7E (~), inclusive, except for the characters 0x22, 0x25, 0x28, 0x29, 0x2A, 0x5C, 0x5D and 0x7B, which correspond to "%()*]{ Mail color flags as used by OX are implemented by user flags of the form $cl_n, where n is a number between 1 and 10, inclusive. See RFC 3501 for further details on IMAP flags and their meanings. |
setflag-command
Name | Type | Value | Description |
---|---|---|---|
id | String | setflags | A string defining the object itself. |
flags | Array | An array containing the flags which should be set. A flag can be either a system flag or a user flag. System flags begin with a backslash () and can be one of the ones describes in Flags. System flags are case-insensitive. User flags begin with a dollar sign ($) and can contain any ASCII characters between 0x21 (!) and 0x7E (~), inclusive, except for the characters 0x22, 0x25, 0x28, 0x29, 0x2A, 0x5C, 0x5D and 0x7B, which correspond to "%()*]{ Mail color flags as used by OX are implemented by user flags of the form $cl_n, where n is a number between 1 and 10, inclusive. See RFC 3501 for further details on IMAP flags and their meanings. |
Flags
Name |
---|
\seen |
\answered |
\flagged |
\deleted |
\draft |
\recent |
notify-command
Name | Type | Value | Description |
---|---|---|---|
id | String | notify | A string defining the object itself. |
message | String | the content of the notification message. | |
method | String | the method of the notification message, e.g. "mailto:012345678@sms.gateway". |
pgp-command
Name | Type | Value | Description |
---|---|---|---|
id | String | pgp | A string defining the object itself. |
keys | Array | The public keys as string which should be used for encryption. |
Advanced Search
This chapter describes the search module in more detail. Each search request contains a JSON object representing the search term. The search term is embedded
in a wrapping JSON object with the field filter
, like {"filter":[search term]}
. In general the structure of a search
term is in prefix notation, meaning the operator is written before its operands: [">", 5, 2]
represents the condition
"5 > 2".
Operators
There are two kinds of search operators, comparison operators and logic operators.
Comparison operators
Comparison operators compare two operands with one another. The exception is the "isNull" operator which has only one operand which must be a field name. The following operators are available:
Operator | Description |
---|---|
">" | greater |
"<" | smaller |
"=" | equal |
"<=" | smaller or equal |
">=" | greater or equal |
"<>" | unequal |
"isNull" | is NULL |
Logic operators
Logic operators combine search expressions. Whereby the logic operator "not" has exactly one operand, the other logic operators can have any number of operands. Each operand must be an array representing a nested search expression.
Operator |
---|
"not" |
"and" |
"or" |
Operands
Each operator needs one or more operands. There are different types of operands:
- Constant
- Field
- Attachment
- Header
Constant
Primitive JSON types are interpreted as constants, but arrays are not valid operands for comparison operators!
Field
A field operand is a JSON object with the member field
specifying the field name, e.g. {"field":"first_name"}
.
The available field names depend on the module that implements the search.
Attachment
A attachment operand is a JSON object with the member attachment
specifying the attachment name, e.g. {"attachment":"somedocument.txt"}
.
The attachment search is only available in case the FILENAME_SEARCH
capability is included in the list of supported_capabilities of the folder.
Header
A header operand is a JSON object with the member header
specifying the header name, e.g. {"header":"From"}
.
Examples
Represents the expression field_name1 = value1 AND NOT field_name2 > value2
.
{
"filter" : [
"and",
[ "=" , { "field" : "field_name1" }, "value1" ],
["not",
[ ">", { "field" : "field_name2" }, "value2"]
]
]
}
Infostore Advanced Search
Operators
The following operators are allowed in search terms.
Operators |
---|
"=" |
">" |
"<" |
Operands
The following operands and operators are allowed in search terms.
Operands | Valid operator |
---|---|
"camera_aperture" | ALL |
"camera_exposure_time" | ALL |
"camera_focal_length" | AL |
"camera_iso_speed" | ALL |
"camera_make" | "=" |
"camera_model" | "=" |
"capture_date" | ALL |
"categories" | "=" |
"color_label" | ALL |
"content" | "=" |
"creation_date" | ALL |
"created_by" | ALL |
"current_version" | ALL |
"description" | "=" |
"filename" | "=" |
"file_md5sum" | "=" |
"file_mimetype" | "=" |
"file_size" | ALL |
"height" | ALL |
"last_modified" | ALL |
"last_modified_utc" | ALL |
"locked_until" | ALL |
"media_date" | ALL |
"meta" | "=" |
"modified_by" | ALL |
"number_of_versions" | ALL |
"sequence_number" | ALL |
"title" | "=" |
"url" | "=" |
"version" | "=" |
"version_comment" | "=" |
"width" | ALL |
Examples
Represents Find files having a file_size < 1024
.
{
"filter" : [ "<" , { "field" : "file_size" }, "1024" ]
}
Represents Find files with filename = "stuff"
.
{
"filter" : [ "=" , { "field" : "filename" }, "stuff" ]
}
Represents Find files with filename "stuff" and file_size < 100 OR having filename = "changelog"
.
{
"filter" :
[ "or",
[ "and",
[ "=" , { "field" : "filename" }, "stuff" ],
[ "<" , { "field" : "file_size" }, "100" ]
],
[ "=" , { "field" : "filename" }, "changelog" ]
]
}
Chronos Advanced Search
Operators
The following operators are allowed in search terms.
Operators |
---|
"=" |
">" |
"<" |
Operands
The following operands and operators are allowed in search terms.
Operands | Valid operator |
---|---|
"filename" | "=" |
"sequence" | "=" |
"timestamp" | "ALL" |
"created" | "ALL" |
"createdBy" | "=" |
"lastModified" | "ALL" |
"modifiedBy" | "=" |
"calendarUser" | "=" |
"summary" | "=" |
"location" | "=" |
"description" | "=" |
"categories" | "=" |
"class" | "=" |
"color" | "=" |
"transp" | "=" |
"seriesId" | "=" |
"rrule" | "=" |
"modifiedBy" | "=" |
"recurrenceId" | "=" |
"recurrenceDates" | "=" |
"changeExceptionDates" | "=" |
"deleteExceptionDates" | "=" |
"status" | "=" |
"url" | "=" |
"organizer" | "=" |
"comment" | "=" |
Examples
Find events that were modified after a certain date.
{
"filter" : [ ">" , { "field" : "lastModified" }, "1612526465493" ]
}
Find events with summary = "foobar" and created by user 3.
{
"filter" : [
"and",
["=" , { "field" : "summary" }, "foobar" ],
["=" , { "field" : "createdBy" }, "3" ]
]
}
Calendar account configuration
This chapter describes the configuration of different calendar accounts.
ICal feeds
Various ICal feeds can be subscribed by the given URI and optional basic authentication.
For example:
{
"configuration":{
"uri":"http://example.org/feed/theExampleFeed.ics"
}
}
If basic authentication is required the body should contain 'login', 'password' or both as desired by the endpoint, for instance:
{
"configuration":{
"uri":"http://example.org/feed/theSecureExampleFeed.ics"
"login":"johnDoe",
"password":"myPassword"
}
}
The google calendar account basically only needs the id of a valid google oauth account with the calendar_ro
scope.
For example:
{
"configuration":{
"oauthId":5
}
}
This way the middleware creates a google calendar account which uses the given oauth account. During the initialization of the account the folders
field is filled with all available google calendars.
This json object contains another json objects for each calendar, whereby the key of each entry is the id of the google calendar (E.g. test_account@gmail.com
). Each google calendar object contains different informations about the calendar (e.g. the color, default reminders etc.). But the most important field is the enabled
field which defines whether a google calendar is subscribed or not. By default only the primary account is enabled (and therefore subscribed). If the client wants to enable other accounts too, it can do so by setting the enabled
field to true
and updating the account.
Example configuration after creation:
"configuration": {
"oauthId": 41,
"folders": {
"test_account@gmail.com": {
"enabled": true,
"color": "#9fe1e7",
"default_reminders": [
{
"action": "DISPLAY",
"duration": "-PT30M"
}
],
"primary": true
},
"#contacts@group.v.calendar.google.com": {
"enabled": false,
"color": "#92e1c0",
"default_reminders": []
},
"en.german#holiday@group.v.calendar.google.com": {
"enabled": false,
"color": "#16a765",
"default_reminders": []
},
"e_2_en#weeknum@group.v.calendar.google.com": {
"enabled": false,
"color": "#42d692",
"default_reminders": []
}
}
}
Config module
The config module is used to retrieve and set user-specific configuration. The configuration is stored in a tree. Each node of the tree has a name and a value. The values of leaf nodes are strings which store the actual configuration data. The values of inner nodes are defined recursively as objects with one field for each child node. The name and the value of each field is the name and the value of the corresponding child node, respectively.
The namespace looks like the following:
- /ajax/config/
- gui – A string containing GUI-specific settings (currently, it is a huge JSON object).
- fastgui - A string containing GUI-specific settings. This is a JSON object that must be kept small for performance.
- context_id - the unique identifier of the context (read-only).
- cookielifetime - the cookie life time in seconds or -1 for session cookie (read-only).
- identifier – the unique identifier of the user (read-only).
- contact_id – the unique identifier of the contact data of the user (read-only).
- language – the configured language of the user.
- timezone – the configured timezone of the user.
- availableTimeZones – a JSON object containing all available time zones. The key is the time zone identifier and the value contains its name in users language. (read-only).
- reloadTimes - Selectable times for GUI reload
- serverVersion - Version string of the server.
- tombstoneCleanup - Settings for cleanup of tombstone tables
- timespan – The timespan an entry in any tombstone table is kept before removing it (in milliseconds). Not set if cleanup is disabled.
- currentTime - User timezone specific long of the current server time.
- maxUploadIdleTimeout - Timeout after that idle uploads are deleted.
- folder/ – the standard folder of the user
- tasks – the standard task folder (read-only)
- calendar – the standard calendar folder (read-only)
- contacts – the standard contacts folder (read-only)
- infostore – the private infostore folder (read-only)
- eas – whether EAS folder selection is enabled (read-only)
- participants
- autoSearch - If a search for all users, groups and resources when participant selection dialog is opened. (read-only)
- showWithoutEmail - If external participants without email should be shown.
- showDialog – Enables participant selection dialog for appointments and tasks. (read-only)
- availableModules – Contains a JSON array listing all enabled modules for a user. GUI loads Plugins through this list. To get your plugin listed here, create a subtree below modules/ without a module * subelement or with a subelement containing true (read-only)
- minimumSearchCharacters – Minimum number of characters a search pattern must have to prevent large responses and slow queries. (read-only)
- modules
- portal
- gui GUI settings for portal module
- module
- mail
- addresses – all email addresses of the user including the primary address (read-only)
- appendmailtext
- allowhtmlimages – Alters default setting whether external images contained in HTML content are allowed or not
- colorquoted – color quoted lines
- contactCollectFolder – contact folder id to save mail addresses from sent mails
- contactCollectEnabled – switch contact collection on/off
- contactCollectOnMailAccess – enables/disables contact collection for incoming mails. Default is true.
- contactCollectOnMailTransport – enables/disables contact collection for outgoing mails. Default is true.
- defaultaddress – primary email address of the user (read-only)
- deletemail – delete emails or move to trash
- emoticons – display emoticons as graphics
- defaultFolder
- drafts – identifier of the folder with the mail drafts (read-only)
- inbox – identifier of the folder that gets all incoming mails (read-only)
- sent – identifier of the folder with the sent mails (read-only)
- spam – identifier of the folder with the spam mails (read-only)
- trash – identifier of the folder with the deleted mails (read-only)
- forwardmessage – forward messages as inline or attachment
- gui GUI settings for mail module
- inlineattachments – activate inlining of HTML attachments
- linewrap
- module – if mail module is enabled or not
- phishingheaders – header(s) identifying phishing headers
- replyallcc – put all recipients on reply all into CC
- sendaddress – one email address out of the addresses list that are email sent with
- spambutton – Spam Button should be displayed in GUI or not
- vcard – attach vcard when sending mails
- calendar
- calendar_conflict
- calendar_freebusy
- calendar_teamview
- gui GUI settings for the calendar module
- module
- notifyNewModifiedDeleted receive mail notification for new, modified or deleted appointments
- notifyAcceptedDeclinedAsCreator receive mail notification for accepted or declined appointments created by the user
- notifyAcceptedDeclinedAsParticipant receive mail notification for accepted or declined appointments that the user participates
- defaultStatusPrivate Default status for new appointments in private folders, where the user is participant. This does not affect appointments created by this user, which always have the status "accepted". The status are described in User participant object. Default is 0:none
- defaultStatusPublic Default status for new appointments in public folders, where the user is participant. This does not affect appointments created by this user, which always have the status "accepted". The status are described in User participant object. Default is 0:none
- contacts
- gui GUI settings for the contacts module
- mailAddressAutoSearch – Define if a search is triggered when the recipient selection dialog is opened or the folder is changed. (read-only)
- module True if the contact module is enabled for the current user, false otherwise.
- singleFolderSearch – True if the current user is allowed to search for contacts only in a single folder. False if contact searches across all folders are allowed. (read-only)
- characterSearch – True if the side bar for searching for contacts by a start letter should be displayed. False if the side bar should be hidden. (read-only)
- allFoldersForAutoComplete – true if an auto complete search may omit the folder identifier array and search for contacts in all readable folders. This is configured through the contact.properties configuration file. (read-only)
- tasks
- gui GUI settings for the tasks module
- module
- delegate_tasks
- notifyNewModifiedDeleted receive mail notification for new, modified or deleted tasks
- notifyAcceptedDeclinedAsCreator receive mail notification for accepted or declined tasks created by the user
- notifyAcceptedDeclinedAsParticipant receive mail notification for accepted or declined taks that the user participates
- infostore
- gui GUI settings for the infostore module
- folder – the standard infostore folders (read-only)
- trash – identifier of the default infostore trash folder (read-only)
- pictures – identifier of the default infostore pictures folder (read-only)
- documents – identifier of the default infostore documents folder (read-only)
- music – identifier of the default infostore music folder (read-only)
- videos – identifier of the default infostore videos folder (read-only)
- templates – identifier of the default infostore templates folder (read-only)
- module
- interfaces
- ical
- vcard
- syncml
- folder
- gui UI settings for the folder tree
- public_folders
- read_create_shared_folders
- tree – Selected folder tree, the user wants to use. Currents trees are 0 for the known OX folder tree and 1 for the new virtual folder tree.
- com.openexchange.extras
- module – Extras link in the configuration (read only)
- com.openexchange.user.passwordchange
- module – Will load Plug-In which allows to change the Password within the users configuration (read only)
- com.openexchange.user.personaldata
- module – Will load Plug-In which allows to edit personal contact information within the users configuration (read only)
- com.openexchange.group
- enabled – Specifies whether the user is allowed to edit groups and loads the corresponding Plug-In. (read only)
- com.openexchange.resource
- enabled – Specifies whether the user is allowed to edit resources and loads the corresponding Plug-In. (read only)
- com.openexchange.publish
- enabled – Specifies whether the user is allowed to publish items. (read only)
- com.openexchange.subscribe
- enabled – Specifies whether the user is allowed to subscribe sources. (read only)
- olox20 [DEPRECATED]
- active – Tells the UI if the user is allowed to use the OXtender for Microsoft Outlook 2. (read only)
- module – Is set to false to prevent the UI from trying to load a plugin. (read only)
- com.openexchange.oxupdater [DEPRECATED]
- module – Is true if the OXUpdater package is installed and started. (read only)
- active – Is true if the user is allowed to download the OXUpdater. Otherwise it's false. (read only)
- com.openexchange.passwordchange
- showStrength – Show a widget, which displays the current passwort Strength while entering. (default: false)
- minLength – The minimum length of an entered password. (default: 4)
- maxLength – The maximum length of an entered password. 0 for unlimited. (default: 0)
- regexp – Defines the class of allowed special characters as Regular Expression. (default: [^a-z0-9])
- special – Shows an example of allowed special characters to the user. Should be a subset of "regexp" in a human readable format. (default: $, _, or %)
- portal