1. Overview

This document describes the resources that make up the Clinked API v2. If you have any problems or requests please contact Clinked support.

The current version of the API was initially designed for internal use and might expose more data than necessary for most use cases.

1.1. Schema

All API access is over HTTPS, and accessed from the https://api-p1.clinked.com. All data is sent and received as JSON.

Blank fields are included as null instead of being omitted.

All timestamps are in milliseconds (UTC):

1518170699654

1.2. User agent

A client should provide a User-Agent header that can help identify your application. This allows us to contact you if there are problems.

Here’s an example:

User-Agent: Awesome-App

1.3. Authentication

Authentication flow is based on OAuth2 with a few additional steps:

  1. A client authenticates using static client id clinked-mobile and user credentials.

  2. Once authenticated, a client creates a new application using an access token from the previous step.

  3. Once application is created, the API responds with a new randomly generated client id and client secret. These credentials need to be persisted to refresh access token in the future.

  4. A client uses client id and client secret from previous step to authenticate.

The resulting access token is the one that is required to access API resources. Pass it in the Authorization header for each request:

Authorization: Bearer 1da13d89-150c-4c4d-a1a3-36958a7cd551
See our Basics of authentication guide to get you started.
Access token is temporary and available only for 30 minutes, after that the API will respond with 401 Unauthorized. If that’s the case a client should request a new one using same client id and client secret.
A user might revoke an application and the API will respond with 401 Unauthorized even when trying to refresh a token. In that case a user should be considered logged out.

1.3.1. Authenticating with user credentials

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/auth/password/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/auth/password/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/auth/password/curl-request.adoc[]

Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "access_token": "f3a5837f-7a28-4148-9352-336e0bca75a9",
    "refresh_token": "e10560b0-9bdc-478e-a2dc-95009c419a40",
    "scope": "read write",
    "token_type": "bearer"
}

1.3.2. Creating an application

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/http-response.adoc[]

Fields are defined in Get single application

1.3.3. Authenticating with client credentials

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/auth/client_credentials/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/auth/client_credentials/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/auth/client_credentials/curl-request.adoc[]

Example of a success response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
    "access_token": "2466f2ee-0875-41a1-ad6c-8f81468f47e9",
    "token_type": "bearer",
    "expires_in": 7199,
    "scope": "read write"
}

1.5. Rate limit

The overview documentation describes the rate limit rules. You can check your current rate limit status at any time using the Rate Limit API described below.

1.5.1. Get your current rate limit status

Accessing this endpoint does not count against your rate limit.
Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/rates/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/rates/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/rates/http-response.adoc[]

2. Organisation

Organisation (sometimes referred as an "account") is a holder for multiple groups. You need to know id of an organisation to use the following resources.

2.1. Data

Organisation holds data such as package and customizations.

2.1.1. List organisations

This resource returns a list of organisations user is part of.

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/list/http-response.adoc[]

List item fields are defined in Get a single organisation data

2.1.2. Get a single organisation data

View extended details for an organisation.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/single/response-fields.adoc[]

2.1.3. Get custom component names

Some organisations require naming customisations.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/custom/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/custom/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/custom/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/custom/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/accounts/custom/response-fields.adoc[]

2.2. Groups

2.2.1. List groups

View list of all organisation groups.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/list/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/list/http-response.adoc[]

List item fields are defined in Get a single group data

2.2.2. Get a single group data

View extended details for a single group.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/single/response-fields.adoc[]

2.2.3. Create a group

Creates a new group for an organisation.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/create/http-response.adoc[]

Response fields are defined in Get a single group data

2.2.4. Update a group

Changing group data and settings.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/update/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/update/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/update/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/update/http-response.adoc[]

Response fields are defined in Get a single group data

2.2.5. Delete a group

Removes a single group by placing it to trash.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/remove/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/remove/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/remove/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/remove/http-response.adoc[]

2.2.6. Duplicate group

Duplicates a group.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/duplicate/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/duplicate/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/duplicate/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/duplicate/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/groups/duplicate/http-response.adoc[]

2.3. Members

Administrator permission is required to manage organisation members.

2.3.1. List members

List of current organisation members. Result is paginated.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/list/path-parameters.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/list/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/list/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/list/response-fields.adoc[]

Page entry fields are defined in Get single member data.

2.3.2. Get single member data

Single member data.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/single/response-fields.adoc[]

2.3.3. Create a member

Single member creation. This example also adds newly created user to a group named my_group with read, write & create permissions.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/response-fields.adoc[]

2.3.4. Update a member

Changing member data.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/update/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/update/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/update/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/update/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/update/response-fields.adoc[]

2.3.5. Delete a member

Deleting a member. If a user has no organisations any more it will be automatically deleted from the system.

Deleted user can’t be restored.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/delete/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/delete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/delete/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/members/delete/http-response.adoc[]

3. Group

A group (sometimes referred as "space") is an isolated entity that belongs to an organisation. Each group has its own content such as files, notes, etc.

3.1. Files

3.1.1. List files

List visible files in a group folder. Result is paginated.

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/list/request-parameters.adoc[]

Top level folder

Uploads a file to the group top level folder.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/list/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/list/http-request.adoc[]

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/list/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/list/response-fields.adoc[]

Page entry fields are defined in Get a single file data.
Specific folder

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/directory_list/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/directory_list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/directory_list/curl-request.adoc[]

Result is the same as in Top level folder.

3.1.2. Get a single file data

Single file might contain more data about a file that is not present when retrieving a list.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/single/response-fields.adoc[]

3.1.3. Upload a file

Large files

This method allows to upload a file by small chunks and is preferred if a file is larger than 5 MiB. Also this method doesn’t create a file until a client informs the API about successful upload.

You can find the full code example here.
Chunk size has to be larger than 5 MiB (5242880 bytes). If a total file size is less than that, you need to use a different approach. See Small files section.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk1/path-parameters.adoc[]

Request headers

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk1/request-headers.adoc[]

Example of a request (chunk #1)

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk1/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk1/curl-request.adoc[]

Example of a request (chunk #2)

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk2/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk2/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk2/http-response.adoc[]

When all file chunks are uploaded a client should inform the API about successful upload, specify where to put the uploaded file and provide file metadata in the request body.

Request headers

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk_complete/request-headers.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk_complete/request-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk_complete/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk_complete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk_complete/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_chunk_complete/http-response.adoc[]

Small files
We encourage clients to upload files larger than 5 MiB (5242880 bytes) by chunks as described in the Large files section as it is more reliable method in most cases.

This method allows to upload small files (less than 100MB). If a file is larger than that please refer to Large files section.

There are 2 steps you need to do to upload a file using this method:

  1. Create a new File instance by providing information such as file size and type.

  2. Upload file contents with single request.

Create file instance

Before you upload a file you need to provide some data about it by creating a File instance.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_file/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_file/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_file/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_file/curl-request.adoc[]

Response fields are the same as defined in Get a single file data.
Upload file data

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_data/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_data/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_data/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/upload_data/http-response.adoc[]

3.1.4. Create a folder

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_folder/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_folder/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_folder/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/create_folder/curl-request.adoc[]

Response fields are the same as defined in Get a single file data.

3.1.5. Remove a file

When removing a file it is placed to a group trash can and may be restored.

When removing a folder that contains files it is a client responsibility to recursively remove all files before removing a folder itself to avoid possible data loss because internal files are not automatically moved to a group trash can.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/remove/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/remove/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/remove/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/remove/http-response.adoc[]

3.1.6. Move a file

Moves a file to other groups and folders.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/move/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/move/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/move/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/move/curl-request.adoc[]

Response fields are the same as defined in Get a single file data.

3.1.7. Download a file

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/download/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/download/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/download/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/files/download/http-response.adoc[]

3.2. Notes

API does not support note deletion yet.

3.2.1. List notes

View list of all organisation notes.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/list/path-parameters.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/list/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/list/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/list/response-fields.adoc[]

3.2.2. Get a single note data

View extended details for a single note.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/single/response-fields.adoc[]

3.2.3. Create a note

Creates a new note for an organisation.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/create/http-response.adoc[]

Response fields are defined in Get a single note data

3.2.4. Update a note

Changing note data and settings.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/update/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/update/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/update/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/update/http-response.adoc[]

3.2.5. Remove a note

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/delete/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/delete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/pages/delete/curl-request.adoc[]

3.3. Events

3.3.1. List events in date range

Retrieves all events in a date range.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/range/path-parameters.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/range/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/range/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/range/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/range/http-response.adoc[]

List item fields are defined in Get a single event data

3.3.2. Get a single event data

View extended details for a single event.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/single/response-fields.adoc[]

3.3.3. Create an event

Creates a new event.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/create/http-response.adoc[]

Response fields are defined in Get a single event data

3.3.4. Update an event

Changing event data.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/update/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/update/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/update/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/update/http-response.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/update/http-response.adoc[]

Response fields are defined in Get a single event data

3.3.5. Delete an event

Deleting event.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/delete/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/delete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/delete/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/events/delete/http-response.adoc[]

3.4. Tasks

3.4.1. List tasks

Retrieves all tasks in a date range.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/list/path-parameters.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/list/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/list/http-response.adoc[]

List item fields are defined in Get a single task data

3.4.2. Get a single task data

View extended details for a single task.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/single/response-fields.adoc[]

3.4.3. Create a task

Creates a new task.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/create/http-response.adoc[]

Response fields are defined in Get a single task data

3.4.4. Update a task

Changing task data.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/tasks/update/path-parameters.adoc[]

3.5. Discussions

3.5.1. List discussions

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/list/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/list/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/list/response-fields.adoc[]

3.5.2. Get a single discussion

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/single/response-fields.adoc[]

3.5.3. Create a discussion

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/create/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/create/response-fields.adoc[]

3.5.4. List discussion replies

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_list/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_list/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_list/response-fields.adoc[]

3.5.5. Create discussion reply

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_create/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_create/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_create/response-fields.adoc[]

3.5.6. Delete discussion reply

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_delete/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_delete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_delete/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/id/discussions/reply_delete/http-response.adoc[]

3.6. Activity

Activity is a list of events called "updates". Each update has a type that should be mapped to a template which is populated by additional data. Example template:

{0} uploaded file {3} in {2}

A template can contain one of the following placeholders:

Placeholder number Data

0

Username

1

Organisation name

2

Group name

3

Component name

4

Target username

5

Reserved name

For a list of all type → template mappings see Appendix D: Update templates.

3.6.1. List group updates

Retrieves a list of of group updates. Result is paginated.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/group/path-parameters.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/group/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/group/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/group/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/group/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/group/response-fields.adoc[]

3.6.2. List organisation updates

Retrieves a list of organisation updates. Result is paginated.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/organisation/path-parameters.adoc[]

Request parameters

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/organisation/request-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/organisation/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/updates/organisation/curl-request.adoc[]

Response example is the same as for List group updates.

3.7. Comments

Pending

3.8. Guests

Pending

4. User

Currently logged in user can retrieve and manage some of his own information.

4.1. Getting user data

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/me/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/me/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/me/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/me/response-fields.adoc[]

4.2. List user groups

Retrieve all groups a user is a member of.

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/groups/list/http-response.adoc[]

List item fields are defined in Get a single group data

4.3. Notifications

This section is incomplete and provides only request example.

4.3.1. List notifications

Example of a request
GET /v2/notifications HTTP/1.1
Accept: application/json
Host: api-p1.clinked.com

4.3.2. Mark all notifications as read

Example of a request
PUT /v2/notifications HTTP/1.1
Accept: application/json
Host: api-p1.clinked.com

4.3.3. Mark single notification as read

Example of a request
PUT /v2/notifications/1 HTTP/1.1
Accept: application/json
Host: api-p1.clinked.com

4.4. Applications

4.4.1. List user applications

Lists all user applications.

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/list/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/list/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/list/http-response.adoc[]

List item fields are defined in Get single application

4.4.2. Get single application

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/single/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/single/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/single/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/single/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/single/response-fields.adoc[]

4.4.3. Create an application

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/create/http-response.adoc[]

List item fields are defined in Get single application

4.4.4. Update an application

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/update/path-parameters.adoc[]

Request fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/update/request-fields.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/update/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/update/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/update/http-response.adoc[]

List item fields are defined in Get single application

4.4.5. Delete an application

Deletes and revokes application access.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/delete/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/delete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/delete/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/applications/delete/http-response.adoc[]

4.5. User properties

Each user has its own map (key → value) of properties that can be used to change personal preferences.

4.5.1. List properties

Lists all user properties.

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/properties/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/properties/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/properties/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/properties/response-fields.adoc[]

4.5.2. Create a property

Creates a user property.

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_create/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_create/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_create/http-response.adoc[]

Definition of the returned fields

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_create/response-fields.adoc[]

4.5.3. Delete a property

Deletes a user property.

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_delete/path-parameters.adoc[]

Example of a request

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_delete/http-request.adoc[] Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_delete/curl-request.adoc[]

Example of a success response

Unresolved directive in index.adoc - include::/home/ivarsv/Rabbitsoft/clinked/clinked-api-webapp/target/generated-snippets/v2/users/property_delete/http-response.adoc[]

5. Appendix A: Forbidden file names

  • new

  • delete

  • download

  • clipboard

6. Appendix B: Forbidden user names

  • invite

  • list

  • tags

  • anonymous

  • websocket

  • webhooks

  • messages

  • signup

  • site

  • ping

  • static

  • customise

  • users

  • uses

  • password

  • settings

  • search

  • packages

  • clientcountry

  • shares

  • login

  • verify_code

  • .

  • favicon.ico

  • robots.txt

  • new_space

  • new_space_duplicate

  • uncaught_exception

  • access_denied

  • not_found

  • userdata

  • following

  • _jserr

  • api

  • google

  • linkedin

  • image

  • messages

  • mentions

  • token_password

  • requests

  • activity

  • activity_share

  • tracking

  • events

  • tasks

  • spaces

  • people

  • pages

  • discussions

  • files

  • generalinfo

  • tinymce

  • getting_started

  • conversation

  • notifications

  • members

  • websocket

  • webhooks

7. Appendix C: Forbidden group names

  • websocket

  • webhooks

  • messages

  • signup

  • site

  • ping

  • static

  • customise

  • users

  • uses

  • password

  • settings

  • search

  • packages

  • clientcountry

  • shares

  • login

  • verify_code

  • .

  • favicon.ico

  • robots.txt

  • new_space

  • new_space_duplicate

  • uncaught_exception

  • access_denied

  • not_found

  • userdata

  • following

  • _jserr

  • api

  • google

  • linkedin

  • image

  • messages

  • mentions

  • token_password

  • requests

  • activity

  • activity_share

  • tracking

  • events

  • tasks

  • spaces

  • people

  • pages

  • discussions

  • files

  • generalinfo

  • tinymce

  • getting_started

  • conversation

  • notifications

  • members

  • websocket

  • webhooks

8. Appendix D: Update templates

update.organisation.create={0} created account {1}
update.organisation.disable={0} disabled account {1}
update.organisation.enabled={0} enabled account {1}

update.user.private={0} said
update.user.profile={0} said to {4}
update.organisation.private={0} in {1} said
update.organisation.join={0} joined {1}
update.space.private={0} in {2} said
update.following.start={0} started following {3} in {2}
update.following.stop={0} stopped following {3} in {2}
update.discussion.create={0} created new [discussions:0:0] {3} in {2}
update.discussion.update={0} updated [discussions:0:0] {3} in {2}
update.discussion.createreply={0} replied to [discussions:0:0] {3} in {2}
update.space.create={0} created a new [spaces:0:0] {2}
update.space.join={0} joined {2} [spaces:0:0]
update.trash.remove={0} deleted [spaces:0:0] {2}
update.trash.restore={0} restored [spaces:0:0] {2}
update.trash.delete={0} deleted [spaces:0:0] {2} from {1} trash
update.filestore.create={0} uploaded [files:0:0] {3} in {2}
update.filestore.update={0} updated [files:0:0] {3} in {2}
update.filestore.folder={0} created folder {3} in {2}
update.filestore.sign=The agreement <strong>{5}</strong> for file {3} in {2} is signed and ready to download.
update.filestore.rename={0} renamed "{5}" to {3} in {2}
update.filestore.move={0} moved {3} to "{5}" in {2}
update.filestore.copy={0} copied {3} to "{5}" in {2}
update.filestore.approval.accept={0} approved [files:0:0] {3} in {2}
update.filestore.approval.reject={0} rejected [files:0:0] {3} in {2}
update.event.create={0} created [events:0:0] {3} in {2}
update.event.createandassign={0} created [events:0:0] {3} in {2}
update.event.update={0} updated [events:0:0] {3} in {2}
update.event.updateandassign={0} updated [events:0:0] {3} in {2}
update.task.create={0} created [tasks:0:0] {3} in {2}
update.task.createandassign={0} created [tasks:0:0] {3} in {2}
update.task.update={0} updated [tasks:0:0] {3} in {2}
update.task.updateandassign={0} updated [tasks:0:0] {3} in {2}
update.task.complete={0} completed [tasks:0:0] {3} in {2}
update.task.reopen={0} marked [tasks:0:0] {3} as incomplete in {2}

update.attachment.create={0} attached file {5} to {3} in {2}
update.attachment.update={0} updated attachment {5} in {3}

update.page.create={0} created new [pages:0:0] {3} in {2}
update.page.update={0} updated [pages:0:0] {3} in {2}
update.page.restore={0} restored [pages:0:0] {3} version {5} in {2}
update.page.renameandupdate={0} moved [pages:0:0] {5} to {3} in {2}

update.news.create={0} created new [news:0:0] {3} in {2}
update.news.update={0} updated [news:0:0] {3} in {2}
update.news.restore={0} restored [news:0:0] {3} version {5} in {2}
update.news.renameandupdate={0} moved [news:0:0] {5} to {3} in {2}

update.comment.create={0} commented on {3} in {2}
update.comment.update={0} updated comment on {3} in {2}

update.comment.delete={0} deleted comment from {3} in {2}

update.comment.reply={0} replied on {3} in {2}
update.annotate.create={0} annotated {3} in {2}
update.annotate.delete={0} deleted annotation from {3} in {2}

update.space.trash.filerecord.create={0} deleted {3} in {2}
update.space.trash.filerecord.attemptRestore={0} restored {3} in {2}
update.space.trash.filerecord.delete={0} permanently deleted {3} from {2} trash
update.space.trash.page.create={0} deleted [pages:0:0] {3} in {2}
update.space.trash.page.attemptRestore={0} restored [pages:0:0] {3} in {2}
update.space.trash.page.delete={0} permanently deleted [pages:0:0] {3} from {2} trash
update.space.trash.news.create={0} deleted [news:0:0] {3} in {2}
update.space.trash.news.attemptRestore={0} restored [news:0:0] {3} in {2}
update.space.trash.news.delete={0} permanently deleted [news:0:0] {3} from {2} trash

update.space.trash.emailthread.create={0} deleted conversation {3} in {2}
update.space.trash.emailthread.attemptRestore={0} restored conversation {3} in {2}
update.space.trash.emailthread.delete={0} permanently deleted conversation {3} from {2} trash
update.email.thread.message.create=A new message arrived to conversation {3} in {2}

update.space.trash.discussion.create={0} deleted [discussions:0:0] {3} in {2}
update.space.trash.discussion.attemptRestore={0} restored [discussions:0:0] {3} in {2}
update.space.trash.discussion.delete={0} permanently deleted [discussions:0:0] {3} from {2} trash
update.space.trash.event.create={0} deleted [events:0:0] {3} in {2}
update.space.trash.event.attemptRestore={0} restored [events:0:0] {3} in {2}
update.space.trash.event.delete={0} permanently deleted [events:0:0] {3} from {2} trash
update.space.trash.task.create={0} deleted [tasks:0:0] {3} in {2}
update.space.trash.task.attemptRestore={0} restored [tasks:0:0] {3} in {2}
update.space.trash.task.delete={0} permanently deleted [tasks:0:0] {3} from {2} trash
update.space.rename={0} renamed [spaces:0:0] {5} to {2}
update.space.move={0} moved [spaces:0:0] {2} from {3}
update.space.remove={0} removed [spaces:0:0] {2}
update.space.restore={0} restored [spaces:0:0] {2} from trash

update.attachment.create.notify={0} attached the file {2} to {1}
update.attachment.update.notify={0} updated the attachment {2} to {1}
update.discussion.createreply.notify={0} replied to [discussions:0:0] {1}
update.event.update.notify={0} edited the [events:0:0] {1}
update.event.updateandassign.notify={0} edited the [events:0:0] {1}
update.filestore.update.notify={0} edited the [files:0:0] {1}
update.filestore.folder.notify={0} created folder {1}
update.filestore.create.notify={0} created a new [files:0:0] {1}
update.page.update.notify={0} changed the [pages:0:0] {1}
update.page.renameandupdate.notify={0} changed the [pages:0:0] {1}
update.space.trash.discussion.create.notify={0} deleted the [discussions:0:0] {1}
update.space.trash.event.create.notify={0} deleted the [events:0:0] {1}
update.space.trash.filerecord.create.notify={0} deleted the [files:0:0] {1}
update.space.trash.news.create.notify={0} deleted the [news:0:0] {1}
update.space.trash.page.create.notify={0} deleted the [pages:0:0] {1}
update.space.trash.task.create.notify={0} deleted the [tasks:0:0] {1}
update.space.trash.discussion.attemptRestore.notify={0} restored the [discussions:0:0] {1}
update.space.trash.event.attemptRestore.notify={0} restored the [events:0:0] {1}
update.space.trash.filerecord.attemptRestore.notify={0} restored the [files:0:0] {1}
update.space.trash.page.attemptRestore.notify={0} restored the [pages:0:0] {1}
update.space.trash.news.attemptRestore.notify={0} restored the [news:0:0] {1}
update.space.trash.task.attemptRestore.notify={0} restored the [tasks:0:0] {1}
update.task.complete.notify={0} completed the [tasks:0:0] {1}
update.task.reopen.notify={0} marked the [tasks:0:0] {1} as uncompleted
update.task.update.notify={0} changed the [tasks:0:0] {1}
update.task.updateandassign.notify={0} changed the [tasks:0:0] {1}
update.comment.create.notify={0} commented on {1}
update.comment.reply.notify={0} commented on {1}