Labfolder ELN API v2 Beta
Latest ¶
Pre-Release Notice ¶
This API is still under active development. This means endpoint semantics and formats might change as we finalize the implementation. There may still be some bugs as well, but we believe getting it into the hands of our users sooner will help the process move faster.
Optional fields might be added to requests and additional fields might be added to responses without notice. To ensure the smoothest possible transition please make sure your code does not rely on the exact object structure returned and ignores unknown properties.
As a general guideline for error handling, more emphasis should be paid to the status codes rather than the error messages.
“null” values ¶
We’re aware of an issue with the library that we use to generate the API documentation in which nullable string properties are represented with the value "null" in the documentation. The API will never return “null” (as a string), only either a valid id (in string form “12345”) or null.
As an example, see the properties group_id and folder_id under the List Projects resource
Identity Access Management (IAM) ¶
Labfolder has a feature IAM, in which we delegate our application security to the Labforward Identity & Access Management (IAM) application.
This feature will be enabled for cloud users for the time being. Once enabled, all users should log into Labfolder using a browser where they will be prompted to reset their passwords. Following the password reset, users can use the POST /auth/login endpoint as before to login and retrieve their authentication tokens.
Please be notified that -
-
Tokens will be JWT tokens with a slightly shorter expiry date, but they will serve the same purpose and have the same use as before.
-
There is no support for HTTP-Basic API calls. Only use the Authorization header method.
Version ¶
This is API v2 build #
2e75633e1b916f98efff183b1486d12f85a926a8Changelog ¶
2023-10-04 ¶
Changed ¶
- Removed the
Tokenprefix from the Authorization header in favor ofBearer
Added ¶
- When project collaboration is enabled, we can provide the editors of the specified entry.
2023-06-14 ¶
Added ¶
-
Added a new endpoint to list all available Incident Reports
-
Added a new endpoint to download Incident Report data
2023-05-03 ¶
Added ¶
- Added a new (and preferred) format for authentication via Authorization header -
Authorization: Bearer xxxxx
Access ¶
Location ¶
The API can only be accessed via HTTPS.
You can reach the API for the cloud instance at
https://labfolder.labforward.app/api/v2/Local installations can access the API using the respective domain with the path /api/v2/ appended.
So if your server is reachable at https://labfolder.mycompany.lan the API endpoint is located at
# Note: `/api/v2/` is appended to the standalone server url
https://labfolder.mycompany.lan/api/v2/Authentication ¶
A token is required to perform API requests. You may retrieve a token from the login endpoint. Once acquired the token should either be provided:
- in the
Authorizationheader, or - in the username field for HTTP-Basic authentication
Note that option 1 should always work, whereas option 2 is unavailable while the server has the Identity Access Management feature (IAM) enabled.
*Important!*
Your API token should never be shared or made publicly accessible. No one from our company will
ever ask you for this value, or your login credentials.
Option 1: using the Authorization Header ¶
curl -H "Authorization: Bearer $LABFOLDER_API_TOKEN" <API_RESOURCE_PATH_GOES_HERE>Option 2: using HTTP-Basic Authentication (unavailable when the IAM Feature is enabled) ¶
# Note the proceeding ':'
curl -u "$LABFOLDER_API_TOKEN:" <API_RESOURCE_PATH_GOES_HERE>Endpoints ¶
Login - Generate TokenPOST/auth/login
Generate a token which can be used to make API requests.
Example URI
POST /api/v2/auth/login
Request
Generate TokenHeaders
Content-Type: application/jsonBody
{
"user": "luke.skywalker@starwars.com",
"password": "password"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user": {
"type": "string",
"description": "email of the user"
},
"password": {
"type": "string",
"description": "password of the user"
}
},
"required": [
"user",
"password"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"token": "MTZmNTigNWMtNWJ34y00NDgwL12wM2ItZTM4NzFGYzU1NTJm",
"expires": "2017-09-04T13:27:55.641+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "generated token"
},
"expires": {
"type": "string",
"description": "expiration date of the token"
}
},
"required": [
"token",
"expires"
]
}Logout - Invalidate TokensPOST/auth/logout
Invalidate all API access tokens.
Example URI
POST /api/v2/auth/logout
Response
204Concepts ¶
User Agent Required ¶
All requests MUST include a User-Agent header. Please include the name of your application and your e-mail address so
we can contact you if needed.
User-Agent: My Application; email@domain.tldif you do not provide a User-Agent we will return a 400 Bad Request.
Parameters & Body Format ¶
Some GET requests can take optional parameters which are included in the query string and must be UTF-8 encoded.
# Example query string usage
?offset=0&limit=20&sort=-titleThe body format of POST, PATCH, PUT, and DELETE request is JSON and the corresponding Content-Type header must be set to application/json.
# Set Content-Type header and provide JSON body
> curl -u "${LABFOLDER_API_TOKEN}:" -H "Content-Type: application/json" -X POST -d {...JSON...} <API_RESOURCE_PATH_GOES_HERE>File upload formats ¶
For an upload of a file you can send pure arbitrary byte data in the request.
However, you may also choose to upload a file using Base64 encoding.
To do so, it is required to add the header Content-Transfer-Encoding : base64, and the body should contain contents of the file as Base64 string.
Compression ¶
All requests including Accept-Encoding: gzip header wil get compressed content as response.
Accept-Encoding: gzipif you do not provide Accept-Encoding we will return uncompressed content.
Skipping Response Body ¶
When creating or updating a resource the API can be configured to not return the resulting object in the message body. This can be accomplished by providing a custom header with the request:
`X-LF-SKIP-BODY: true`No message body will be provided in the response and the HTTP response code will be 204. This may be useful in situations where minimizing bandwidth is a concern and when the resulting resource size is large (for example: table elements or text elements).
Note: if the header is not provided or when a value other than true is given it will be ignored and the API will default to returning the full message body.
Pagination ¶
Some requests return paginated results of items (usually 20 at a time). Paginated items will be returned as a JSON array:
[
{...some JSON...},
{...some JSON...},
{...some JSON...},
{...some JSON...}
]The total amount of found items will be available in a header X-Total-Count. This header will always be present for
pageable requests.
You can control the offset and number of results returned by adjusting the offset and limit query parameters. All
endpoints will limit the number of results returned by the limit parameter and fallback on the allowed maximum if you
request too many items. The usual maximum for offset is 50 items but may differ by endpoint.
curl -H "Authorization: Bearer $LABFOLDER_API_TOKEN" <API_RESOURCE_PATH_GOES_HERE>?limit=1000
[
{...some JSON...},
{...some JSON...},
{...some JSON...},
{...some JSON...}
]Client Errors ¶
Client errors are denoted as a 4XX response code. All errors will return JSON with a message attribute explaining what went wrong.
{
"status": 400,
"message": "Unable to parse JSON"
}There are several types of errors:
Authentication and authorization related errors
These will return either a 401 Unauthorized on missing authentication or a 403 Forbidden on missing authorization.
Invalid requests because of invalid HTTP verbs or media types
These will return a 405 Method Not Allowed or 415 Unsupported Media Type respectively.
Missing parameters or invalid body format
A 400 Bad Request is usually returned in case of missing parameters or an invalid body format. The latter could be because of invalid JSON or the wrong object shape (e.g. wrong nesting of objects).
Validation errors
A 422 Unprocessable Entity is returned if the body format is correct but the entity did not pass validation. This denotes a wrong user input and can potentially be signalled to the user.
Timezones & Date Format ¶
Date Format
In general the API returns and expects dates & times in the ISO 8601 format including the timezone specification.
For example: 2017-02-27T17:05:06.000+0100 for a time or 2017-02-27 for a date.
Timezone
The date time will be returned in the timezone of the server.
Data Access ¶
According to the provided authentication token the requesting user is identified.
Full List Requests
On full list requests, the returned entities always contain all user accessible data and not only the user self-created content, as far as not mentioned differently in the endpoint description.
Groups ¶
Groups act as a container for users and projects. They allow to manage shared access for the containing contents.
The following operations are available for groups:
Groups ¶
List GroupsGET/groups{?type,limit,offset}
Returns all the top level groups (subgroups are not returned) that user belongs to.
Example URI
GET /api/v2/groups?type=BASIC&limit=&offset=
URI Parameters
- type
string(optional) Example: BASICGroup type to be filtered
Choices:
BASICADVANCED- limit
number(optional) Default: 20Maximum number of groups to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"title": "Luke's Private Group",
"id": "46123",
"owner_id": "11038",
"description": "This is a group description",
"type": "BASIC",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"settings": {
"prevent_delete_project": false,
"prevent_private_projects": false,
"allow_user_in_multiple_subgroups": false,
"prevent_export": false,
"only_admins_create_templates": false
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the group"
},
"id": {
"type": "string",
"description": "the unique id of the group"
},
"owner_id": {
"type": "string",
"description": "the id of the group owner"
},
"description": {
"type": "string",
"description": "the description of the group"
},
"type": {
"type": "string",
"enum": [
"BASIC",
"ADVANCED"
],
"description": "the type of the group"
},
"creation_date": {
"type": "string",
"description": "date when the group was created"
},
"version_date": {
"type": "string",
"description": "date when the group was last modified"
},
"settings": {
"type": "object",
"properties": {
"prevent_delete_project": {
"type": "boolean",
"description": "indicates if the project deletion is disabled for the group"
},
"prevent_private_projects": {
"type": "boolean",
"description": "indicates if the group members are allowed to create private projects"
},
"allow_user_in_multiple_subgroups": {
"type": "boolean",
"description": "indicates if group members are allowed to be in multiple subgroups"
},
"prevent_export": {
"type": "boolean",
"description": "indicates if the group members are allowed to export data"
},
"only_admins_create_templates": {
"type": "boolean",
"description": "indicates if the non-admin group members are allowed to create templates"
}
},
"required": [
"prevent_delete_project",
"prevent_private_projects",
"allow_user_in_multiple_subgroups",
"prevent_export",
"only_admins_create_templates"
],
"description": "the group settings"
}
},
"required": [
"title",
"id",
"owner_id",
"description",
"type",
"creation_date",
"version_date",
"settings"
]
}
}Group ¶
Get GroupGET/groups/{id}
Returns the specified group.
Example URI
GET /api/v2/groups/1200
URI Parameters
- id
string(required) Example: 1200id of the group
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Group",
"id": "46123",
"owner_id": "11038",
"description": "This is a group description",
"type": "BASIC",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"settings": {
"prevent_delete_project": false,
"prevent_private_projects": false,
"allow_user_in_multiple_subgroups": false,
"prevent_export": false,
"only_admins_create_templates": false
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the group"
},
"id": {
"type": "string",
"description": "the unique id of the group"
},
"owner_id": {
"type": "string",
"description": "the id of the group owner"
},
"description": {
"type": "string",
"description": "the description of the group"
},
"type": {
"type": "string",
"enum": [
"BASIC",
"ADVANCED"
],
"description": "the type of the group"
},
"creation_date": {
"type": "string",
"description": "date when the group was created"
},
"version_date": {
"type": "string",
"description": "date when the group was last modified"
},
"settings": {
"type": "object",
"properties": {
"prevent_delete_project": {
"type": "boolean",
"description": "indicates if the project deletion is disabled for the group"
},
"prevent_private_projects": {
"type": "boolean",
"description": "indicates if the group members are allowed to create private projects"
},
"allow_user_in_multiple_subgroups": {
"type": "boolean",
"description": "indicates if group members are allowed to be in multiple subgroups"
},
"prevent_export": {
"type": "boolean",
"description": "indicates if the group members are allowed to export data"
},
"only_admins_create_templates": {
"type": "boolean",
"description": "indicates if the non-admin group members are allowed to create templates"
}
},
"required": [
"prevent_delete_project",
"prevent_private_projects",
"allow_user_in_multiple_subgroups",
"prevent_export",
"only_admins_create_templates"
],
"description": "the group settings"
}
},
"required": [
"title",
"id",
"owner_id",
"description",
"type",
"creation_date",
"version_date",
"settings"
],
"additionalProperties": false
}Create GroupPOST/groups
Create a group
Example URI
POST /api/v2/groups
Request
Create Group with TitleHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Entry"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the entry"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /groups/10945Body
{
"title": "Luke's Private Group",
"id": "46123",
"owner_id": "11038",
"description": "This is a group description",
"type": "BASIC",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"settings": {
"prevent_delete_project": false,
"prevent_private_projects": false,
"allow_user_in_multiple_subgroups": false,
"prevent_export": false,
"only_admins_create_templates": false
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the group"
},
"id": {
"type": "string",
"description": "the unique id of the group"
},
"owner_id": {
"type": "string",
"description": "the id of the group owner"
},
"description": {
"type": "string",
"description": "the description of the group"
},
"type": {
"type": "string",
"enum": [
"BASIC",
"ADVANCED"
],
"description": "the type of the group"
},
"creation_date": {
"type": "string",
"description": "date when the group was created"
},
"version_date": {
"type": "string",
"description": "date when the group was last modified"
},
"settings": {
"type": "object",
"properties": {
"prevent_delete_project": {
"type": "boolean",
"description": "indicates if the project deletion is disabled for the group"
},
"prevent_private_projects": {
"type": "boolean",
"description": "indicates if the group members are allowed to create private projects"
},
"allow_user_in_multiple_subgroups": {
"type": "boolean",
"description": "indicates if group members are allowed to be in multiple subgroups"
},
"prevent_export": {
"type": "boolean",
"description": "indicates if the group members are allowed to export data"
},
"only_admins_create_templates": {
"type": "boolean",
"description": "indicates if the non-admin group members are allowed to create templates"
}
},
"required": [
"prevent_delete_project",
"prevent_private_projects",
"allow_user_in_multiple_subgroups",
"prevent_export",
"only_admins_create_templates"
],
"description": "the group settings"
}
},
"required": [
"title",
"id",
"owner_id",
"description",
"type",
"creation_date",
"version_date",
"settings"
],
"additionalProperties": false
}Update GroupPUT/groups/{id}
Updates a group. The group title, description, and settings can be updated. If one of these fields or a specific group setting is not provided, it won’t be updated.
Example URI
PUT /api/v2/groups/1200
URI Parameters
- id
string(required) Example: 1200id of the group
Request
Headers
Content-Type: application/jsonBody
{
"id": "1200",
"title": "Luke's Private Group",
"description": "A short description about the group",
"settings": {
"prevent_delete_project": false,
"prevent_private_projects": false,
"allow_user_in_multiple_subgroups": false,
"prevent_export": false,
"only_admins_create_templates": false
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the group"
},
"title": {
"type": "string",
"description": "the display title of the group"
},
"description": {
"type": "string",
"description": "the display title of the group"
},
"settings": {
"type": "object",
"properties": {
"prevent_delete_project": {
"type": "boolean",
"description": "indicates if the project deletion is disabled for the group"
},
"prevent_private_projects": {
"type": "boolean",
"description": "indicates if the group members are allowed to create private projects"
},
"allow_user_in_multiple_subgroups": {
"type": "boolean",
"description": "indicates if group members are allowed to be in multiple subgroups"
},
"prevent_export": {
"type": "boolean",
"description": "indicates if the group members are allowed to export data"
},
"only_admins_create_templates": {
"type": "boolean",
"description": "indicates if the non-admin group members are allowed to create templates"
}
},
"required": [
"prevent_delete_project",
"prevent_private_projects",
"allow_user_in_multiple_subgroups",
"prevent_export",
"only_admins_create_templates"
],
"description": "the group settings"
}
},
"additionalProperties": false
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Group",
"id": "46123",
"owner_id": "11038",
"description": "This is a group description",
"type": "BASIC",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"settings": {
"prevent_delete_project": false,
"prevent_private_projects": false,
"allow_user_in_multiple_subgroups": false,
"prevent_export": false,
"only_admins_create_templates": false
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the group"
},
"id": {
"type": "string",
"description": "the unique id of the group"
},
"owner_id": {
"type": "string",
"description": "the id of the group owner"
},
"description": {
"type": "string",
"description": "the description of the group"
},
"type": {
"type": "string",
"enum": [
"BASIC",
"ADVANCED"
],
"description": "the type of the group"
},
"creation_date": {
"type": "string",
"description": "date when the group was created"
},
"version_date": {
"type": "string",
"description": "date when the group was last modified"
},
"settings": {
"type": "object",
"properties": {
"prevent_delete_project": {
"type": "boolean",
"description": "indicates if the project deletion is disabled for the group"
},
"prevent_private_projects": {
"type": "boolean",
"description": "indicates if the group members are allowed to create private projects"
},
"allow_user_in_multiple_subgroups": {
"type": "boolean",
"description": "indicates if group members are allowed to be in multiple subgroups"
},
"prevent_export": {
"type": "boolean",
"description": "indicates if the group members are allowed to export data"
},
"only_admins_create_templates": {
"type": "boolean",
"description": "indicates if the non-admin group members are allowed to create templates"
}
},
"required": [
"prevent_delete_project",
"prevent_private_projects",
"allow_user_in_multiple_subgroups",
"prevent_export",
"only_admins_create_templates"
],
"description": "the group settings"
}
},
"required": [
"title",
"id",
"owner_id",
"description",
"type",
"creation_date",
"version_date",
"settings"
],
"additionalProperties": false
}Get Group TreeGET/groups/{id}/tree
Returns tree of group, it’s subgroup and members
Example URI
GET /api/v2/groups/1200/tree
URI Parameters
- id
string(required) Example: 1200id of the group.
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "1200",
"name": "Rebellion",
"children": [
{
"id": "12585",
"admin": false,
"user": {
"id": "3857",
"first_name": "Luke",
"last_name": "Skywalker",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"profile_picture_hash": "abc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"type": "MEMBER"
},
{
"id": "12585",
"title": "Rogue One",
"type": "SUBGROUP",
"children": [
{
"id": "12585",
"admin": false,
"user": {
"id": "3857",
"first_name": "Luke",
"last_name": "Skywalker",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"profile_picture_hash": "abc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"type": "MEMBER"
},
{}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the group"
},
"name": {
"type": "string",
"description": "name of the group"
},
"children": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the group tree membership"
},
"admin": {
"type": "boolean",
"description": "indicator if the group member is admin in this group"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "unique user id of the group member"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "first name of the member. Not defined if this member has a pending group invitation"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "last name of the member. Not defined if this member has a pending group invitation"
},
"email": {
"type": "string",
"description": "email address of the member"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "profile picture hash for the picture url of the user"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"first_name",
"last_name",
"email",
"deactivated",
"profile_picture_hash",
"iam_id"
],
"description": "user identity entity of the group member"
},
"type": {
"type": "string",
"enum": [
"MEMBER"
],
"description": "the type of group tree node"
}
},
"required": [
"id",
"admin",
"user",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the subgroup"
},
"title": {
"type": "string",
"description": "the title of the subgroup"
},
"type": {
"type": "string",
"enum": [
"SUBGROUP"
],
"description": "the type of group tree node"
},
"children": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the group tree membership"
},
"admin": {
"type": "boolean",
"description": "indicator if the group member is admin in this group"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "unique user id of the group member"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "first name of the member. Not defined if this member has a pending group invitation"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "last name of the member. Not defined if this member has a pending group invitation"
},
"email": {
"type": "string",
"description": "email address of the member"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "profile picture hash for the picture url of the user"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"first_name",
"last_name",
"email",
"deactivated",
"profile_picture_hash",
"iam_id"
],
"description": "user identity entity of the group member"
},
"type": {
"type": "string",
"enum": [
"MEMBER"
],
"description": "the type of group tree node"
}
},
"required": [
"id",
"admin",
"user",
"type"
]
},
{
"type": "object",
"properties": {}
}
],
"description": "child members and subgroups will be represented recursively"
}
},
"required": [
"id",
"title",
"type"
]
}
],
"description": "child members and subgroups will be represented recursively"
}
},
"required": [
"id",
"name",
"children"
],
"additionalProperties": false
}Subgroups ¶
List SubgroupsGET/groups/{id}/subgroups{?parent_id,only_root_level,limit,offset}
Returns subgroups of the group
Example URI
GET /api/v2/groups/1200/subgroups?parent_id=&only_root_level=&limit=&offset=
URI Parameters
- id
string(required) Example: 1200id of the group
- parent_id
string(optional)Only return subgroups that reside within the specified subgroup
- only_root_level
boolean(optional) Default: falseOnly return root (top) level subgroups - I.e. subgroups that do not reside within a subgroup
- limit
number(optional) Default: 20Maximum number of subgroups to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "12585",
"title": "Rogue One",
"group_id": "1200",
"parent_id": "12587"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the subgroup"
},
"title": {
"type": "string",
"description": "the title of the subgroup"
},
"group_id": {
"type": "string",
"description": "the id of the group this subgroup is part of"
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "the subgroup id to which this subgroup is subordinate"
}
},
"required": [
"id",
"title",
"group_id",
"parent_id"
]
}
}Update SubgroupPATCH/groups/{id}/subgroups/{subgroupId}
This endpoint complies with RFC 6902, the specification for JSON Patch.
- Update a subgroup’s name.
The supported operations will grow in time.
Example URI
PATCH /api/v2/groups/1207/subgroups/237
URI Parameters
- id
string(required) Example: 1207the unique id of the group
- subgroupId
string(required) Example: 237the unique id of the subgroup
Request
Change Subgroup NameHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/name",
"value": "New Subgroup Name"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/name"
],
"description": "JSON Pointer notation to the field that holds the subgroup name"
},
"value": {
"type": "string",
"description": "the name of the subgroup"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "237",
"title": "New Subgroup Name",
"group_id": "1207",
"parent_id": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the subgroup"
},
"title": {
"type": "string",
"description": "the title of the subgroup"
},
"group_id": {
"type": "string",
"description": "the id of the group this subgroup is part of"
},
"parent_id": {
"type": [
"string",
"null"
],
"description": "the subgroup id to which this subgroup is subordinate"
}
},
"required": [
"id",
"title",
"group_id",
"parent_id"
],
"additionalProperties": false
}Group Memberships ¶
List Group MembershipsGET/groups/{id}/memberships{?subgroup_id,user_id,project_ids,project_folder_ids,only_root_level,username,include_pending,limit,offset}
Returns memberships of users in a group
Example URI
GET /api/v2/groups/1200/memberships?subgroup_id=234&user_id=11040&project_ids=36275&project_folder_ids=36274&only_root_level=true&username=Han&include_pending=true&limit=&offset=
URI Parameters
- id
string(required) Example: 1200id of the group
- subgroup_id
string(optional) Example: 234Only return group members that reside within the specified subgroup
- user_id
string(optional) Example: 11040Only return membership information for the specified user
- project_ids
string(optional) Example: 36275Comma separated list of project ids that have to be accessible for the group members
- project_folder_ids
string(optional) Example: 36274Comma separated list of project folder ids that have to be accessible for the group members
- only_root_level
boolean(optional) Default: false Example: trueOnly return root (top) level group members - I.e. members that do not reside within a subgroup
- username
string(optional) Example: HanA search string to filter group members by email, first name or last name
- include_pending
boolean(optional) Default: false Example: true[beta] Include the pending group invitations in the result
- limit
number(optional) Default: 20Maximum number of group members to return - Maximum allowed value is 100
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "12585",
"group_id": "1200",
"subgroup_id": "12587",
"admin": false,
"user": {
"id": "3857",
"first_name": "Luke",
"last_name": "Skywalker",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the group membership"
},
"group_id": {
"type": "string",
"description": "the id of the group this member belongs to"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the id of the subgroup this member belongs to"
},
"admin": {
"type": "boolean",
"description": "indicator if the group member is admin in this group"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "unique user id of the group member"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "first name of the member. Not defined if this member has a pending group invitation"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "last name of the member. Not defined if this member has a pending group invitation"
},
"email": {
"type": "string",
"description": "email address of the member"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"first_name",
"last_name",
"email",
"deactivated",
"profile_picture_hash",
"iam_id"
],
"description": "user identity entity of the group member"
}
},
"required": [
"id",
"group_id",
"subgroup_id",
"admin",
"user"
]
}
}Get Group MembershipGET/group-memberships/{id}
Returns the specified group membership
Example URI
GET /api/v2/group-memberships/3132
URI Parameters
- id
string(required) Example: 3132id of the group membership
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "12585",
"group_id": "1200",
"subgroup_id": "12587",
"admin": false,
"user": {
"id": "3857",
"first_name": "Luke",
"last_name": "Skywalker",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the group membership"
},
"group_id": {
"type": "string",
"description": "the id of the group this member belongs to"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the id of the subgroup this member belongs to"
},
"admin": {
"type": "boolean",
"description": "indicator if the group member is admin in this group"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "unique user id of the group member"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "first name of the member. Not defined if this member has a pending group invitation"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "last name of the member. Not defined if this member has a pending group invitation"
},
"email": {
"type": "string",
"description": "email address of the member"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"first_name",
"last_name",
"email",
"deactivated",
"profile_picture_hash",
"iam_id"
],
"description": "user identity entity of the group member"
}
},
"required": [
"id",
"group_id",
"subgroup_id",
"admin",
"user"
],
"additionalProperties": false
}Create Group MembershipPOST/group-memberships
Create a new group membership. This is how new group members may be invited to a group or subgroup.
Example URI
POST /api/v2/group-memberships
Request
Create new group membership in groupHeaders
Content-Type: application/jsonBody
{
"email": "princess.leia@starwars.com",
"group_id": "1203"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the person to invite to your group"
},
"group_id": {
"type": "string",
"description": "The group id"
}
},
"required": [
"email",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /group-memberships/12585Body
{
"id": "12585",
"group_id": "1200",
"subgroup_id": "12587",
"admin": false,
"user": {
"id": "3857",
"first_name": "Luke",
"last_name": "Skywalker",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the group membership"
},
"group_id": {
"type": "string",
"description": "the id of the group this member belongs to"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the id of the subgroup this member belongs to"
},
"admin": {
"type": "boolean",
"description": "indicator if the group member is admin in this group"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "unique user id of the group member"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "first name of the member. Not defined if this member has a pending group invitation"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "last name of the member. Not defined if this member has a pending group invitation"
},
"email": {
"type": "string",
"description": "email address of the member"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"first_name",
"last_name",
"email",
"deactivated",
"profile_picture_hash",
"iam_id"
],
"description": "user identity entity of the group member"
}
},
"required": [
"id",
"group_id",
"subgroup_id",
"admin",
"user"
],
"additionalProperties": false
}Request
Create new group membership in subgroupHeaders
Content-Type: application/jsonBody
{
"email": "han.solo@starwars.com",
"group_id": "1203",
"subgroup_id": "235"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the person to invite to your group"
},
"group_id": {
"type": "string",
"description": "The group id"
},
"subgroup_id": {
"type": "string",
"description": "id of the subgroup to which the member is added"
}
},
"required": [
"email",
"group_id",
"subgroup_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /group-memberships/12585Body
{
"id": "12585",
"group_id": "1200",
"subgroup_id": "12587",
"admin": false,
"user": {
"id": "3857",
"first_name": "Luke",
"last_name": "Skywalker",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique identifier of the group membership"
},
"group_id": {
"type": "string",
"description": "the id of the group this member belongs to"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the id of the subgroup this member belongs to"
},
"admin": {
"type": "boolean",
"description": "indicator if the group member is admin in this group"
},
"user": {
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "unique user id of the group member"
},
"first_name": {
"type": [
"string",
"null"
],
"description": "first name of the member. Not defined if this member has a pending group invitation"
},
"last_name": {
"type": [
"string",
"null"
],
"description": "last name of the member. Not defined if this member has a pending group invitation"
},
"email": {
"type": "string",
"description": "email address of the member"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"first_name",
"last_name",
"email",
"deactivated",
"profile_picture_hash",
"iam_id"
],
"description": "user identity entity of the group member"
}
},
"required": [
"id",
"group_id",
"subgroup_id",
"admin",
"user"
],
"additionalProperties": false
}Delete Group MembershipDELETE/group-memberships/{id}
Delete a group membership. This endpoint can be used to:
-
leave a group, either on their own accord, or by a group admin.
-
decline a membership invitation
In order to be removed from a group, a user must have no project, template, or folder ownership within the group context.
Example URI
DELETE /api/v2/group-memberships/3135
URI Parameters
- id
string(required) Example: 3135id of the group membership
Response
204Projects ¶
Projects act as a container for entries and are used to manage shared access for the containing entries.
The following operations are available for projects:
Projects ¶
List ProjectsGET/projects{?group_id,group_ids,owner_id,owner_ids,only_root_level,folder_id,project_ids,title,private_projects_only,creation_date_from,creation_date_to,modification_date_from,modification_date_to,include_hidden,access_role,expand,limit,offset}
Returns a list of projects the user has access to.
Example URI
GET /api/v2/projects?group_id=1200&group_ids=1200,1201&owner_id=11038&owner_ids=11038,11039&only_root_level=true&folder_id=36274&project_ids=36279&title=My project&private_projects_only=true&creation_date_from=2023-02-08&creation_date_to=2023-02-09&modification_date_from=2023-02-08&modification_date_to=2023-02-09&include_hidden=false&access_role=&expand=owner&limit=&offset=
URI Parameters
- group_id
string(optional) Example: 1200Only return projects that belong to the specified group. Please note that this param is deprecated and will removed in the future. Its usage shall be replaced with group_ids, which is a comma separated list that contains one or more group IDs.
- group_ids
string(optional) Example: 1200,1201Only return projects that belong to the specified groups (comma separated list)
- owner_id
string(optional) Example: 11038Only return projects that are owned by the given user. Please note that this param is deprecated and will removed in the future. Its usage shall be replaced with owner_ids, which is a comma separated list that contains one or more user IDs.
- owner_ids
string(optional) Example: 11038,11039Only return projects that are owned by the given users (comma separated list)
- only_root_level
boolean(optional) Default: false Example: trueOnly return root (top) level projects - I.e. projects that do not reside within a folder
- folder_id
string(optional) Example: 36274Only return projects that reside within the specified folder
- project_ids
string(optional) Example: 36279A comma separated list of project ids specifying the projects to be returned
- title
string(optional) Example: My projectOnly return projects with a title containing this string
- private_projects_only
boolean(optional) Example: trueOnly return the user’s private projects
- creation_date_from
date(optional) Example: 2023-02-08Only return projects that were created past or at the specified date
- creation_date_to
date(optional) Example: 2023-02-09Only return projects that were created before or at the specified date
- modification_date_from
date(optional) Example: 2023-02-08Only return projects that were edited past or at the specified date
- modification_date_to
date(optional) Example: 2023-02-09Only return projects that were edited before or at the specified date
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden projects
- access_role
enum(optional)Only return projects that the user has access with a specific role. If not provided, all projects the user has access to will be returned.
Choices:
ADMINSUBGROUP_ADMINOWNERUSER- expand
string(optional) Example: ownerA comma separated list of related domain objects that should be expanded for all items returned
Choices:
owner- limit
number(optional) Default: 20Maximum number of projects to return - Maximum allowed limit is 100
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the project is associated, null is used for the private projects"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the project is located. null is used projects which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
]
}
}Create ProjectPOST/projects
Create a project
Example URI
POST /api/v2/projects
Request
Create Private ProjectHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Project"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /projects/1234Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the project is associated, null is used for the private projects"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the project is located. null is used projects which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
]
}Request
Create Private Project in a FolderHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Project",
"folder_id": "36273"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"folder_id": {
"type": "string",
"description": "the id of the folder in which the project is stored"
}
},
"required": [
"title",
"folder_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /projects/1234Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "null",
"folder_id": "36273",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the project is associated, null is used for the private projects"
},
"folder_id": {
"type": "string",
"description": "the id of the folder in which the project is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
]
}Request
Create Group ProjectHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Project",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the project is associated"
}
},
"required": [
"title",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /projects/1234Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "1200",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the project is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the project is located. null is used projects which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
]
}Request
Create Group Project in a FolderHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Project",
"folder_id": "36274",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"folder_id": {
"type": "string",
"description": "the id of the folder in which the project is stored"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the project is associated"
}
},
"required": [
"title",
"folder_id",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /projects/1234Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "1200",
"folder_id": "36273",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the project is associated"
},
"folder_id": {
"type": "string",
"description": "the id of the folder in which the project is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
]
}Update ProjectPATCH/projects/{id}
This endpoint complies with RFC 6902, the specification for JSON Patch.
-
Update a project’s owner.
-
Update a project parent folder given it’s id and return the modified objects.
-
Update a project’s visibility, meaning hiding and unhiding projects.
The supported operations will grow in time.
Example URI
PATCH /api/v2/projects/36275
URI Parameters
- id
string(required) Example: 36275the unique id of the project
Request
Change Project OwnerPlease note that, for change owner operation, the ‘value’ of the patch operation should be the new owner membership id, not the new owner id.
Headers
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/owner_id",
"value": "3130"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/owner_id"
],
"description": "JSON Pointer notation to the owner of the project"
},
"value": {
"type": "string",
"description": "the unique identifier of the group membership of the new owner"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the project is associated, null is used for the private projects"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the project is located. null is used projects which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
],
"additionalProperties": false
}Request
Move Project to another folderHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/folder_id",
"value": "36284"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/folder_id"
],
"description": "JSON Pointer notation to the folder the mentioned project will be moved into"
},
"value": {
"type": "string",
"description": "id of the new parent folder. In case of root folder, the value should be `0`."
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the project is associated, null is used for the private projects"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the project is located. null is used projects which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
],
"additionalProperties": false
}Request
Change Project VisibilityHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/hidden",
"value": false
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/hidden"
],
"description": "JSON Pointer notation to the whether the project is hidden"
},
"value": {
"type": "boolean",
"description": "a boolean indicating whether the project should be hidden"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Project",
"id": "46123",
"owner_id": "11038",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"number_of_entries": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the project"
},
"id": {
"type": "string",
"description": "the unique id of the project"
},
"owner_id": {
"type": "string",
"description": "the id of the project owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the project is associated, null is used for the private projects"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the project is located. null is used projects which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the project is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the project was created"
},
"version_date": {
"type": "string",
"description": "date when the project was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project is collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. a project only shows as collaborative when the multi-author feature is enabled. its value is always false when the feature is disabled."
},
"number_of_entries": {
"type": "number",
"description": "number of entries in the project"
}
},
"required": [
"title",
"id",
"owner_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"number_of_entries"
],
"additionalProperties": false
}Update Project AccessPUT/projects/{id}/access
Update the access settings of a project.
A project can be either shared with specific members, subgroups or with the whole group.
Sharing it with subgroups or the group will automatically enable access for any new member joining these group structures.
The project owner is always added to the access settings membership IDs automatically, to guarantee that she has access
at any time.
If the project is located in a folder, all access settings of that folder will cascade to the respective project, even if you do not provide those within your request. This means the response might slightly differ from the request for this and other reasons mentioned above.
Example URI
PUT /api/v2/projects/36275/access
URI Parameters
- id
string(required) Example: 36275id of the project
Request
Update Project AccessHeaders
Content-Type: application/jsonBody
{
"project_id": "36275",
"group_membership_ids": [
"3127",
"3129"
],
"subgroup_ids": [
"234"
],
"full_group_access": false,
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "id of the project"
},
"group_membership_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "ids of memberships that have access to the project granted"
},
"subgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "ids of subgroups which members have access to the project granted"
},
"full_group_access": {
"type": "boolean",
"description": "boolean flag indicating if all group members have access to the project granted. if this has value 'true', it makes setting the id fields obsolete."
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project should be collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. its default value is false. making a project collaborative is only possible when the multi-author feature is enabled. its value is always false when the feature is disabled."
}
},
"required": [
"project_id",
"group_membership_ids",
"subgroup_ids",
"full_group_access"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"project_id": "36275",
"group_membership_ids": [
"3127",
"3129"
],
"subgroup_ids": [
"234"
],
"full_group_access": false,
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "id of the project"
},
"group_membership_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "ids of memberships that have access to the project granted"
},
"subgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "ids of subgroups which members have access to the project granted"
},
"full_group_access": {
"type": "boolean",
"description": "boolean flag indicating if all group members have access to the project granted. if this has value 'true', it makes setting the id fields obsolete."
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the project should be collaborative. when this is true, every entry within this project can be edited by all project members instead of by its author only. its default value is false. making a project collaborative is only possible when the multi-author feature is enabled. its value is always false when the feature is disabled."
}
},
"required": [
"project_id",
"group_membership_ids",
"subgroup_ids",
"full_group_access"
],
"additionalProperties": false
}Delete ProjectDELETE/projects/{id}
Delete a project
Example URI
DELETE /api/v2/projects/36286
URI Parameters
- id
string(required) Example: 36286id of the project
Response
204Project Filters ¶
List Project FiltersGET/project-filters{?group_id,title,include_hidden,folder_id,search_by_ids,entry_owner_ids,entry_subgroup_ids,entry_tag_ids,limit,offset}
[beta] Returns a list of projects and project folders that the user has access to.
When both folder_id and title are provided, the response will include only values
matching both requirements.
The response object will include a path field when the request includes the
search_by_ids or title parameter.
Example URI
GET /api/v2/project-filters?group_id=1200&title=My project&include_hidden=false&folder_id=36274&search_by_ids=36274,36288&entry_owner_ids=300,301&entry_subgroup_ids=400,401&entry_tag_ids=500,501&limit=&offset=
URI Parameters
- group_id
string(required) Example: 1200Only return projects/folders that belong to the specified group.
- folder_id
string(optional) Example: 36274Only return projects/folders that reside within the specified folder. Returns the root folder if the parameter is set to
0.- search_by_ids
string(optional) Example: 36274,36288A comma separated list of one or more project/folder ids. If provided, the response will include Project ids matching these specific ids. Note that this parameter cannot be used in conjunction with the
titleparameter.- entry_owner_ids
string(optional) Example: 300,301A comma separated list of one or more user ids. If provided, the response will include Project ids of Entries owned by these specific Users.
- entry_subgroup_ids
string(optional) Example: 400,401A comma separated list of one or more subgroups ids. If provided, the response will include Project ids of Entries owned by the Users in the provided Subgroups
- title
string(optional) Example: My projectOnly return projects/folders with a title containing this string. Note that this parameter cannot be used in conjunction with the
search_by_idsparameter.- entry_tag_ids
string(optional) Example: 500,501A comma separated list of one or more tag ids. If provided, the response will include Project ids of Entries having the specified tag or custom date ids.
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden projects/folders
- limit
number(optional) Default: 20Maximum number of projects/folders to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "46123",
"title": "Luke's Private Project",
"is_folder": false,
"path": [
"46121",
"46122"
],
"number_of_projects": 1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the project/folder"
},
"title": {
"type": "string",
"description": "the display name of the project"
},
"is_folder": {
"type": "boolean",
"description": "indicating if the entity is a folder"
},
"path": {
"type": [
"array",
"null"
],
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "an ordered list of folder ids that lead to this project or folder"
},
"number_of_projects": {
"type": [
"number",
"null"
],
"description": "the total number of projects in the folder (and its subfolders)"
}
},
"required": [
"id",
"title",
"is_folder"
]
}
}Folders ¶
Folders are used to organize projects hierarchically.
Folders ¶
List FoldersGET/folders{?group_id,group_ids,owner_id,owner_ids,only_root_level,content_type,parent_folder_id,folder_ids,title,private_folders_only,creation_date_from,creation_date_to,modification_date_from,modification_date_to,include_hidden,access_role,expand,limit,offset}
Returns a list of folders the user has access to.
Example URI
GET /api/v2/folders?group_id=1200&group_ids=1200,1201&owner_id=11038&owner_ids=11038,11039&only_root_level=true&content_type=&parent_folder_id=36274&folder_ids=36278&title=My folder&private_folders_only=true&creation_date_from=2023-02-08&creation_date_to=2023-02-09&modification_date_from=2023-02-08&modification_date_to=2023-02-09&include_hidden=false&access_role=&expand=owner&limit=&offset=
URI Parameters
- group_id
string(optional) Example: 1200Only return folders that belong to the specified group. Please note that this param is deprecated and will removed in the future. Its usage shall be replaced with group_ids, which is a comma separated list that contains one or more group IDs.
- group_ids
string(optional) Example: 1200,1201Only return folders that belong to the specified groups (comma separated list)
- owner_id
string(optional) Example: 11038Only return folders that are owned by the given user. Please note that this param is deprecated and will removed in the future. Its usage shall be replaced with owner_ids, which is a comma separated list that contains one or more user IDs.
- owner_ids
string(optional) Example: 11038,11039Only return folders that are owned by the given users (comma separated list)
- only_root_level
boolean(optional) Default: false Example: trueOnly return root (top) level folders - I.e. folders that do not reside within another folder
- content_type
string(optional) Default: PROJECTSThe desired type of folders to retrieve
Choices:
PROJECTSTEMPLATES- parent_folder_id
string(optional) Example: 36274Only return folders that reside within the specified folder
- folder_ids
string(optional) Example: 36278A comma separated list of project ids specifying the projects to be returned
- title
string(optional) Example: My folderOnly return folders with a title containing this string
- private_folders_only
boolean(optional) Example: trueOnly return the user’s private folders
- creation_date_from
date(optional) Example: 2023-02-08Only return folders that were created past or at the specified date
- creation_date_to
date(optional) Example: 2023-02-09Only return folders that were created before or at the specified date
- modification_date_from
date(optional) Example: 2023-02-08Only return folders that were edited past or at the specified date
- modification_date_to
date(optional) Example: 2023-02-09Only return folders that were edited before or at the specified date
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden folders
- access_role
enum(optional)Only return folders that the user has access with a specific role. If not provided, all folders the user has access to will be returned.
Choices:
ADMINSUBGROUP_ADMINOWNERUSER- expand
string(optional) Example: ownerA comma separated list of related domain objects that should be expanded for all items returned
Choices:
owner- limit
number(optional) Default: 20Maximum number of folders to return - Maximum allowed limit is 100
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "46123",
"title": "Luke's Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "null",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}
}Create FolderPOST/folders
Create a folder. A folder may either contain projects or templates, as well as children folders of the same type. A private folder is intended for your use only, while a group folder may be shared with the members of that group.
Example URI
POST /api/v2/folders
Request
Create top-level Private Folder to hold ProjectsHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Folder",
"content_type": "PROJECTS"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the folder"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicate if the folder should hold Projects or Templates"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /folders/46123Body
{
"id": "46123",
"title": "Luke's Private Folder",
"owner_id": "11038",
"group_id": "null",
"parent_folder_id": "null",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "null is used for the private folders"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}Request
Create top-level Private Folder to hold TemplatesHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Folder",
"content_type": "TEMPLATES"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the folder"
},
"content_type": {
"type": "string",
"description": "indicate if the folder should hold Projects or Templates"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /folders/46123Body
{
"id": "46123",
"title": "Luke's Private Folder",
"owner_id": "11038",
"group_id": "null",
"parent_folder_id": "null",
"hidden": false,
"content_type": "TEMPLATES",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "null is used for the private folders"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}Request
Create Private Folder as a Child of an Existing Private FolderHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Folder",
"content_type": "PROJECTS",
"parent_folder_id": "36273"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the folder"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicate if the folder should hold Projects or Templates"
},
"parent_folder_id": {
"type": "string"
}
},
"required": [
"title",
"parent_folder_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /folders/46123Body
{
"id": "46123",
"title": "Luke's Private Folder",
"owner_id": "11038",
"group_id": "null",
"parent_folder_id": "36273",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "null is used for the private folders"
},
"parent_folder_id": {
"type": "string",
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}Request
Create a top-level Group Folder to hold ProjectsHeaders
Content-Type: application/jsonBody
{
"title": "Group Folder",
"content_type": "PROJECTS",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the folder"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicate if the folder should hold Projects or Templates"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the folder is associated"
}
},
"required": [
"title",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /folders/46123Body
{
"id": "46123",
"title": "Group Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "null",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}Request
Create a top-level Group Folder to hold TemplatesHeaders
Content-Type: application/jsonBody
{
"title": "Group Folder",
"content_type": "TEMPLATES",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the folder"
},
"content_type": {
"type": "string",
"description": "indicate if the folder should hold Projects or Templates"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the folder is associated"
}
},
"required": [
"title",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /folders/46123Body
{
"id": "46123",
"title": "Group Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "null",
"hidden": false,
"content_type": "TEMPLATES",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}Request
Create Group Folder as a Child of an Existing Group FolderHeaders
Content-Type: application/jsonBody
{
"title": "Group Folder",
"content_type": "PROJECTS",
"group_id": "1200",
"parent_folder_id": "36274"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the folder"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicate if the folder should hold Projects or Templates"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": "string"
}
},
"required": [
"title",
"group_id",
"parent_folder_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /projects/46123Body
{
"id": "46123",
"title": "Group Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "36274",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": "string",
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
]
}Update FolderPATCH/folders/{id}
This endpoint complies with RFC 6902, the specification for JSON Patch.
Please note that the ‘value’ of the patch operation should be the new owner membership id, not the new owner id.
-
Update a folder’s owner.
-
Update a folder’s parent folder given it’s id and return the modified objects.
-
Update a folder’s visibility, meaning hiding and unhiding folders which includes hiding everything beneath the folder.
The supported operations will grow in time.
Example URI
PATCH /api/v2/folders/36287
URI Parameters
- id
string(required) Example: 36287the unique id of the folder
Request
Change Folder OwnerHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/owner_id",
"value": "3128"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/owner_id"
],
"description": "JSON Pointer notation to the owner of the folder"
},
"value": {
"type": "string",
"description": "the unique identifier of the group membership of the new owner"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "46123",
"title": "Luke's Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "null",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
],
"additionalProperties": false
}Request
Move Folder to another folderHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/folder_id",
"value": "36284"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/folder_id"
],
"description": "JSON Pointer notation to the folder the mentioned folder will be moved into"
},
"value": {
"type": "string",
"description": "id of the new parent folder. In case of root folder, the value should be `0`."
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "46123",
"title": "Luke's Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "null",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
],
"additionalProperties": false
}Request
Change Folder VisibilityHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/hidden",
"value": false
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/hidden"
],
"description": "JSON Pointer notation to the whether the folder is hidden"
},
"value": {
"type": "boolean",
"description": "a boolean indicating whether the folder should be hidden"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "46123",
"title": "Luke's Folder",
"owner_id": "11038",
"group_id": "1200",
"parent_folder_id": "null",
"hidden": false,
"content_type": "PROJECTS",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the folder"
},
"title": {
"type": "string",
"description": "the display name of the folder"
},
"owner_id": {
"type": "string",
"description": "the id of the folder owner"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the folder is associated"
},
"parent_folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the closest accessible parent folder in which the folder is located for the user. null is used folders which are not in a parent folder or don't have closest accessible parent folder"
},
"hidden": {
"type": "boolean",
"description": "indicating if the folder is hidden"
},
"content_type": {
"type": "string",
"enum": [
"PROJECTS",
"TEMPLATES"
],
"default": "PROJECTS",
"description": "indicates if this folder holds Projects or Templates"
},
"creation_date": {
"type": "string",
"description": "date when the folder was created"
},
"version_date": {
"type": "string",
"description": "date when the folder was last modified"
}
},
"required": [
"id",
"title",
"owner_id",
"group_id",
"parent_folder_id",
"hidden",
"content_type",
"creation_date",
"version_date"
],
"additionalProperties": false
}Update Folder AccessPUT/folders/{id}/access
Update the access settings of a folder.
A folder can be either shared with specific members, subgroups or with the whole group.
Sharing it with subgroups or the group will automatically enable access for any new member joining these group structures.
The folder owner is always added to the access settings membership IDs automatically, to guarantee that she has access
at any time.
If the folder is located inside another folder, all access settings of the parent folder will cascade to the respective folder, even if you do not provide those within your request. This means the response might slightly differ from the request for this and other reasons mentioned above.
Example URI
PUT /api/v2/folders/36274/access
URI Parameters
- id
string(required) Example: 36274id of the folder
Request
Update Folder AccessHeaders
Content-Type: application/jsonBody
{
"folder_id": "36274",
"group_membership_ids": [
"3127",
"3129"
],
"subgroup_ids": [
"234"
],
"full_group_access": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"folder_id": {
"type": "string",
"description": "id of the folder"
},
"group_membership_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "ids of memberships that have access to the folder granted"
},
"subgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "ids of subgroups which members have access to the folder granted"
},
"full_group_access": {
"type": "boolean",
"description": "boolean flag indicating if all group members have access to the folder granted. if this has value 'true', it makes setting the id fields obsolete."
}
},
"required": [
"folder_id",
"group_membership_ids",
"subgroup_ids",
"full_group_access"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"folder_id": "36274",
"group_membership_ids": [
"3127",
"3129"
],
"subgroup_ids": [
"234"
],
"full_group_access": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"folder_id": {
"type": "string",
"description": "id of the folder"
},
"group_membership_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "ids of memberships that have access to the folder granted"
},
"subgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "ids of subgroups which members have access to the folder granted"
},
"full_group_access": {
"type": "boolean",
"description": "boolean flag indicating if all group members have access to the folder granted. if this has value 'true', it makes setting the id fields obsolete."
}
},
"required": [
"folder_id",
"group_membership_ids",
"subgroup_ids",
"full_group_access"
],
"additionalProperties": false
}Delete FolderDELETE/folders/{id}
Delete a folder
Example URI
DELETE /api/v2/folders/36288
URI Parameters
- id
string(required) Example: 36288id of the folder
Response
204Templates ¶
The main functionality of a Template is to be copied as a new entry in the notebook. Templates are useful anytime you have a consistently repeated protocol or set of instructions. A template is intended to be like a starting point for a new entry so that monotonous and repetitive data need not be entered over and over when creating new entries.
Templates ¶
Create TemplatePOST/templates
Create a Template
Example URI
POST /api/v2/templates
Request
Create Private TemplateHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Template"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /templates/53124Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
]
}Request
Create Private Template in a FolderHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Template",
"folder_id": "36282"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"folder_id": {
"type": "string",
"description": "the id of the folder in which the template is stored"
}
},
"required": [
"title",
"folder_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /templates/53124Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "36281",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Request
Create Group TemplateHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Template",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the template is associated"
}
},
"required": [
"title",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /templates/53124Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "1200",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Request
Create Group Template in a FolderHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Template",
"folder_id": "36281",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"folder_id": {
"type": "string",
"description": "the id of the folder in which the template is stored"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the template is associated"
}
},
"required": [
"title",
"folder_id",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /templates/53124Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "1200",
"folder_id": "36281",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Request
Create Template from an Existing EntryCreates a new template using the source entry identified in the Source-Id header. Note that the templates target group must be the same group as that of the source entry. Further, you must have read access to the source entry.
Headers
Content-Type: application/json
Source-Id: 938304Body
{
"title": "Luke's Private Template",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"group_id": {
"type": "string",
"description": "The id of the group to which the template is associated. This has to be the same group ID as the one of the source entry"
}
},
"required": [
"title",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /templates/53124Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "1200",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}List TemplatesGET/templates{?group_ids,owner_ids,only_root_level,folder_id,template_ids,title,private_templates_only,creation_date_from,creation_date_to,modification_date_from,modification_date_to,include_hidden,access_role,expand,limit,offset}
Returns a list of templates the user has access to.
Example URI
GET /api/v2/templates?group_ids=1200,1201&owner_ids=11038,11039&only_root_level=true&folder_id=36274&template_ids=36279&title=My template&private_templates_only=true&creation_date_from=2023-02-08&creation_date_to=2023-02-09&modification_date_from=2023-02-08&modification_date_to=2023-02-09&include_hidden=false&access_role=&expand=&limit=&offset=
URI Parameters
- group_ids
string(optional) Example: 1200,1201Only return templates that belong to the specified groups (comma separated list)
- owner_ids
string(optional) Example: 11038,11039Only return templates that are owned by the given users (comma separated list)
- only_root_level
boolean(optional) Default: false Example: trueOnly return root (top) level templates - I.e. templates that do not reside within a folder
- folder_id
string(optional) Example: 36274Only return templates that reside within the specified folder
- template_ids
string(optional) Example: 36279A comma separated list of template ids specifying the templates to be returned
- title
string(optional) Example: My templateOnly return templates with a title containing this string
- private_templates_only
boolean(optional) Example: trueOnly return the user’s private templates
- creation_date_from
date(optional) Example: 2023-02-08Only return templates that were created past or at the specified date
- creation_date_to
date(optional) Example: 2023-02-09Only return templates that were created before or at the specified date
- modification_date_from
date(optional) Example: 2023-02-08Only return templates that were edited past or at the specified date
- modification_date_to
date(optional) Example: 2023-02-09Only return templates that were edited before or at the specified date
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden templates
- access_role
enum(optional)Only return templates that the user has access with a specific role. If not provided, all templates the user has access to will be returned.
Choices:
ADMINSUBGROUP_ADMINOWNERUSER- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned
Choices:
owner- limit
number(optional) Default: 20Maximum number of templates to return - Maximum allowed limit is 100
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
]
}
}Get TemplateGET/templates/{id}{?expand}
Returns the latest version of a template
Example URI
GET /api/v2/templates/36280?expand=
URI Parameters
- id
string(required) Example: 36280id of the template
- expand
string(optional)A comma separated list of related domain objects that should be expanded for the template returned
Choices:
entryowner
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Request
?expand=entryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false,
"entry": {
"id": "548613",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "TEXT"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"template_id": "36280"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
},
"entry": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"template_id": {
"type": "string",
"description": "template location of the entry"
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"template_id"
],
"description": "the entry referenced by the `entry_id` property"
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative",
"entry"
],
"additionalProperties": false
}Update TemplatePATCH/templates/{id}
This endpoint complies with RFC 6902, the specification for JSON Patch.
-
Update a template’s owner.
-
Update a template parent folder given it’s id and return the modified objects.
-
Update a template’s visibility, meaning hiding and unhiding templates.
The supported operations will grow in time.
Example URI
PATCH /api/v2/templates/36280
URI Parameters
- id
string(required) Example: 36280the unique id of the template
Request
Change Template OwnerPlease note, to change the owner of a template you must send the group membership id of the new owner (not the user id!).
Headers
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/owner_id",
"value": "3130"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/owner_id"
],
"description": "JSON Pointer notation to the owner of the project"
},
"value": {
"type": "string",
"description": "the unique identifier of the group membership of the new owner"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Request
Move Template to another folderHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/folder_id",
"value": "36281"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/folder_id"
],
"description": "JSON Pointer notation to the folder the mentioned template will be moved into"
},
"value": {
"type": "string",
"description": "id of the new parent folder. In case of root folder, the value should be `0`."
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Request
Change Template VisibilityHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/hidden",
"value": false
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/hidden"
],
"description": "JSON Pointer notation to the whether the template is hidden"
},
"value": {
"type": "boolean",
"description": "a boolean indicating whether the template should be hidden"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Template",
"id": "36280",
"owner_id": "11038",
"entry_id": "548613",
"group_id": "null",
"folder_id": "null",
"hidden": false,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the template"
},
"id": {
"type": "string",
"description": "the unique id of the template"
},
"owner_id": {
"type": "string",
"description": "the id of the template owner"
},
"entry_id": {
"type": [
"string",
"null"
],
"description": "the stable id of the entry which is stored inside the template"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the template is associated"
},
"folder_id": {
"type": [
"string",
"null"
],
"description": "the id of the folder in which the template is stored"
},
"hidden": {
"type": "boolean",
"description": "indicating if the template is hidden"
},
"creation_date": {
"type": "string",
"description": "date when the template was created"
},
"version_date": {
"type": "string",
"description": "date when the template was last modified"
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template is collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its value is always false when the multi-author feature is disabled."
}
},
"required": [
"title",
"id",
"owner_id",
"entry_id",
"group_id",
"folder_id",
"hidden",
"creation_date",
"version_date",
"collaborative"
],
"additionalProperties": false
}Update Template AccessPUT/templates/{id}/access
Update the access settings of a template.
A template can be either shared with specific members, subgroups or with the whole group.
Sharing it with subgroups or the group will automatically enable access for any new member joining these group structures.
The template owner is always added to the access settings membership IDs automatically, to guarantee that she has access
at any time.
If the template is located in a folder, all access settings of that folder will cascade to the respective template, even if you do not provide those within your request. This means the response might slightly differ from the request for this and other reasons mentioned above.
Example URI
PUT /api/v2/templates/36280/access
URI Parameters
- id
string(required) Example: 36280id of the template
Request
Update Template AccessHeaders
Content-Type: application/jsonBody
{
"template_id": "36280",
"group_membership_ids": [
"3127",
"3129"
],
"subgroup_ids": [
"234"
],
"full_group_access": false,
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"template_id": {
"type": "string",
"description": "id of the template"
},
"group_membership_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "ids of memberships that have access to the template granted"
},
"subgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "ids of subgroups which members have access to the template granted"
},
"full_group_access": {
"type": "boolean",
"description": "boolean flag indicating if all group members have access to the template granted. if this has value 'true', it makes setting the id fields obsolete."
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template should be collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its default value is false. making a template collaborative is only possible when the multi-author feature is enabled. its value is always false when the feature is disabled."
}
},
"required": [
"template_id",
"group_membership_ids",
"subgroup_ids",
"full_group_access"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"template_id": "36280",
"group_membership_ids": [
"3127",
"3129"
],
"subgroup_ids": [
"234"
],
"full_group_access": false,
"collaborative": false
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"template_id": {
"type": "string",
"description": "id of the template"
},
"group_membership_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "ids of memberships that have access to the template granted"
},
"subgroup_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "ids of subgroups which members have access to the template granted"
},
"full_group_access": {
"type": "boolean",
"description": "boolean flag indicating if all group members have access to the template granted. if this has value 'true', it makes setting the id fields obsolete."
},
"collaborative": {
"type": "boolean",
"description": "boolean flag indicating whether the template should be collaborative. when true, the template can be edited by all members having access to the template. when false, the template is editable by its author only. its default value is false. making a template collaborative is only possible when the multi-author feature is enabled. its value is always false when the feature is disabled."
}
},
"required": [
"template_id",
"group_membership_ids",
"subgroup_ids",
"full_group_access"
],
"additionalProperties": false
}Delete TemplateDELETE/templates/{id}
Delete a template
Example URI
DELETE /api/v2/templates/36285
URI Parameters
- id
string(required) Example: 36285id of the template
Response
204Template Filters ¶
List Template FiltersGET/template-filters{?group_id,title,include_hidden,folder_id,search_by_ids,limit,offset}
[beta] Returns a list of Template and Template Folders that the user has access to.
When both folder_id and title are provided, the response will include only values
matching both requirements.
The response object will include a path field when the request includes the
search_by_ids or title parameter.
Example URI
GET /api/v2/template-filters?group_id=1200&title=My template&include_hidden=false&folder_id=36274&search_by_ids=36274,36288&limit=&offset=
URI Parameters
- group_id
string(required) Example: 1200Only return templates/folders that belong to the specified group.
- folder_id
string(optional) Example: 36274Only return templates/folders that reside within the specified folder. Returns the root folder if the parameter is set to
0.- search_by_ids
string(optional) Example: 36274,36288A comma separated list of one or more template/folder ids. If provided, the response will include Template ids matching these specific ids. Note that this parameter cannot be used in conjunction with the
titleparameter.- title
string(optional) Example: My templateOnly return templates/folders with a title containing this string. Note that this parameter cannot be used in conjunction with the
search_by_idsparameter.- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden templates/folders
- limit
number(optional) Default: 20Maximum number of templates/folders to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "46123",
"title": "Luke's Private Template",
"is_folder": false,
"path": [
"46121",
"46122"
],
"number_of_templates": 1
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the template/folder"
},
"title": {
"type": "string",
"description": "the display name of the template"
},
"is_folder": {
"type": "boolean",
"description": "indicating if the entity is a folder"
},
"path": {
"type": [
"array",
"null"
],
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "an ordered list of folder ids that lead to this template or folder"
},
"number_of_templates": {
"type": [
"number",
"null"
],
"description": "the total number of templates in the folder (and its subfolders)"
}
},
"required": [
"id",
"title",
"is_folder"
]
}
}Notebook Entries ¶
An Entry is the central piece of the notebook. Entries represent a single item in the notebook. Each entry consists of multiple entry elements of different types and can also have metadata associated with it. Examples for metadata are tags and custom dates. Each entry belongs to a project and has a title. These are the only mandatory fields.
All operations on entries are automatically versioned.
The following operations are available for entries:
Entries ¶
List EntriesGET/entries{?sort,omit_empty_title,title,expand,limit,offset,group_ids,project_ids,folder_ids,author_ids,subgroup_ids,co_author_ids,co_author_subgroup_ids,tag_ids,favorites,creation_date_from,creation_date_to,modification_date_from,modification_date_to,custom_date_ids,skip_total_count,siwor_statuses,sw_statuses,review_statuses,include_hidden}
Returns the list of entries. See also Entry Filters to retrieve aggregate data about entries.
Example URI
GET /api/v2/entries?sort=&omit_empty_title=&title=&expand=&limit=&offset=&group_ids=&project_ids=&folder_ids=&author_ids=&subgroup_ids=&co_author_ids=&co_author_subgroup_ids=&tag_ids=&favorites=&creation_date_from=2024-01-10&creation_date_to=2024-01-12&modification_date_from=2024-01-14&modification_date_to=2024-01-16&custom_date_ids=&skip_total_count=&siwor_statuses=&sw_statuses=&review_statuses=&include_hidden=false
URI Parameters
- sort
string(optional)Field to sort the results by. When omitted results are sorted by user application settings
Choices:
title-titlecreation_date-creation_datemodification_date-modification_date- omit_empty_title
boolean(optional) Default: falseOmit entries without a title in the result set
- title
string(optional)Partial string to match the entry title
- limit
number(optional) Default: 20Maximum number of projects to return. The maximum for
limitis 50 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned.
Choices:
authorprojectlast_editor- group_ids
string(optional)A comma separated list of group ids that results in returning only entries within the specified group(s)
- project_ids
string(optional)A comma separated list of project ids that results in returning only entries within the specified project(s)
- folder_ids
string(optional)[beta] A comma separated list of folder ids that results in returning only entries residing under the specified folder(s). Please note that this param is in beta and may be subject to change.
- author_ids
string(optional)A comma separated list of author ids that results in returning only entries owned by the specified author(s)
- subgroup_ids
string(optional)[beta] A comma separated list of subgroup ids that results in returning only entries by the author(s) in the specified subgroup(s). This filter is applicable only when a single group id is passed as a parameter. Please note that this param is in beta and may be subject to change.
- co_author_ids
string(optional)[beta] A comma separated list of co-author ids that results in returning only entries contributed by the specified co-author(s). Please note that this param is in beta and may be subject to change.
- co_author_subgroup_ids
string(optional)[beta] A comma separated list of subgroup ids that results in returning only entries contributed by the co-author(s) in the specified subgroup(s). This filter is applicable only when a single group id is passed as a parameter. Please note that this param is in beta and may be subject to change.
- tag_ids
string(optional)A comma separated list of tag ids that results in returning only entries has the specified tag(s)
- favorites
boolean(optional) Default: falseField to return only the entries marked as favorites
- creation_date_from
date(optional) Example: 2024-01-10Field to return only the entries that were created past or at the specified date
- creation_date_to
date(optional) Example: 2024-01-12Field to return only the entries that were created before or at the specified date
- modification_date_from
date(optional) Example: 2024-01-14Field to return only the entries that were edited past or at the specified date
- modification_date_to
date(optional) Example: 2024-01-16Field to return only the entries that were edited before or at the specified date
- custom_date_ids
string(optional)A comma separated list of custom date ids that results in returning only entries has the specified custom date(s)
- skip_total_count
boolean(optional) Default: falseField to skip the calculation of the total number of entries that match the query
- siwor_statuses
string(optional)[beta] A comma separated list of list of statuses to return only the entries with the specified Signature Workflows statuses. Please note that this param is in beta and may be subject to change.
-
NOT_STARTED,
-
UNDER_REVIEW,
-
REVIEW_COMPLETED,
-
REJECTED
-
- review_statuses
string(optional)[beta] A comma separated list of list of statuses to return only the entries with the specified Review statuses. Please note that this param is in beta and may be subject to change.
-
NOT_STARTED,
-
PENDING,
-
APPROVED,
-
CHANGES_REQUESTED
-
- sw_statuses
string(optional)[beta] A comma separated list of list of statuses to return only the entries with the specified Sign and Witness statuses. Please note that this param is in beta and may be subject to change.
-
NOT_SIGNED
-
SIGNED_BY_OWNER
-
WITNESSED
-
- include_hidden
boolean(optional) Default: false Example: false[beta] Flag to include hidden entries
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "DATA"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
]
}
}Get EntryGET/entries/{id}{?expand}
Returns the entry with the given id
Example URI
GET /api/v2/entries/938302?expand=
URI Parameters
- id
string(required) Example: 938302id of the entry
- expand
string(optional)A comma separated list of related domain objects that should be expanded for the item returned.
Choices:
authorprojectlast_editor
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "DATA"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Create EntryPOST/entries
Create a entry
Example URI
POST /api/v2/entries
Request
Create Entry with TitleHeaders
Content-Type: application/jsonBody
{
"project_id": "36272",
"title": "Luke's Private Entry"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
}
},
"required": [
"project_id",
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /entries/10945Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"rows": []
},
"elements": [],
"tags": [],
"custom_dates": [],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"description": "the notebook row/column layout of elements in the entry"
}
},
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Request
Create Entry with TagsHeaders
Content-Type: application/jsonBody
{
"project_id": "36272",
"title": "Luke's Private Entry",
"tags": [
"luke",
"star wars"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "array of strings representing tags"
}
},
"required": [
"project_id",
"title",
"tags"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /entries/10945Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"rows": []
},
"elements": [],
"tags": [
"luke",
"star wars"
],
"custom_dates": [],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"description": "the notebook row/column layout of elements in the entry"
}
},
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Request
Create Entry with Custom DatesHeaders
Content-Type: application/jsonBody
{
"project_id": "36272",
"title": "Luke's Private Entry",
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "array of custom dates"
}
},
"required": [
"project_id",
"title",
"custom_dates"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /entries/10945Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"rows": []
},
"elements": [],
"tags": [],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"description": "the notebook row/column layout of elements in the entry"
}
},
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Request
Create Entry from an Existing Entry or TemplateCreates a new entry in the target project using the notebook entry or template entry identified by the Source-Id header.
Providing the Source-Id header causes all additional fields, other than project_id, to be omitted for the creation.
Note that the target project must exist within the same group as that of the source notebook entry or template entry.
Headers
Content-Type: application/json
Source-Id: 938302Body
{
"project_id": "36272"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "project location of the entry"
}
},
"required": [
"project_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /entries/10945Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"rows": []
},
"elements": [],
"tags": [],
"custom_dates": [],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"description": "the notebook row/column layout of elements in the entry"
}
},
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Update EntryPATCH/entries/{id}
Update an entry’s attributes. The supported operations will grow in time.
This endpoint complies with RFC 6902, the specification for JSON Patch.
Example URI
PATCH /api/v2/entries/938306
URI Parameters
- id
string(required) Example: 938306the unique id of the entry
Request
Change the Project of an EntryNote: the Project must exist in the same workspace as the entry for the operation to be successful.
Headers
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/project_id",
"value": "36272"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/project_id"
],
"description": "JSON Pointer notation to the member named project id"
},
"value": {
"type": "string",
"description": "the id of the project, in which the entry should move"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "DATA"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Request
Change the visibility of an EntryHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/hidden",
"value": false
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/hidden"
],
"description": "JSON Pointer notation to the member named hidden"
},
"value": {
"type": "boolean",
"description": "true to hide the entry, false to make the entry visible"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "938306",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "TEXT"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": true,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Request
Copy Elements into the EntryCopy the specified element to the target entry.
The path is always expected to be /elements/- which is
JSON Pointer notation for “the end of the elements array”.
You may optionally provide the version_id to specify the exact element version.
Otherwise, the most recent version of the element is chosen.
Headers
Content-Type: application/json-patch+jsonBody
[
{
"op": "add",
"path": "/elements/-",
"value": {
"element_id": "b2e30352695154a0b37894241086abdb42060fab",
"version_id": "2309989"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add"
],
"description": "The add operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/elements/-"
],
"description": "JSON Pointer notation to the end of the elements array"
},
"value": {
"type": "object",
"properties": {
"element_id": {
"type": "string",
"description": "The stable pointer to the element"
},
"version_id": {
"type": [
"string",
"null"
],
"description": "The version id specifying the exact version of the element"
}
},
"required": [
"element_id"
],
"description": "identifies a source element to copy"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "938306",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "TEXT"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Request
Copy the Content of Another Template Entry[beta] Copy all of the Elements along with their respective layout
from a Source Template Entry. You may optionally provide
the version_id to specify the exact version of the Source Template Entry.
Otherwise, the most recent version of the Source Template Entry is copied.
07.08.2024: Please note that this request is in beta and may be subject to modification or removal over the next 5 months.
Headers
Content-Type: application/json-patch+jsonBody
[
{
"op": "add",
"path": "/elements/-",
"value": {
"entry_id": "938320",
"version_id": "938320"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"add"
],
"description": "The add operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/elements/-"
],
"description": "JSON Pointer notation to the end of the elements array"
},
"value": {
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The Template Entry identifier, which uniquely identifies a specific Entry"
},
"version_id": {
"type": [
"string",
"null"
],
"description": "The Template Entry version identifier, which specifies an exact version of the Entry"
}
},
"required": [
"entry_id"
],
"description": "identifies the Entry from which to source the Elements and their layout"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "938306",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "TEXT"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Entry Filters ¶
Get Entry FiltersGET/entry-filters{?omit_empty_title,title,group_ids,project_ids,folder_ids,author_ids,tag_ids,favorites,creation_date_from,creation_date_to,modification_date_from,modification_date_to,custom_date_ids,siwor_statuses,sw_statuses}
Retrieve aggregate data about entries matching the provided request parameters. See also List Entries to retrieve the actual entries.
Example URI
GET /api/v2/entry-filters?omit_empty_title=&title=&group_ids=1200,1201&project_ids=36272,36275&folder_ids=36276,36277&author_ids=11038,11039&tag_ids=&favorites=&creation_date_from=2024-01-10&creation_date_to=2024-01-12&modification_date_from=2024-01-14&modification_date_to=2024-01-16&custom_date_ids=3540&siwor_statuses=&sw_statuses=
URI Parameters
- omit_empty_title
boolean(optional) Default: falseRestricts the resulting data to come only from entries having a title
- title
string(optional)Restricts the resulting data to come only from entries having a title that matches the specified value
- group_ids
string(optional) Example: 1200,1201Comma separated list of 1 or more group ids, which restricts the resulting data to come only from entries in the specified group(s)
- project_ids
string(optional) Example: 36272,36275Comma separated list of 1 or more project ids, which restricts the resulting data to come only from entries in the specified project(s)
- folder_ids
string(optional) Example: 36276,36277[beta] Comma separated list of 1 or more folder ids, which restricts the resulting data to come only from entries residing under the specified folder(s). Please note that this param is in beta and may be subject to change.
- author_ids
string(optional) Example: 11038,11039Comma separated list of 1 or more user ids, which restricts the resulting data to come only from entries owned by the specified user(s)
- tag_ids
string(optional)Comma separated list of 1 or more tag ids, which restricts the resulting data to come only from entries having the specified tag(s)
- favorites
boolean(optional) Default: falseRestricts the resulting data to come only from entries having been marked as a favorite
- creation_date_from
date(optional) Example: 2024-01-10Restricts the resulting data to come only from entries having been created on or after the specified date (YYYY-MM-DD)
- creation_date_to
date(optional) Example: 2024-01-12Restricts the resulting data to come only from entries having been created on or before the specified date (YYYY-MM-DD)
- modification_date_from
date(optional) Example: 2024-01-14Restricts the resulting data to come only from entries having been edited on or after the specified date (YYYY-MM-DD)
- modification_date_to
date(optional) Example: 2024-01-16Restricts the resulting data to come only from entries having been edited on or before the specified date (YYYY-MM-DD)
- custom_date_ids
string(optional) Example: 3540Comma separated list of 1 or more custom date ids, which restricts the resulting data to come only from entries having the specified custom date(s)
- siwor_statuses
string(optional)[beta] A comma separated list of statuses to restrict the resulting data to come only from entries with the specified Signature Workflows statuses. Please note that this param is in beta and may be subject to change.
-
NOT_STARTED,
-
UNDER_REVIEW,
-
REVIEW_COMPLETED,
-
REJECTED
-
- sw_statuses
string(optional)[beta] A comma separated list of statuses to restrict the resulting data to come only from entries with the specified Sign and Witness statuses. Please note that this param is in beta and may be subject to change.
-
NOT_SIGNED
-
SIGNED_BY_OWNER
-
WITNESSED
-
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"entries_amount": 12,
"possible_author_ids": [
"12",
"13"
],
"possible_project_ids": [
"12",
"13"
],
"possible_tags": [
"on-going",
"abandoned"
],
"possible_custom_dates": [
{
"id": "1236",
"key": "inception",
"value": "2024-04-23T02:00:00.000+0200"
}
],
"oldest_created_date": "2020-11-19T08:02:39.000+0200",
"newest_created_date": "2024-05-28T10:20:31.000+0200",
"oldest_modified_date": "2020-12-17T10:19:59.000+0200",
"newest_modified_date": "2024-05-25T14:23:58.000+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entries_amount": {
"type": "number",
"description": "the count of entries matching the request criteria"
},
"possible_author_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "the user ids of the owners of the entries matching the request criteria"
},
"possible_project_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "the project ids of the entries matching the request criteria"
},
"possible_tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "the tags of the entries matching the request criteria"
},
"possible_custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string",
"description": "the display name of the date"
},
"value": {
"type": "string",
"description": "the associated date"
}
},
"required": [
"id",
"key",
"value"
]
},
"description": "the custom dates of the entries matching the request criteria"
},
"oldest_created_date": {
"type": [
"string",
"null"
],
"description": "the oldest date an entry was created based on the request criteria"
},
"newest_created_date": {
"type": [
"string",
"null"
],
"description": "the most recent date an entry was created based on the request criteria"
},
"oldest_modified_date": {
"type": [
"string",
"null"
],
"description": "the oldest date an entry was modified based on the request criteria"
},
"newest_modified_date": {
"type": [
"string",
"null"
],
"description": "the most recent date an entry was modified based on the request criteria"
}
},
"required": [
"entries_amount",
"possible_author_ids",
"possible_project_ids",
"possible_tags",
"possible_custom_dates",
"oldest_created_date",
"newest_created_date",
"oldest_modified_date",
"newest_modified_date"
],
"additionalProperties": false
}Get Co-Author FiltersGET/co-author-filters{?group_id,subgroup_id,name,search_by_ids,include_hidden,limit,offset}
[beta] Returns the co-author users and subgroups based on the provided filters.
Example URI
GET /api/v2/co-author-filters?group_id=1200&subgroup_id=36272&name=my subgroup&search_by_ids=11038,11039&include_hidden=false&limit=&offset=
URI Parameters
- group_id
string(required) Example: 1200Id of the group
- subgroup_id
string(optional) Example: 36272Only return users and subgroups who are members of the specified subgroup
- name
string(optional) Example: my subgroupA search string to filter subgroups by name, and users by email, first name or last name
- search_by_ids
string(optional) Example: 11038,11039Only return users and subgroups that match the provided ids
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden items
- limit
number(optional) Default: 20Maximum number of users and subgroups to return. The maximum for
limitis 100 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup": false,
"subgroup_path": [
"100",
"101"
],
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the user or subgroup"
},
"name": {
"type": "string",
"description": "the name of the user or subgroup"
},
"is_subgroup": {
"type": "boolean",
"description": "flag that indicates whether the item is a subgroup or a user"
},
"subgroup_path": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "the list of the nested subgroup ids until the root"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup",
"subgroup_path",
"is_deactivated",
"is_former_member",
"iam_id"
]
}
}Get ChipsGET/chips{?group_id,project_ids,folder_ids,user_ids,subgroup_ids,tag_ids,custom_date_ids}
[beta] Returns the names of all informed IDs
Example URI
GET /api/v2/chips?group_id=1200&project_ids=36272,36275&folder_ids=36276,36277&user_ids=11038,11039&subgroup_ids=200,2001&tag_ids=100,101&custom_date_ids=200,201
URI Parameters
- group_id
string(required) Example: 1200Id of the group
- project_ids
string(optional) Example: 36272,36275Comma separated list of 1 or more project ids
- folder_ids
string(optional) Example: 36276,36277Comma separated list of 1 or more folder ids
- user_ids
string(optional) Example: 11038,11039Comma separated list of 1 or more user ids
- subgroup_ids
string(optional) Example: 200,2001Comma separated list of 1 or more subgroup ids
- tag_ids
string(optional) Example: 100,101Comma separated list of 1 or more tag ids
- custom_date_ids
string(optional) Example: 200,201Comma separated list of 1 or more custom date ids
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"projects": [
{
"id": "36272",
"title": "example title"
}
],
"folders": [
{
"id": "36272",
"title": "example title"
}
],
"users": [
{
"id": "36272",
"title": "example title"
}
],
"subgroups": [
{
"id": "36272",
"title": "example title"
}
],
"tags": [
{
"id": "36272",
"title": "example title"
}
],
"dates": [
{
"id": "36273",
"title": "example title",
"value": "example value"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the chip"
},
"title": {
"type": "string",
"description": "the title of the chip"
}
},
"required": [
"id",
"title"
]
},
"description": "the project ids and titles"
},
"folders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the chip"
},
"title": {
"type": "string",
"description": "the title of the chip"
}
},
"required": [
"id",
"title"
]
},
"description": "the folder ids and titles"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the chip"
},
"title": {
"type": "string",
"description": "the title of the chip"
}
},
"required": [
"id",
"title"
]
},
"description": "the user ids and titles"
},
"subgroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the chip"
},
"title": {
"type": "string",
"description": "the title of the chip"
}
},
"required": [
"id",
"title"
]
},
"description": "the group ids and titles"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the chip"
},
"title": {
"type": "string",
"description": "the title of the chip"
}
},
"required": [
"id",
"title"
]
},
"description": "the tag ids and titles"
},
"dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the chip"
},
"title": {
"type": "string",
"description": "the title of the chip"
},
"value": {
"type": "string",
"description": "the value of the chip"
}
},
"required": [
"id",
"title",
"value"
]
},
"description": "the custom date ids, titles and values"
}
},
"required": [
"projects",
"folders",
"users",
"subgroups",
"tags",
"dates"
],
"additionalProperties": false
}Get Owner FiltersGET/owner-filters{?group_id,subgroup_id,name,search_by_ids,entry_folder_ids,entry_project_ids,entry_tag_ids,include_hidden,limit,offset}
[beta] Returns the users and subgroups based on the provided filters.
Example URI
GET /api/v2/owner-filters?group_id=1200&subgroup_id=36272&name=my subgroup&search_by_ids=11038,11039&entry_folder_ids=100,101&entry_project_ids=200,201&entry_tag_ids=300,301&include_hidden=false&limit=&offset=
URI Parameters
- group_id
string(required) Example: 1200Id of the group
- subgroup_id
string(optional) Example: 36272Only return users and subgroups who are members of the specified subgroup
- name
string(optional) Example: my subgroupA search string to filter subgroups by name, and users by email, first name or last name
- search_by_ids
string(optional) Example: 11038,11039Only return users and subgroups that match the provided ids
- entry_folder_ids
string(optional) Example: 100,101Only return users that has an Entry in the provided folders
- entry_project_ids
string(optional) Example: 200,201Only return users that has an Entry in the provided projects
- entry_tag_ids
string(optional) Example: 300,301Only return users that has an Entry that has the provided tags
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden items
- limit
number(optional) Default: 20Maximum number of users and subgroups to return. The maximum for
limitis 100 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup": false,
"subgroup_path": [
"100",
"101"
],
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the user or subgroup"
},
"name": {
"type": "string",
"description": "the name of the user or subgroup"
},
"is_subgroup": {
"type": "boolean",
"description": "flag that indicates whether the item is a subgroup or a user"
},
"subgroup_path": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "the list of the nested subgroup ids until the root"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup",
"subgroup_path",
"is_deactivated",
"is_former_member",
"iam_id"
]
}
}Get Tag FiltersGET/tag-filters{?group_id,type,entry_folder_ids,entry_project_ids,entry_owner_ids,entry_subgroup_ids,include_hidden}
[beta] Returns the tags and the custom dates based on the provided filters. In order to see a tag, it must be present on an entry which you can access.
Example URI
GET /api/v2/tag-filters?group_id=1200&type=&entry_folder_ids=100,101&entry_project_ids=200,201&entry_owner_ids=300,301&entry_subgroup_ids=400,401&include_hidden=false
URI Parameters
- group_id
string(required) Example: 1200Id of the group
- type
string(optional)Restricts the returned values to that of the desired type
Choices:
TAGCUSTOM_DATE- entry_folder_ids
string(optional) Example: 100,101Only return tags that are used in the Entries in the provided folders
- entry_project_ids
string(optional) Example: 200,201Only return tags that are used in the Entries in the provided projects
- entry_owner_ids
string(optional) Example: 300,301Only return tags that are used in the Entries owned by the provided users
- entry_subgroup_ids
string(optional) Example: 400,401Only return tags that are used in the Entries owned by the users in the provided subgroups
- include_hidden
boolean(optional) Default: false Example: falseFlag to include hidden projects and folders
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"tags": [
{
"id": "36272",
"key": "example tag"
}
],
"dates": [
{
"id": "36273",
"key": "example custom date",
"value": "2024-09-10T02:00:00.000+0200"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the tag"
},
"key": {
"type": "string",
"description": "the display name of the tag"
}
},
"required": [
"id",
"key"
]
},
"description": "the tag ids and keys"
},
"dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the custom date"
},
"key": {
"type": "string",
"description": "the display name of the date"
},
"value": {
"type": "string",
"description": "the associated date"
}
},
"required": [
"id",
"key",
"value"
]
},
"description": "the custom date ids, keys and values"
}
},
"required": [
"tags",
"dates"
],
"additionalProperties": false
}Entry versions ¶
Get Entry versionGET/entries/{id}/versions/{versionId}{?expand}
This endpoint returns the version of the specified entry.
Example URI
GET /api/v2/entries/938302/versions/938302?expand=
URI Parameters
- id
string(required) Example: 938302id of the entry
- versionId
string(required) Example: 938302id of the version
- expand
string(optional)A comma separated list of related domain objects that should be expanded for the item returned.
Choices:
authorprojectlast_editor
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "2309878",
"version_id": "5309878",
"author_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"element_layout": {
"grid_layout": true,
"rows": [
{
"cells": [
{
"element_version_id": "2309983",
"width": 60,
"height": 40,
"top": 0,
"left": 0
}
]
}
]
},
"elements": [
{
"id": "e79cfbb5d2cb5a39b7a821a3ae0476e6605adcc2",
"version_id": "2309983",
"type": "DATA"
}
],
"tags": [
"luke",
"star wars"
],
"custom_dates": [
{
"name": "validation date",
"value": "2017-12-25"
}
],
"project_id": "36272",
"title": "Luke's Private Entry",
"entry_number": 1,
"hidden": false,
"editable": true,
"last_editor_id": "11038",
"author": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
},
"review_state": {
"possible_actions": [
"SIGN"
],
"signee": {
"id": "11038",
"name": "Luke Skywalker",
"is_subgroup_admin": false,
"is_group_admin": false,
"is_deactivated": false,
"is_former_member": false,
"iam_id": "4806a4c8-3da9-480e-bfe5-0e79574686a1"
},
"intention_label": "Signed by",
"status": "NOT_STARTED"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the most current version `blockId`"
},
"version_id": {
"type": "string",
"description": "the unique id of the entry"
},
"author_id": {
"type": "string",
"description": "the unique id of the user created the entry"
},
"creation_date": {
"type": "string",
"description": "date when the entry was created"
},
"version_date": {
"type": "string",
"description": "date when this entry was last modified"
},
"element_layout": {
"type": "object",
"properties": {
"grid_layout": {
"type": "boolean",
"description": "indicates if the row is a grid layout or not"
},
"rows": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"cells": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"element_version_id": {
"type": "string",
"description": "The version id of this element"
},
"width": {
"type": "number",
"description": "The number of cells this element spans horizontally, can be 1 to 12"
},
"height": {
"type": "number",
"description": "The number of cells this element spans vertically, can be 1 minimum"
},
"top": {
"type": "number",
"description": "The top vertical position of the cell, can be 0 minimum"
},
"left": {
"type": "number",
"description": "The left horizontal position of the cell, can be 0 to 11"
}
},
"required": [
"element_version_id",
"width",
"height",
"top",
"left"
]
}
}
},
"required": [
"cells"
]
},
"description": "the notebook row/column layout of elements in the entry"
}
},
"required": [
"grid_layout",
"rows"
],
"description": "The layout of the elements in this entry"
},
"elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The stable id of the element"
},
"version_id": {
"type": "string",
"description": "The version id of this element"
},
"type": {
"type": "string",
"enum": [
"DATA",
"FILE",
"IMAGE",
"TABLE",
"TEXT",
"WELL_PLATE",
"CHEMICAL_STRUCTURE"
],
"description": "The type of the element"
}
},
"required": [
"id",
"version_id",
"type"
]
},
"description": "The elements in this entry"
},
"tags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "The tags for this entry. Tags are case insensitive."
},
"custom_dates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the custom date. Names are case insensitive."
},
"value": {
"type": "string",
"description": "The value of this custom date"
}
},
"required": [
"name",
"value"
]
},
"description": "Custom dates for this entry"
},
"project_id": {
"type": "string",
"description": "project location of the entry"
},
"title": {
"type": "string",
"description": "the display name of the entry"
},
"entry_number": {
"type": "number",
"description": "position of the entry inside the project"
},
"hidden": {
"type": "boolean",
"description": "indicates if the entry is hidden or visible"
},
"editable": {
"type": "boolean",
"description": "Indicates if the requesting user has write access to the entry. An entry is editable if the user is the entry author while the entry is neither signed nor hidden."
},
"last_editor_id": {
"type": "string",
"description": "the unique id of the last user who made a modification to the entry"
},
"author": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
],
"additionalProperties": false,
"description": "the user who created the entry"
},
"review_state": {
"type": [
"object",
"null"
],
"properties": {
"possible_actions": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SIGN",
"REQUEST_CHANGES",
"REVOKE_SIGNATURES",
"DETAIL"
]
},
"description": "possible actions for the current user"
},
"signee": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "the id of the user"
},
"name": {
"type": "string",
"description": "the name of the user"
},
"is_subgroup_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a subgroup admin"
},
"is_group_admin": {
"type": "boolean",
"description": "flag that indicates whether the user is a group admin"
},
"is_deactivated": {
"type": "boolean",
"description": "flag that indicates whether the user's account is deactivated"
},
"is_former_member": {
"type": "boolean",
"description": "flag that indicates whether the user is a former member"
},
"iam_id": {
"type": "string",
"description": "the IAM id of the user"
}
},
"required": [
"id",
"name",
"is_subgroup_admin",
"is_group_admin",
"is_deactivated",
"is_former_member",
"iam_id"
],
"additionalProperties": false,
"description": "the requested signee or the one who did the final approval"
},
"intention_label": {
"type": [
"string",
"null"
],
"description": "signature intention"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"APPROVED",
"PENDING",
"CHANGES_REQUESTED"
],
"description": "the execution status of the review workflow"
}
},
"required": [
"possible_actions",
"signee",
"intention_label",
"status"
],
"additionalProperties": false,
"description": "the state of the current review workflow for an entry. `null` when not available for the endpoint."
}
},
"required": [
"id",
"version_id",
"author_id",
"creation_date",
"version_date",
"element_layout",
"elements",
"tags",
"custom_dates",
"project_id",
"title",
"entry_number",
"hidden",
"editable",
"last_editor_id",
"review_state"
],
"additionalProperties": false
}Entry views ¶
Update Entry ViewsPATCH/entries/{id}/views
Record that an entry has been viewed by the user initiating the request
Example URI
PATCH /api/v2/entries/938306/views
URI Parameters
- id
string(required) Example: 938306the unique id of the entry
Response
204Entry editors ¶
List Entry editorsGET/entries/{id}/editors
This endpoint returns the editors of the specified entry. In the context of multiple entry collaborators, an entry might be edited by any user who has editing rights. To list all users who made changes to an entry, use this endpoint.
Example URI
GET /api/v2/entries/222222/editors
URI Parameters
- id
string(required) Example: 222222the id of the entry
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
]
}
}Favorite Entries ¶
Get Favorite EntryGET/favorite-entries/{entry_id}
Returns the favorite entry metadata with the given entry id
Example URI
GET /api/v2/favorite-entries/938302
URI Parameters
- entry_id
string(required) Example: 938302id of the entry
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"entry_id": "938311",
"project_id": "36272",
"user_id": "11038",
"create_timestamp": "2022-11-07T16:32:12.729+0200",
"last_edit_timestamp": "2022-11-07T16:32:12.729+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry"
},
"project_id": {
"type": "string",
"description": "id of the project"
},
"user_id": {
"type": "string",
"description": "id of the favorite owner"
},
"create_timestamp": {
"type": "string",
"description": "timestamp of the creation"
},
"last_edit_timestamp": {
"type": "string",
"description": "timestamp of last edition"
}
},
"required": [
"entry_id",
"project_id",
"user_id",
"create_timestamp",
"last_edit_timestamp"
],
"additionalProperties": false
}Create FavoritePOST/favorite-entries
Mark an entry as favorite
Example URI
POST /api/v2/favorite-entries
Request
Create FavoriteHeaders
Content-Type: application/jsonBody
{
"entry_id": "938311",
"project_id": "36272"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry"
},
"project_id": {
"type": "string",
"description": "id of the project"
}
},
"required": [
"entry_id",
"project_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8Body
{
"entry_id": "938311",
"project_id": "36272",
"user_id": "11038",
"create_timestamp": "2022-11-07T16:32:12.729+0200",
"last_edit_timestamp": "2022-11-07T16:32:12.729+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry"
},
"project_id": {
"type": "string",
"description": "id of the project"
},
"user_id": {
"type": "string",
"description": "id of the favorite owner"
},
"create_timestamp": {
"type": "string",
"description": "timestamp of the creation"
},
"last_edit_timestamp": {
"type": "string",
"description": "timestamp of last edition"
}
},
"required": [
"entry_id",
"project_id",
"user_id",
"create_timestamp",
"last_edit_timestamp"
],
"additionalProperties": false
}Delete FavoriteDELETE/favorite-entries/{entry_id}
Removes an entry as favorite
Example URI
DELETE /api/v2/favorite-entries/938311
URI Parameters
- entry_id
string(required) Example: 938311id of the entry
Response
204Entry Comments ¶
Get Entry CommentsGET/entries/{id}/comments{?expand}
Get comments associated with the given entry id
Example URI
GET /api/v2/entries/938302/comments?expand=threads,user
URI Parameters
- id
string(required) Example: 938302the id of the entry
- expand
string(optional) Example: threads,userA comma separated list of related domain objects that should be expanded for all items returned. Note that you must provide both
threadsanduserto expand on the user who made the comment.
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"entry_id": "938302",
"project_id": "36277",
"count_of_comments": 2,
"thread_ids": [
"1314",
"1317"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry to which the comments belong"
},
"project_id": {
"type": "string",
"description": "id of the project to which the entry belongs"
},
"count_of_comments": {
"type": "number",
"description": "the number of comments on the entry, which include any replies to a comment thread"
},
"thread_ids": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "the thread ids of each comment thread on the entry, note that this field is expandable to the actual comment thread using the expand=threads request parameter"
}
},
"required": [
"entry_id",
"project_id",
"count_of_comments"
]
}Entry Sign and Witness ¶
Get Sign and WitnessGET/entries/{id}/sign-and-witness{?expand}
This endpoint returns the sign and witness information of the specified entry.
Example URI
GET /api/v2/entries/938302/sign-and-witness?expand=
URI Parameters
- id
string(required) Example: 938302id of the entry
- expand
string(optional)A comma separated list of related domain objects that should be expanded for the item returned.
Choices:
witness_user
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"entry_id": "938302",
"sign_hash": "5309878",
"sign_hash_version": 1,
"sign_hash_description": "SHA-256",
"sign_date": "2017-02-10T12:34:56.789+0200",
"sign_biometrics_doc_id": 1,
"witness_request_date": "2017-02-10T12:34:56.789+0200",
"witness_date": "2017-02-10T12:34:56.789+0200",
"witness_user_id": "11038",
"witness_biometrics_doc_id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the id of the entry"
},
"sign_hash": {
"type": [
"string",
"null"
],
"description": "the hash of the signature"
},
"sign_hash_version": {
"type": [
"number",
"null"
],
"description": "the version of the hash calculation"
},
"sign_hash_description": {
"type": [
"string",
"null"
],
"description": "the description of the hash version"
},
"sign_date": {
"type": [
"string",
"null"
],
"description": "the date when the entry was signed"
},
"sign_biometrics_doc_id": {
"type": [
"number",
"null"
],
"description": "the document id of the signature biometrics"
},
"witness_request_date": {
"type": [
"string",
"null"
],
"description": "date when the witness request was made"
},
"witness_date": {
"type": [
"string",
"null"
],
"description": "the date when the entry was witnessed"
},
"witness_user_id": {
"type": [
"string",
"null"
],
"description": "the id of the user who witnessed the entry"
},
"witness_biometrics_doc_id": {
"type": [
"number",
"null"
],
"description": "the document id of the witness biometrics"
}
},
"required": [
"entry_id"
]
}Entry Elements ¶
An Entry Element is a single element inside a notebook entry. An entry can consist of multiple elements laid out in a grid. Each element type serves a different purpose; the possible types are: TEXT, FILE (for upload files), IMAGE (for images), TABLE, WELL_PLATE, and DATA.
Element for each type can be managed through different endpoints which are described in detail in the following sections. You need to create an entry first before you can add elements to it.
All operations on elements are automatically versioned through the containing entry. A new entry version will be created for each added, edited or removed element.
The following operations are available for elements:
File Elements ¶
Files can be added to notebook entries through the use of File Elements.
Currently it is possible to upload all kinds of file types. Known types will trigger front end functionality (e.g. Extract…).
Here are the supported types for frontend functionality:
Images
-
PNG/X-PNG (image/png, image/x-png)
-
JPG/JPEG/PJPG/PJPEG (image/jpg, image/jpeg, image/pjpg, image/pjpeg)
-
GIF (image/gif)
-
BMP (image/bmp)
-
TIFF (image/tiff)
Spreadsheets
- MS Office Excel (application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet)
Texts
-
MS Office Word (application/msword)
-
CSV (text/csv)
Create File ElementPOST/elements/file{?entry_id,file_name,locked}
Create a file element for the provided notebook entry.
Example URI
POST /api/v2/elements/file?entry_id=938302&file_name=&locked=true
URI Parameters
- entry_id
string(required) Example: 938302id of the entry to add the file element to.
- file_name
string(optional)the name of the file
- locked
boolean(optional) Example: trueindicates whether this element should be locked upon creation
Request
Create File Element With ContentSend the raw binary content of the file as the request body using the appropriate (matching) Content-Type header.
Example Parameters:
-
entry_id=938302 -
file_name=results.docx
Headers
Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.documentBody
... file content as binary ...Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/file/67f7eb4dc5755c25a1555d2d5ecfd389406b3791Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "FILE",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"FILE"
],
"description": "Denotes that this is a file element. The value is always `FILE`"
},
"file_name": {
"type": [
"string",
"null"
],
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": [
"string",
"null"
],
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"file_name",
"file_size",
"content_type"
],
"additionalProperties": false
}Request
Create Empty File ElementSend a request without any Body content to create an empty file element that is suitable for later file drop.
Example Parameters:
entry_id=938302
Body
<empty>Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/file/67f7eb4dc5755c25a1555d2d5ecfd389406b3791Body
{
"id": "d2a810a5ef7b67befd7af503c2fb6ecc7c50a235",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "FILE",
"file_name": "null",
"file_size": 0,
"content_type": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"FILE"
],
"description": "Denotes that this is a file element. The value is always `FILE`"
},
"file_name": {
"type": [
"string",
"null"
],
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": [
"string",
"null"
],
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"file_name",
"file_size",
"content_type"
],
"additionalProperties": false
}Get File ElementGET/elements/file/{id}
Returns the latest version of the file element
Example URI
GET /api/v2/elements/file/67f7eb4dc5755c25a1555d2d5ecfd389406b3791
URI Parameters
- id
string(required) Example: 67f7eb4dc5755c25a1555d2d5ecfd389406b3791stable id of file element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "FILE",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"FILE"
],
"description": "Denotes that this is a file element. The value is always `FILE`"
},
"file_name": {
"type": [
"string",
"null"
],
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": [
"string",
"null"
],
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"file_name",
"file_size",
"content_type"
],
"additionalProperties": false
}Get File Element VersionGET/elements/file/{id}/version/{versionId}
Returns the specified version of the file element
Example URI
GET /api/v2/elements/file/67f7eb4dc5755c25a1555d2d5ecfd389406b3791/version/2309991
URI Parameters
- id
string(required) Example: 67f7eb4dc5755c25a1555d2d5ecfd389406b3791stable id of file element
- versionId
string(required) Example: 2309991element version id of the file element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "FILE",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"FILE"
],
"description": "Denotes that this is a file element. The value is always `FILE`"
},
"file_name": {
"type": [
"string",
"null"
],
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": [
"string",
"null"
],
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"file_name",
"file_size",
"content_type"
],
"additionalProperties": false
}Download FileGET/elements/file/{id}/download
Access the file stored in the current version of the file element. If a file exists, the Content-Type header will match that of the file being accessed. If the file element is empty, no content will be returned.
Example URI
GET /api/v2/elements/file/67f7eb4dc5755c25a1555d2d5ecfd389406b3791/download
URI Parameters
- id
string(required) Example: 67f7eb4dc5755c25a1555d2d5ecfd389406b3791stable id of file element
Response
200Headers
Content-Type: text/x-web-markdown
Content-Disposition: attachment;filename="my_file.md"
Content-Length: 76586Body
... file content as binary ...Preview FileGET/elements/file/{id}/preview
Download a converted file for preview purposes. Currently supported file preview conversions:
DOCX → PDF
Example URI
GET /api/v2/elements/file/67f7eb4dc5755c25a1555d2d5ecfd389406b3791/preview
URI Parameters
- id
string(required) Example: 67f7eb4dc5755c25a1555d2d5ecfd389406b3791stable id of file element
Response
200Headers
Content-Type: application/pdf
Content-Disposition: attachment;filename="my_file.pdf"
Content-Length: 12045Body
... file content as binary ...Update File ElementPUT/elements/file/{id}{?file_name}
Update an empty file element by uploading file content to it.
Example URI
PUT /api/v2/elements/file/fd2e6c898bc8e0c56e6f9b3d9daf21a8a18679fd?file_name=results.docx
URI Parameters
- id
string(required) Example: fd2e6c898bc8e0c56e6f9b3d9daf21a8a18679fdstable id of file element
- file_name
string(required) Example: results.docxthe name of the file
Request
Update File Element With ContentSend the raw binary content of the file as the request body using the appropriate (matching) Content-Type header.
Headers
Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.documentBody
... file content as binary ...Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "FILE",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"FILE"
],
"description": "Denotes that this is a file element. The value is always `FILE`"
},
"file_name": {
"type": [
"string",
"null"
],
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": [
"string",
"null"
],
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"file_name",
"file_size",
"content_type"
],
"additionalProperties": false
}Image Elements ¶
Get Image ElementGET/elements/image/{id}
Returns the latest version of the image element
Example URI
GET /api/v2/elements/image/6887fc96df88c43788f17a7e0f0674aa371b396f
URI Parameters
- id
string(required) Example: 6887fc96df88c43788f17a7e0f0674aa371b396fstable id of image element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "715355e9c69a9e41d61a67104bd50cfc8e697289",
"entry_id": "938302",
"version_id": "2358984",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "IMAGE",
"title": "blank_test.png",
"file_size": 1234,
"preview_height": 600,
"preview_width": 800,
"preview_zoom": 50,
"original_file_content_type": "image/jpeg",
"annotation_layer_svg": "<svg><line x1=\"0\" y1=\"0\" x2=\"200\" y2=\"200\" style=\"stroke:rgb(255,0,0)\"></line></svg>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"IMAGE"
],
"description": "denotes that this is an image element. The value is always `IMAGE`"
},
"title": {
"type": "string",
"description": "the title of the image element"
},
"file_size": {
"type": "number",
"description": "the size of the image file in bytes"
},
"preview_height": {
"type": "number",
"description": "height of the downscaled image version, in px"
},
"preview_width": {
"type": "number",
"description": "width of the downscaled image version, in px"
},
"preview_zoom": {
"type": "number",
"description": "image zoom in the ELN UI, in percentage"
},
"original_file_content_type": {
"type": "string",
"description": "the content type of the original uploaded image file"
},
"annotation_layer_svg": {
"type": [
"string",
"null"
],
"description": "The vector graphic used for the image annotation layer, defined in SVG format"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"file_size",
"preview_height",
"preview_width",
"preview_zoom",
"original_file_content_type"
],
"additionalProperties": false
}Get Image Element VersionGET/elements/image/{id}/version/{versionId}
Returns the specified version of the image element
Example URI
GET /api/v2/elements/image/6887fc96df88c43788f17a7e0f0674aa371b396f/version/2309998
URI Parameters
- id
string(required) Example: 6887fc96df88c43788f17a7e0f0674aa371b396fstable id of image element
- versionId
string(required) Example: 2309998element version id of the image element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "715355e9c69a9e41d61a67104bd50cfc8e697289",
"entry_id": "938302",
"version_id": "2358984",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "IMAGE",
"title": "blank_test.png",
"file_size": 1234,
"preview_height": 600,
"preview_width": 800,
"preview_zoom": 50,
"original_file_content_type": "image/jpeg",
"annotation_layer_svg": "<svg><line x1=\"0\" y1=\"0\" x2=\"200\" y2=\"200\" style=\"stroke:rgb(255,0,0)\"></line></svg>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"IMAGE"
],
"description": "denotes that this is an image element. The value is always `IMAGE`"
},
"title": {
"type": "string",
"description": "the title of the image element"
},
"file_size": {
"type": "number",
"description": "the size of the image file in bytes"
},
"preview_height": {
"type": "number",
"description": "height of the downscaled image version, in px"
},
"preview_width": {
"type": "number",
"description": "width of the downscaled image version, in px"
},
"preview_zoom": {
"type": "number",
"description": "image zoom in the ELN UI, in percentage"
},
"original_file_content_type": {
"type": "string",
"description": "the content type of the original uploaded image file"
},
"annotation_layer_svg": {
"type": [
"string",
"null"
],
"description": "The vector graphic used for the image annotation layer, defined in SVG format"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"file_size",
"preview_height",
"preview_width",
"preview_zoom",
"original_file_content_type"
],
"additionalProperties": false
}Download Image Element Original FileGET/elements/image/{id}/original-data
Returns the original image file
Example URI
GET /api/v2/elements/image/6887fc96df88c43788f17a7e0f0674aa371b396f/original-data
URI Parameters
- id
string(required) Example: 6887fc96df88c43788f17a7e0f0674aa371b396fstable id of image element
Response
200Headers
Content-Type: image/png
Content-Disposition: attachment; filename="my_image.png"Body
... file content as binary ...Download Image Element Preview FileGET/elements/image/{id}/preview-data
Returns the preview image file, which is a downscale version of the original uploaded image file
Example URI
GET /api/v2/elements/image/6887fc96df88c43788f17a7e0f0674aa371b396f/preview-data
URI Parameters
- id
string(required) Example: 6887fc96df88c43788f17a7e0f0674aa371b396fstable id of image element
Response
200Headers
Content-Type: image/png
Content-Disposition: attachment; filename="my_image_preview.png"Body
... file content as binary ...Update Image ElementPUT/elements/image/{id}
Update an image element.
Example URI
PUT /api/v2/elements/image/6887fc96df88c43788f17a7e0f0674aa371b396f
URI Parameters
- id
string(required) Example: 6887fc96df88c43788f17a7e0f0674aa371b396fstable id of image element
Request
Update Image ElementHeaders
Content-Type: application/jsonBody
{
"id": "6887fc96df88c43788f17a7e0f0674aa371b396f",
"annotation_layer_svg": "<svg version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" width=\"800\" height=\"693\"><g></g></svg>",
"title": "imageTitle"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the image element"
},
"annotation_layer_svg": {
"type": "string",
"description": "the svg to use as annotation for the image"
},
"title": {
"type": "string",
"description": "the title of the image element"
}
},
"required": [
"id",
"annotation_layer_svg",
"title"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "715355e9c69a9e41d61a67104bd50cfc8e697289",
"entry_id": "938302",
"version_id": "2358984",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "IMAGE",
"title": "blank_test.png",
"file_size": 1234,
"preview_height": 600,
"preview_width": 800,
"preview_zoom": 50,
"original_file_content_type": "image/jpeg",
"annotation_layer_svg": "<svg><line x1=\"0\" y1=\"0\" x2=\"200\" y2=\"200\" style=\"stroke:rgb(255,0,0)\"></line></svg>"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"IMAGE"
],
"description": "denotes that this is an image element. The value is always `IMAGE`"
},
"title": {
"type": "string",
"description": "the title of the image element"
},
"file_size": {
"type": "number",
"description": "the size of the image file in bytes"
},
"preview_height": {
"type": "number",
"description": "height of the downscaled image version, in px"
},
"preview_width": {
"type": "number",
"description": "width of the downscaled image version, in px"
},
"preview_zoom": {
"type": "number",
"description": "image zoom in the ELN UI, in percentage"
},
"original_file_content_type": {
"type": "string",
"description": "the content type of the original uploaded image file"
},
"annotation_layer_svg": {
"type": [
"string",
"null"
],
"description": "The vector graphic used for the image annotation layer, defined in SVG format"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"file_size",
"preview_height",
"preview_width",
"preview_zoom",
"original_file_content_type"
],
"additionalProperties": false
}Data Elements ¶
Structured data can be added to notebook entries through the use of Data Elements.
There are three types of data elements: Individual Elements, Groups, and Material Elements.
Individual Elements
Individual elements are single measurements or observations which can contain <title> <value> <unit> <physical_quantity_id>.
NaCL 300 mg 3
<title> <value> <unit> <physical_quantity_id>as JSON:
{
'title': 'NaCL',
'value': '300',
'unit': 'mg',
'physical_quantity_id': '3',
'type': 'SINGLE_DATA_ELEMENT'
}When creating a data element it is not always necessary to provide a value for all possible fields. You can omit the
value when creating a placeholder to fill out later (when creating within a template entry).
NaCl mg 3
<title> <value> <physical_quantity_id>as JSON:
{
'title': 'NaCL',
'unit': 'mg',
'physical_quantity_id': '3',
'type': 'SINGLE_DATA_ELEMENT'
}You can also omit the unit when providing dimensionless data.
Success true
<title> <value>as JSON:
{
'title': 'Success',
'value': 'true',
'type': 'SINGLE_DATA_ELEMENT'
}Supported Physical Quantities and Units
The physical_quantity_id for each available physical quantity can be read from the value in parentheses.
All available units for each physical quantity are shown in the subsequent list.
-
Absolute Dose (
82)- Gy
-
Acceleration (
17)- m/s^2
-
Amount of substance / Mass (
92)- mmol/g
-
Amount of substance / Time (
93)- pmol/min
- µmol/min
- mol/s
-
Amount of substance / Volume (
94)- mol/mL
- mol/L
- mol/m^3
-
Amount of substance (
5)- pmol
- nmol
- µmol
- mmol
- mol
- kmol
- Mmol
-
Angular Acceleration (
18)- rad/s^2
-
Angular Momentum (
19)- kg/m^2 s^-1
-
Angular Speed (
20)- rad/s
-
Atomic Mass (
21)- kDa
- Da
- u
-
Capacitance (
22)- µF
- F
-
Centrifugation (
16)- rpm
- G-force
-
Chemical Potential (
23)- J/mol
-
Counts (
77)- particles
- copies
- cells
-
Density (
24)- kg/m^3
- lb/gal
-
Diameter (
25)- nm
- µm
- mm
- cm
- m
-
Dilution (
79)- 1:x
- x:1
-
Dose Rate (
83)- Gy/s
-
Dynamic Viscosity (
90)- CP
-
Electric Charge (
26)- C
-
Electric Charge Density (
27)- C/m^3
-
Electric Conductance (
28)- S
-
Electric Displacement (
30)- C/m^2
-
Electric Field Strength (
31)- V/m
-
Electric Flux (
32)- C
-
Electrical Conductivity (
9)- S/m
- S/cm
- µS/cm
-
Electrical Current (
29)- pA
- nA
- µA
- mA
- cA
- dA
- A
- kA
-
Electrical Potential (
33)- mV
- V
- kV
-
Electrical Resistance (
34)- ohm
-
Electrical Resistivity (
35)- ohm m
-
Electron mobility (
12)- cm^2 V^-1 s^-1
-
Energy (
36)- eV
- keV
- MeV
- cal
- kcal
- nJ
- µJ
- mJ
- J
- kJ
- MJ
-
Energy Density (
37)- J/m^3
-
Enthalpy (
10)- J/mol
- kJ/mol
- cal/mol
-
Entropy (
38)- J K^-1 kg^-1
- J K^-1 mol^-1
-
Enzyme Activity (
72)- U/µg
- U/mg
- U/µL
- U/mL
-
Exposure (X and gamma rays) (
39)- C/kg
-
Flow Cytometry (
76)- % of total
- % of parent
- events
-
Flow Rate (
80)- nL/s
- m^3/s
- nL/min
- µL/min
- mL/min
- sccm
-
Force (
40)- N
- µN
-
Frequency (
41)- Hz
- kHz
- MHz
-
Fugacity (
42)- Pa
-
Heat (
43)- J
-
Heat Capacity (
44)- J/K
-
Illuminance (
45)- lx
- cd sr m^-2
- phot
-
Kinematic Viscosity (
91)- cSt
- mSt
- µSt
- nSt
-
Kinetics (
95)- M/s
- s^-1
-
Length (
1)- pm
- nm
- µm
- mm
- cm
- m
- inch
- yd
- ft
- Å
-
Luminous Flux (
46)- lm
-
Luminous Intensity (
47)- cd
-
Magnetic Dipole Moment (
48)- Wb m
-
Magnetic Field Strength (
49)- A/m
-
Magnetic Flux (
50)- V s
- Wb
-
Magnetic Flux Density (
51)- T
- Wb/m^2
-
Magnetic Moment (
52)- A m^2
- Wb/m^2
-
Magnetic Polarization (
53)- T
- Wb/m^2
-
Magnetic Potential Difference (
54)- A
-
Magnetization (Mass) (
55)- A m^2/kg
- Wb m/kg
-
Magnetization (Volume) (
56)- A/m
-
Mass (
3)- pg
- ng
- µg
- mg
- g
- kg
- lb
- oz
-
Mass concentration (
7)- %
- pg/µL
- ng/µl
- µg/µL
- pg/mL
- ng/mL
- µg/mL
- mg/mL
- g/mL
- µg/L
- mg/L
- g/L
- µg/g
- mg/kg
-
Mass of Entity (
57)- kg
-
Material/Packaging (
78)- pack
- case
- each
- count
- units
-
Molar Volume (
58)- m^3/mol
-
Molar concentration (
8)- %
- yM
- zM
- aM
- fM
- pM
- nM
- µM
- mM
- M
-
Molar mass (
13)- g/mol
-
Percent (
81)- %
- percentile
-
Permeability (
60)- H/m
- Wb/A m
-
Permittivity (
59)- F/m
-
Pixel (
87)- px
-
Power (
61)- W
-
Pressure (
14)- atm
- bar
- nPa
- µPa
- mPa
- Pa
- kPa
- mTorr
- Torr
- at
- psi
- ksi
-
Radioactivity (
74)- Bq
- kBq
- MBq
- GBq
- µCi
- mCi
- Ci
- cps
- cpm
-
Solubility (
62)- mol/m^3
-
Speed (
63)- Å/s
- µm/s
- m/s
- mm/min
-
Speed of Light (Medium) (
65)- m/s
-
Speed of Light (Vacuum) (
64)- m/s
-
Susceptibility (Mass) (
66)- m^3/kg
- H m^2/kg
-
Susceptibility (Volume) (
67)- H/m
- Wb/A m
-
Tear Strength (
88)- kgf/cm
- kN/m
- ppi
-
Temperature (
4)- °C
- °F
- K
-
Temperature Ramp Rate (
71)- °C/s
- °C/min
- °C/h
- K/min
- K/h
-
Tensile Strength (
89)- PSI
-
Thermal capacity (
11)- J/K
- kg m^2/K s^2
-
Thickness (
84)- cm
- mm
- µm
- nm
-
Time (
2)- sec
- msec
- minute(s)
- hour(s)
- day(s)
- month(s)
- year(s)
-
Titer (
75)- PFU/mL
- PFU/µL
- TCID50/mL
- TCID50/µL
- copies/mL
- copies/µL
- IU/mL
- IU/µL
- LPs/mL
- LPs/µL
- cells/mL
- cells/µL
- cells/m^2
- cells/cm^2
-
Torque (
68)- N m
-
Velocity (
96)- mm/s
- cm/s
- m/s
-
Volume (
6)- nL
- µL
- mL
- cl
- dl
- L
- mm^3
- cm^3
- m^3
-
Volume concentration (
73)- % v/v
- % w/v
- % w/w
-
Wave Number (
85)- cm-1
-
Wavelength (
86)- mm
- µm
- nm
-
Weight (
69)- N
-
Work (
70)- J
Data Element Groups
Data Element Groups are used to create structure around other data elements. Groups only have a <title>.
Additional elements can be associated with the group using the children property
<title>
Solution XYZas JSON (a Data Element Group without children):
{
'title': 'Solution ABC',
'type': 'DATA_ELEMENT_GROUP'
}or (a Data Element Group with children)
{
'title': 'Solution DEF',
'type': 'DATA_ELEMENT_GROUP',
'children': [
{
'title': 'NaCL',
'value': '300',
'unit': 'mg',
'physical_quantity_id': '3',
'type': 'SINGLE_DATA_ELEMENT'
},
{
'title': 'Water',
'value': '1000',
'unit': 'mL',
'physical_quantity_id': '6',
'type': 'SINGLE_DATA_ELEMENT'
}
]
}Get Data ElementGET/elements/data/{id}
Returns the latest version of the data element container
Example URI
GET /api/v2/elements/data/b2e30352695154a0b37894241086abdb42060fab
URI Parameters
- id
string(required) Example: b2e30352695154a0b37894241086abdb42060fabstable id of data element container
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "b2e30352695154a0b37894241086abdb42060fab",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Get Data Element VersionGET/elements/data/{id}/version/{versionId}
Returns the data element in the specified version
Example URI
GET /api/v2/elements/data/b2e30352695154a0b37894241086abdb42060fab/version/2309989
URI Parameters
- id
string(required) Example: b2e30352695154a0b37894241086abdb42060fabstable id of data element container
- versionId
string(required) Example: 2309989element version id of the data element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "b2e30352695154a0b37894241086abdb42060fab",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Create Data ElementPOST/elements/data
Create a data element container for the provided notebook entry.
Example URI
POST /api/v2/elements/data
Request
Create Data Element GroupHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"data_elements": [
{
"type": "DATA_ELEMENT_GROUP",
"title": "Solution XYZ",
"children": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "NaCl",
"value": "200",
"unit": "mL",
"physical_quantity_id": "6"
},
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Love",
"value": "900",
"unit": "mL",
"physical_quantity_id": "6"
},
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}
],
"locked": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the stable id of the entry which the element will be created in."
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"children": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
}
]
}
},
"required": [
"type",
"title"
]
},
"description": "The data elements. See description of data elements for details on format."
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
}
},
"required": [
"entry_id",
"data_elements"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/data/767930Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "DATA_ELEMENT_GROUP",
"title": "Solution XYZ",
"children": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "NaCl",
"value": "200",
"unit": "mL",
"physical_quantity_id": "6"
},
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Love",
"value": "900",
"unit": "mL",
"physical_quantity_id": "6"
},
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"children": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
}
]
}
},
"required": [
"type",
"title"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Request
Create Single Data ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"data_elements": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
],
"locked": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the stable id of the entry which the element will be created in."
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
"description": "The data elements. See description of data elements for details on format."
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
}
},
"required": [
"entry_id",
"data_elements"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/data/767930Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Request
Create Material Data ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"data_elements": [
{
"type": "MATERIAL_DATA_ELEMENT",
"item_id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"item_attributes": [
{
"id": "0553c003-9014-47ef-9522-115ad7d4b3a1"
}
]
}
],
"locked": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the stable id of the entry which the element will be created in."
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"item_id": {
"type": "string",
"description": "the stable id of the mdb item to reference"
},
"item_version_id": {
"type": "string",
"description": "the version id of the mdb item to reference"
},
"item_attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the item attribute id or 'item_code' for selecting the item_code"
}
},
"required": [
"id"
]
},
"description": "the item attributes of the mdb item to reference"
}
},
"required": [
"type",
"item_id",
"item_version_id"
]
},
"description": "The data elements. See description of data elements for details on format."
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
}
},
"required": [
"entry_id",
"data_elements"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/data/767930Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "MATERIAL_DATA_ELEMENT",
"item_id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"item_attributes": [
{
"id": "0553c003-9014-47ef-9522-115ad7d4b3a1",
"title": "Firepower",
"type": "Number",
"value": "1000"
}
],
"item_title": "Lasersword"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"item_id": {
"type": "string",
"description": "the stable id of the mdb item to reference"
},
"item_version_id": {
"type": "string",
"description": "the version id of the referenced mdb item"
},
"item_attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the item attribute id or 'item_code'"
},
"title": {
"type": "string",
"description": "the item attribute title"
},
"type": {
"type": "string",
"description": "the item attribute type"
},
"value": {
"type": "string",
"description": "the item attribute value"
}
},
"required": [
"id",
"title",
"type",
"value"
]
},
"description": "the attributes of the referenced mdb item"
},
"item_title": {
"type": "string",
"description": "the title of the referenced mdb item"
}
},
"required": [
"type",
"item_id",
"item_version_id",
"item_title"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Request
Create Descriptive Data ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"data_elements": [
{
"type": "DESCRIPTIVE_DATA_ELEMENT",
"title": "Descriptive XYZ",
"description": "Some very scientific and hard to understand description which will ruin the nature first and then rescue it"
}
],
"locked": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the stable id of the entry which the element will be created in."
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"type",
"title"
]
},
"description": "The data elements. See description of data elements for details on format."
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
}
},
"required": [
"entry_id",
"data_elements"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/data/767930Body
{
"id": "767930",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "DESCRIPTIVE_DATA_ELEMENT",
"title": "Descriptive XYZ",
"description": "Some very scientific and hard to understand description which will ruin the nature first and then rescue it"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"type",
"title"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Update Data ElementPUT/elements/data/{id}
Update a data element container for the provided notebook entry.
Example URI
PUT /api/v2/elements/data/b2e30352695154a0b37894241086abdb42060fab
URI Parameters
- id
string(required) Example: b2e30352695154a0b37894241086abdb42060fabstable id of data element container
Request
Update Data ElementHeaders
Content-Type: application/jsonBody
{
"id": "b2e30352695154a0b37894241086abdb42060fab",
"entry_id": "938307",
"data_elements": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of data element container"
},
"entry_id": {
"type": "string",
"description": "the stable id of the entry which the element will be created in."
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"data_elements"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "b2e30352695154a0b37894241086abdb42060fab",
"entry_id": "938307",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "DATA",
"data_elements": [
{
"type": "SINGLE_DATA_ELEMENT",
"title": "Water",
"value": "300",
"unit": "mL",
"physical_quantity_id": "6"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"DATA"
],
"description": "Denotes that this is a data elements entry element. The value is always `DATA`"
},
"data_elements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE_DATA_ELEMENT",
"DATA_ELEMENT_GROUP",
"MATERIAL_DATA_ELEMENT",
"DESCRIPTIVE_DATA_ELEMENT"
]
},
"title": {
"type": "string"
},
"value": {
"type": "string"
},
"unit": {
"type": "string"
},
"physical_quantity_id": {
"type": "string"
}
},
"required": [
"type",
"unit",
"physical_quantity_id"
]
},
"description": "The data elements. See description of data elements for details on format."
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"data_elements"
],
"additionalProperties": false
}Table Elements ¶
Table Data can be added to notebook entries. Table element may have a title and content in the Grapecity Spread.JS format.
The object sent in the field content must be valid according to the Grapecity Documentation for JSON schema.
Get Table ElementGET/elements/table/{id}
Returns the latest version of the table element
Example URI
GET /api/v2/elements/table/3d39ed9a99e4a8b1b0de4944d3eef9903174554e
URI Parameters
- id
string(required) Example: 3d39ed9a99e4a8b1b0de4944d3eef9903174554estable id of table element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "0801c8932f4567dc59eeb806d3c2f2be592a99ac",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "TABLE",
"title": "Rebellion Table",
"content": null
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"TABLE"
],
"description": "Denotes that this is a table element. The value is always `TABLE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the table"
},
"content": {
"type": [
"object",
"null"
],
"properties": {},
"description": "The JSON content of the table element"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content"
],
"additionalProperties": false
}Get Table Element VersionGET/elements/table/{id}/version/{versionId}
Returns the table element in the specified version
Example URI
GET /api/v2/elements/table/3d39ed9a99e4a8b1b0de4944d3eef9903174554e/version/2309984
URI Parameters
- id
string(required) Example: 3d39ed9a99e4a8b1b0de4944d3eef9903174554estable id of table element
- versionId
string(required) Example: 2309984element version id of the table element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "0801c8932f4567dc59eeb806d3c2f2be592a99ac",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "TABLE",
"title": "Rebellion Table",
"content": null
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"TABLE"
],
"description": "Denotes that this is a table element. The value is always `TABLE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the table"
},
"content": {
"type": [
"object",
"null"
],
"properties": {},
"description": "The JSON content of the table element"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content"
],
"additionalProperties": false
}Create Table ElementPOST/elements/table
Create a table element container for the provided notebook entry.
Example URI
POST /api/v2/elements/table
Request
Create Table ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"title": "New Table Title",
"content": {},
"locked": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The id of the notebook entry"
},
"title": {
"type": "string",
"description": "The title of the table"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the table element"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
}
},
"required": [
"entry_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/table/3d39ed9a99e4a8b1b0de4944d3eef9903174554eBody
{
"id": "0801c8932f4567dc59eeb806d3c2f2be592a99ac",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "TABLE",
"title": "Rebellion Table",
"content": null
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"TABLE"
],
"description": "Denotes that this is a table element. The value is always `TABLE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the table"
},
"content": {
"type": [
"object",
"null"
],
"properties": {},
"description": "The JSON content of the table element"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content"
],
"additionalProperties": false
}Update Table ElementPUT/elements/table/{id}
Update a table element container for the provided notebook entry.
Example URI
PUT /api/v2/elements/table/3d39ed9a99e4a8b1b0de4944d3eef9903174554e
URI Parameters
- id
string(required) Example: 3d39ed9a99e4a8b1b0de4944d3eef9903174554estable id of table element
Request
Update Table ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"title": "Updated Table Title",
"content": {},
"id": "3d39ed9a99e4a8b1b0de4944d3eef9903174554e"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The id of the notebook entry"
},
"title": {
"type": "string",
"description": "The title of the table"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the table element"
},
"id": {
"type": "string",
"description": "the stable pointer to the table element"
}
},
"required": [
"entry_id",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "0801c8932f4567dc59eeb806d3c2f2be592a99ac",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "TABLE",
"title": "Rebellion Table",
"content": null
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"TABLE"
],
"description": "Denotes that this is a table element. The value is always `TABLE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the table"
},
"content": {
"type": [
"object",
"null"
],
"properties": {},
"description": "The JSON content of the table element"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content"
],
"additionalProperties": false
}Well Plate Template Elements ¶
Get Well Plate Template ElementGET/elements/well-plate/{id}
Returns the latest version of the well plate template element
Example URI
GET /api/v2/elements/well-plate/b9a96ee06634083866155d41cd8ff932f9d6fa9c
URI Parameters
- id
string(required) Example: b9a96ee06634083866155d41cd8ff932f9d6fa9cstable id of well plate template element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "b9a96ee06634083866155d41cd8ff932f9d6fa9c",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "WELL_PLATE",
"title": "Great Wells Plate Template",
"content": {},
"meta_data": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"WELL_PLATE"
],
"description": "Denotes that this is a well plate template element. The value is always `WELL_PLATE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the well plate template"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the well plate template element"
},
"meta_data": {
"type": "object",
"properties": {},
"description": "JSON meta data for visualization processing, used to store information about layer colors and well identifiers"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content",
"meta_data"
],
"additionalProperties": false
}Get Well Plate Template Element VersionGET/elements/well-plate/{id}/version/{versionId}
Returns the well plate template element in the specified version
Example URI
GET /api/v2/elements/well-plate/b9a96ee06634083866155d41cd8ff932f9d6fa9c/version/2309987
URI Parameters
- id
string(required) Example: b9a96ee06634083866155d41cd8ff932f9d6fa9cstable id of well plate template element
- versionId
string(required) Example: 2309987element version id of the well plate template element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "b9a96ee06634083866155d41cd8ff932f9d6fa9c",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "WELL_PLATE",
"title": "Great Wells Plate Template",
"content": {},
"meta_data": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"WELL_PLATE"
],
"description": "Denotes that this is a well plate template element. The value is always `WELL_PLATE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the well plate template"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the well plate template element"
},
"meta_data": {
"type": "object",
"properties": {},
"description": "JSON meta data for visualization processing, used to store information about layer colors and well identifiers"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content",
"meta_data"
],
"additionalProperties": false
}Create Well Plate Template ElementPOST/elements/well-plate
Create a well plate template element container for the provided notebook entry.
Example URI
POST /api/v2/elements/well-plate
Request
Create Well Plate Template ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938305",
"title": "New Well Plate Template Title",
"content": {},
"meta_data": {},
"locked": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The id of the notebook entry"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the well plate template"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the well plate template element"
},
"meta_data": {
"type": "object",
"properties": {},
"description": "JSON meta data for visualization processing, used to store information about layer colors and well identifiers"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
}
},
"required": [
"entry_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/well-plate/b9a96ee06634083866155d41cd8ff932f9d6fa9cBody
{
"id": "b9a96ee06634083866155d41cd8ff932f9d6fa9c",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "WELL_PLATE",
"title": "Great Wells Plate Template",
"content": {},
"meta_data": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"WELL_PLATE"
],
"description": "Denotes that this is a well plate template element. The value is always `WELL_PLATE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the well plate template"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the well plate template element"
},
"meta_data": {
"type": "object",
"properties": {},
"description": "JSON meta data for visualization processing, used to store information about layer colors and well identifiers"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content",
"meta_data"
],
"additionalProperties": false
}Update Well Plate Template ElementPUT/elements/well-plate/{id}
Update a well plate template element container for the provided notebook entry.
Example URI
PUT /api/v2/elements/well-plate/b9a96ee06634083866155d41cd8ff932f9d6fa9c
URI Parameters
- id
string(required) Example: b9a96ee06634083866155d41cd8ff932f9d6fa9cstable id of well plate template element
Request
Update Well Plate Template ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938305",
"title": "Updated Well Plate Template Title",
"content": {},
"meta_data": {},
"id": "b9a96ee06634083866155d41cd8ff932f9d6fa9c"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The id of the notebook entry"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the well plate template"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the well plate template element"
},
"meta_data": {
"type": "object",
"properties": {},
"description": "JSON meta data for visualization processing, used to store information about layer colors and well identifiers"
},
"id": {
"type": "string",
"description": "the stable pointer to the well plate template element"
}
},
"required": [
"entry_id",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "b9a96ee06634083866155d41cd8ff932f9d6fa9c",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"element_type": "WELL_PLATE",
"title": "Great Wells Plate Template",
"content": {},
"meta_data": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"element_type": {
"type": "string",
"enum": [
"WELL_PLATE"
],
"description": "Denotes that this is a well plate template element. The value is always `WELL_PLATE`"
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the well plate template"
},
"content": {
"type": "object",
"properties": {},
"description": "The JSON content of the well plate template element"
},
"meta_data": {
"type": "object",
"properties": {},
"description": "JSON meta data for visualization processing, used to store information about layer colors and well identifiers"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"element_type",
"title",
"content",
"meta_data"
],
"additionalProperties": false
}Text Elements ¶
Get Text ElementGET/elements/text/{id}
Returns the latest version of the text element
Example URI
GET /api/v2/elements/text/dd0e1a868ae56843706dcaf11f88a55ca87ad578
URI Parameters
- id
string(required) Example: dd0e1a868ae56843706dcaf11f88a55ca87ad578stable id of text element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "dd0e1a868ae56843706dcaf11f88a55ca87ad578",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"content": "J is the only letter that does not appear in the periodic table of elements.",
"element_type": "TEXT"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"content": {
"type": "string",
"description": "The text based content of this element"
},
"element_type": {
"type": "string",
"enum": [
"TEXT"
],
"description": "Denotes that this is a text element. The value is always `TEXT`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"content",
"element_type"
],
"additionalProperties": false
}Get Text Element VersionGET/elements/text/{id}/version/{versionId}
Returns the text element in the specified version
Example URI
GET /api/v2/elements/text/dd0e1a868ae56843706dcaf11f88a55ca87ad578/version/2309983
URI Parameters
- id
string(required) Example: dd0e1a868ae56843706dcaf11f88a55ca87ad578stable id of text element
- versionId
string(required) Example: 2309983element version id of the text element
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "dd0e1a868ae56843706dcaf11f88a55ca87ad578",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"content": "J is the only letter that does not appear in the periodic table of elements.",
"element_type": "TEXT"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"content": {
"type": "string",
"description": "The text based content of this element"
},
"element_type": {
"type": "string",
"enum": [
"TEXT"
],
"description": "Denotes that this is a text element. The value is always `TEXT`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"content",
"element_type"
],
"additionalProperties": false
}Create Text ElementPOST/elements/text
Create a new text element for the provided notebook entry.
The text element content may be plain text or basic HTML.
Note: Images should be included in the entry as file elements.
Avoid using the <img> tag whenever possible. Instead, upload the image directly as a file element.
HTML image tags (<img>) are not supported in the text element.
If image tags are present they will be transformed to hyperlinks.
To perform a successful automatic conversion from <img> to <a>, the src attribute
of the image tag must be an absolute URL with protocol http or https. Even in the event of a
successful conversion to <a> tag, there is no guarantee that the link will be functional.
In general, as a result of html processing, the request content may differ from the response content.
Example URI
POST /api/v2/elements/text
Request
Create Text ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"content": "J is the only letter that does not appear in the periodic table of elements.",
"locked": true,
"text_element_origin": "LABFOLDER"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The id of the notebook entry"
},
"content": {
"type": [
"string",
"null"
],
"description": "Text based content to be added to the end of the entry"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element should be locked upon creation"
},
"text_element_origin": {
"type": "string",
"enum": [
"LABFOLDER",
"LABFOLDER_GO"
],
"description": "the source of the text element wether manual input (default) or voice input from labfolder GO"
}
},
"required": [
"entry_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /elements/text/dd0e1a868ae56843706dcaf11f88a55ca87ad578Body
{
"id": "dd0e1a868ae56843706dcaf11f88a55ca87ad578",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"content": "J is the only letter that does not appear in the periodic table of elements.",
"element_type": "TEXT"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"content": {
"type": "string",
"description": "The text based content of this element"
},
"element_type": {
"type": "string",
"enum": [
"TEXT"
],
"description": "Denotes that this is a text element. The value is always `TEXT`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"content",
"element_type"
],
"additionalProperties": false
}Update Text ElementPUT/elements/text/{id}
Update a text element container for the provided notebook entry
The text element content may be plain text or basic HTML.
Note: Images should be included in the entry as file elements.
Avoid using the <img> tag whenever possible. Instead, upload the image directly as a file element.
HTML image tags (<img>) are not supported in the text element.
If image tags are present they will be transformed to hyperlinks.
To perform a successful automatic conversion from <img> to <a>, the src attribute
of the image tag must be an absolute URL with protocol http or https. Even in the event of a
successful conversion to <a> tag, there is no guarantee that the link will be functional.
In general, as a result of html processing, the request content may differ from the response content.
Example URI
PUT /api/v2/elements/text/dd0e1a868ae56843706dcaf11f88a55ca87ad578
URI Parameters
- id
string(required) Example: dd0e1a868ae56843706dcaf11f88a55ca87ad578stable id of text element
Request
Update Text ElementHeaders
Content-Type: application/jsonBody
{
"entry_id": "938302",
"content": "There are 118 elements in the periodic table.",
"id": "dd0e1a868ae56843706dcaf11f88a55ca87ad578"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "The id of the notebook entry"
},
"content": {
"type": [
"string",
"null"
],
"description": "Text based content"
},
"id": {
"type": "string",
"description": "the stable pointer to the text element"
}
},
"required": [
"entry_id",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "dd0e1a868ae56843706dcaf11f88a55ca87ad578",
"entry_id": "938302",
"version_id": "767930",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"locked": false,
"content": "There are 118 elements in the periodic table.",
"element_type": "TEXT"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable pointer to the element"
},
"entry_id": {
"type": "string",
"description": "the id of the stable pointer to the entry"
},
"version_id": {
"type": "string",
"description": "the unique id of the element"
},
"owner_id": {
"type": "string",
"description": "the id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the entry element (first version)"
},
"version_date": {
"type": "string",
"description": "the creation date of the entry element version (same with the creation date on the first version)"
},
"locked": {
"type": "boolean",
"description": "indicates whether this element is locked"
},
"content": {
"type": "string",
"description": "The text based content of this element"
},
"element_type": {
"type": "string",
"enum": [
"TEXT"
],
"description": "Denotes that this is a text element. The value is always `TEXT`"
}
},
"required": [
"id",
"entry_id",
"version_id",
"owner_id",
"creation_date",
"version_date",
"locked",
"content",
"element_type"
],
"additionalProperties": false
}Tasks ¶
Tasks ¶
List TasksGET/tasks{?assign_status,statuses,limit,offset,expand}
Returns a list of tasks the user has access to.
Example URI
GET /api/v2/tasks?assign_status=&statuses=&limit=&offset=&expand=
URI Parameters
- assign_status
string(required)Restricts the returned values to that of the desired assign status
Choices:
ASSIGNED_TO_MEASSIGNED_TO_OTHERSUNASSIGNED- statuses
string(optional)Restricts the returned values to that of the desired task status
Choices:
CREATEDASSIGNEDIN_PROGRESSRESOLVEDCLOSED- limit
number(optional) Default: 20Maximum number of tasks to return - Maximum allowed limit is 100
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned.
Choices:
creatorassignee
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "1000",
"created_date": "2024-05-02T12:10:00.000+0200",
"creator_id": "11038",
"assignee_id": "0",
"status": "CREATED",
"title": "Task title",
"content": "Task content"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_date": {
"type": "string",
"description": "date when the task was created"
},
"creator_id": {
"type": "string",
"description": "the id of the user who created the task"
},
"assignee_id": {
"type": "string",
"description": "the id of the user who is assigned to the task"
},
"status": {
"type": "string",
"enum": [
"CREATED",
"ASSIGNED",
"IN_PROGRESS",
"RESOLVED"
],
"description": "the status of the task"
},
"title": {
"type": "string",
"description": "the title of the task"
},
"content": {
"type": "string",
"description": "the content of the task"
}
},
"required": [
"id",
"created_date",
"creator_id",
"assignee_id",
"status",
"title",
"content"
]
}
}Export ¶
Exports ¶
List All ExportsGET/exports{?status,limit,offset}
Get a list of Exports of all kinds that the requesting user has created. The list is ordered by creation date descending.
Example URI
GET /api/v2/exports?status=FINISHED&limit=&offset=
URI Parameters
- status
string(optional) Example: FINISHEDA comma separated list of statuses to be filtered.
Choices:
NEWRUNNINGFINISHEDREMOVEDERRORQUEUED- limit
number(optional) Default: 20Maximum number of exports to return. The maximum for
limitis 50 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "XHTML",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "my_labfolder_content.zip",
"download_href": "https://labfolder.labforward.app/api/v2/exports/xhtml/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285"
},
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "PDF",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "example_project.pdf",
"download_href": "https://labfolder.labforward.app/api/v2/exports/pdf/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285",
"settings": {}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"XHTML"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"PDF"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
},
"settings": {
"type": "object",
"properties": {
"preserve_entry_layout": {
"type": "boolean",
"description": "defines if PDF maintains the entry layout or lists all entry elements bellow each other",
"default": false
}
}
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename",
"settings"
]
}
]
}PDF Exports ¶
List PDF ExportsGET/exports/pdf{?status,limit,offset}
Get all created PDF Exports the requesting user has created
Example URI
GET /api/v2/exports/pdf?status=FINISHED&limit=&offset=
URI Parameters
- status
string(optional) Example: FINISHEDA comma separated list of statuses to be filtered.
Choices:
NEWRUNNINGFINISHEDREMOVEDERRORQUEUED- limit
number(optional) Default: 20Maximum number of exports to return. The maximum for
limitis 50 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "PDF",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "example_project.pdf",
"download_href": "https://labfolder.labforward.app/api/v2/exports/pdf/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285",
"settings": {}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"PDF"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
},
"settings": {
"type": "object",
"properties": {
"preserve_entry_layout": {
"type": "boolean",
"description": "defines if PDF maintains the entry layout or lists all entry elements bellow each other",
"default": false
}
}
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename",
"settings"
]
}
}Get PDF ExportGET/exports/pdf/{id}
Returns the current version of the PDF export.
Example URI
GET /api/v2/exports/pdf/ced8ca60-660b-4916-96a7-76b3258db135
URI Parameters
- id
string(required) Example: ced8ca60-660b-4916-96a7-76b3258db135id of the PDF export
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "PDF",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "example_project.pdf",
"download_href": "https://labfolder.labforward.app/api/v2/exports/pdf/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285",
"settings": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"PDF"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
},
"settings": {
"type": "object",
"properties": {
"preserve_entry_layout": {
"type": "boolean",
"description": "defines if PDF maintains the entry layout or lists all entry elements bellow each other",
"default": false
}
}
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename",
"settings"
],
"additionalProperties": false
}Download PDF Export FileGET/exports/pdf/{id}/download
Download the result file of a finished PDF export.
Example URI
GET /api/v2/exports/pdf/ced8ca60-660b-4916-96a7-76b3258db135/download
URI Parameters
- id
string(required) Example: ced8ca60-660b-4916-96a7-76b3258db135id of the PDF export
Response
200Headers
Content-Type: application/pdf
Content-Disposition: `attachment;filename="labfolder_export.pdf"`
Content-Length: 12345Body
... file content as binary ...Create PDF ExportPOST/exports/pdf
Create a PDF export of a project, a template, a single entry or all content the requesting user is the owner of.
Only one template ID, entry ID or group ID is valid to be submitted at a time to create a PDF export.
Multiple project/template IDs can be submitted at once to create a PDF export of multiple projects/templates without preserving the entry layout.
However you can create a full export of all the content you own by simply not specifying any project_ids, template_ids, entry_ids or group_ids in the request.
Example URI
POST /api/v2/exports/pdf
Request
Create PDF ExportHeaders
Content-Type: application/jsonBody
{
"download_filename": "example project",
"settings": {
"preserve_entry_layout": true
},
"content": {
"project_ids": [
"36272"
],
"entry_ids": [
"938302"
],
"template_ids": [
"36280"
],
"group_ids": [
"1200"
]
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"download_filename": {
"type": "string",
"description": "the filename that should be used for the finished export downloadable file"
},
"settings": {
"type": "object",
"properties": {
"preserve_entry_layout": {
"type": "boolean",
"description": "defines if PDF maintains the entry layout or lists all entry elements bellow each other",
"default": false
}
},
"description": "json object defining custom settings for export content"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects to be exported"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries to be exported"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates to be exported"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of groups to be exported"
}
},
"additionalProperties": false,
"description": "object defining the export content scope"
}
}
}Response
202Headers
Content-Type: application/json;charset=UTF-8
Location: /exports/pdf/20e699a3-4764-461f-a4bc-d10d7cbba3f0Body
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "PDF",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "example_project.pdf",
"download_href": "https://labfolder.labforward.app/api/v2/exports/pdf/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285",
"settings": {}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"PDF"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
},
"settings": {
"type": "object",
"properties": {
"preserve_entry_layout": {
"type": "boolean",
"description": "defines if PDF maintains the entry layout or lists all entry elements bellow each other",
"default": false
}
}
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename",
"settings"
],
"additionalProperties": false
}XHTML Exports ¶
List XHTML ExportsGET/exports/xhtml{?status,limit,offset}
Get all created XHTML Exports the requesting user has created
Example URI
GET /api/v2/exports/xhtml?status=FINISHED&limit=&offset=
URI Parameters
- status
string(optional) Example: FINISHEDA comma separated list of statuses to be filtered.
Choices:
NEWRUNNINGFINISHEDREMOVEDERRORQUEUED- limit
number(optional) Default: 20Maximum number of exports to return. The maximum for
limitis 50 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "XHTML",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "my_labfolder_content.zip",
"download_href": "https://labfolder.labforward.app/api/v2/exports/xhtml/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"XHTML"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename"
]
}
}Get XHTML ExportGET/exports/xhtml/{id}
Returns the current version of the XHTML export.
Example URI
GET /api/v2/exports/xhtml/a6e15cda-a48c-463c-bcc4-cf92c8323d8b
URI Parameters
- id
string(required) Example: a6e15cda-a48c-463c-bcc4-cf92c8323d8bid of the XHTML export
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "XHTML",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "my_labfolder_content.zip",
"download_href": "https://labfolder.labforward.app/api/v2/exports/xhtml/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"XHTML"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename"
],
"additionalProperties": false
}Download XHTML Export FileGET/exports/xhtml/{id}/download
Download the result file of a finished XHTML export.
Example URI
GET /api/v2/exports/xhtml/a6e15cda-a48c-463c-bcc4-cf92c8323d8b/download
URI Parameters
- id
string(required) Example: a6e15cda-a48c-463c-bcc4-cf92c8323d8bid of the XHTML export
Response
200Headers
Content-Type: application/zip
Content-Disposition: `attachment;filename="my_labfolder_data.zip"`
Content-Length: 12345Body
... file content as binary ...Create XHTML ExportPOST/exports/xhtml
Create a XHTML export of all content (Projects with their Entries & Templates) the requesting user owns.
Example URI
POST /api/v2/exports/xhtml
Request
Create XHTML ExportHeaders
Content-Type: application/jsonBody
{}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {}
}Response
202Headers
Content-Type: application/json;charset=UTF-8
Location: /exports/xhtml/20e699a3-4764-461f-a4bc-d10d7cbba3f0Body
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"type": "XHTML",
"content": {
"project_ids": [
"36272"
],
"entry_ids": [],
"template_ids": [],
"group_ids": []
},
"status": "FINISHED",
"completion_date": "2019-02-01T13:35:30.789+0200",
"download_file_length": 12345,
"creation_date": "2019-02-01T13:34:56.789+0200",
"version_date": "2019-02-01T13:35:30.789+0200",
"download_filename": "my_labfolder_content.zip",
"download_href": "https://labfolder.labforward.app/api/v2/exports/xhtml/20e699a3-4764-461f-a4bc-d10d7cbba3f0?X-Labfolder-Signature=2ff8f6e9044138adb49e4a3c0674b5b4992c8c51aa907f605ecf5da85833d020&X-Labfolder-Expires=1554974215285"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the export"
},
"user_id": {
"type": "string",
"description": "the unique id of the user, who created the export"
},
"type": {
"type": "string",
"enum": [
"XHTML"
],
"description": "the type of export"
},
"content": {
"type": "object",
"properties": {
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of projects that are contained in the export"
},
"entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of entries that are contained in the export"
},
"template_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of templates that are contained in the export"
},
"group_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the ids of complete groups that are contained in the export"
}
},
"required": [
"project_ids",
"entry_ids",
"template_ids",
"group_ids"
],
"additionalProperties": false,
"description": "object defining the export content scope"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the export in the export life cycle"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "date when the export file creation was completed"
},
"download_file_length": {
"type": "number",
"description": "the export download file content size in bytes"
},
"creation_date": {
"type": "string",
"description": "date when the export was created"
},
"version_date": {
"type": "string",
"description": "date when the export was last modified"
},
"download_filename": {
"type": "string",
"description": "the filename used for the finished export downloadable file"
},
"download_href": {
"type": [
"string",
"null"
],
"description": "entity specific pre-signed download URL, that is valid until the date (in milliseconds) from the X-Labfolder-Expires parameter"
}
},
"required": [
"id",
"user_id",
"type",
"content",
"status",
"completion_date",
"download_file_length",
"creation_date",
"version_date",
"download_filename"
],
"additionalProperties": false
}Labregister ¶
Categories ¶
List CategoriesGET/mdb/categories{?group_id,expand}
Returns the list of all accessible categories of the requesting user
Example URI
GET /api/v2/mdb/categories?group_id=1200&expand=
URI Parameters
- group_id
string(optional) Example: 1200Only return the categories that belong to the specified group
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all categories returned
Choices:
creator
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}
}List Categories with Group & KeywordGET/mdb/categories{?group_id,keyword,status,expand}
Returns the list of accessible categories of the requesting user filtered with group id and keyword
Example URI
GET /api/v2/mdb/categories?group_id=1200&keyword=Name&status=ACTIVE&expand=
URI Parameters
- group_id
string(required) Example: 1200Only return the categories that belongs to the group
- keyword
string(optional) Example: NameOnly return the categories that belongs to the group and has the specific keyword in the name
- status
string(optional) Example: ACTIVEOnly return the categories of the specific status that belongs to the group
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all categories returned
Choices:
creator
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}
}Get CategoryGET/mdb/categories/{id}{?expand}
Returns the non-deleted, active or hidden, category
Example URI
GET /api/v2/mdb/categories/e87e6534-2ae0-4139-bc48-cc668f330069?expand=
URI Parameters
- id
string(required) Example: e87e6534-2ae0-4139-bc48-cc668f330069id of the category
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all categories returned
Choices:
creator
Request
Get CategoryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"attributes",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"additionalProperties": false
}Request
Get Category with Barcode AttributeResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Barcode",
"title": "Barcode",
"mandatory": false,
"options": [
"null"
],
"settings": {
"barcode_generation_method": "MANUAL",
"barcode_type": "CODE_128"
}
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Barcode",
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": "object",
"properties": {
"barcode_generation_method": {
"type": "string",
"enum": [
"MANUAL",
"AUTO"
],
"description": "this enum should contain Barcode Attribute's generation method"
},
"barcode_type": {
"type": "string",
"enum": [
"CODE_128",
"DATA_MATRIX"
],
"description": "this enum should contain Barcode Attribute's type"
}
},
"required": [
"barcode_generation_method",
"barcode_type"
],
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory",
"settings"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"attributes",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"additionalProperties": false
}Get Category Item Table ViewGET/mdb/categories/{id}/items-table-view{?title,query,include_hidden}
Returns the category items
Example URI
GET /api/v2/mdb/categories/e87e6534-2ae0-4139-bc48-cc668f330069/items-table-view?title=&query=&include_hidden=
URI Parameters
- id
string(required) Example: e87e6534-2ae0-4139-bc48-cc668f330069id of the category
- title
string(optional)The search term to filter items by
title. If not provided it will not filter.- query
string(optional)The search term to filter items by all attributes, including
title. If not provided it will not filter.- include_hidden
boolean(optional)The boolean flag to include hidden items in the response. The default value is false.
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"file_count": 1,
"relationship_count": 1,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"item_code": "LR-20170210-1",
"status": "ACTIVE"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"file_count": {
"type": "number",
"description": "the number of files which are attached to this item"
},
"relationship_count": {
"type": "number",
"description": "the number of items which have relationship with the item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"id",
"version_id",
"title",
"custom_attributes",
"file_count",
"relationship_count",
"creation_date",
"version_date",
"item_code",
"status"
]
}
}
},
"required": [
"id",
"version_id",
"items"
],
"additionalProperties": false
}Request
Get All Active or Hidden Item views of a CategoryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"file_count": 1,
"relationship_count": 1,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"item_code": "LR-20170210-1",
"status": "ACTIVE"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"file_count": {
"type": "number",
"description": "the number of files which are attached to this item"
},
"relationship_count": {
"type": "number",
"description": "the number of items which have relationship with the item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"id",
"version_id",
"title",
"custom_attributes",
"file_count",
"relationship_count",
"creation_date",
"version_date",
"item_code",
"status"
]
}
}
},
"required": [
"id",
"version_id",
"items"
],
"additionalProperties": false
}Request
Get All Active Item views by TitleResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"file_count": 1,
"relationship_count": 1,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"item_code": "LR-20170210-1",
"status": "ACTIVE"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"file_count": {
"type": "number",
"description": "the number of files which are attached to this item"
},
"relationship_count": {
"type": "number",
"description": "the number of items which have relationship with the item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"id",
"version_id",
"title",
"custom_attributes",
"file_count",
"relationship_count",
"creation_date",
"version_date",
"item_code",
"status"
]
}
}
},
"required": [
"id",
"version_id",
"items"
],
"additionalProperties": false
}Request
Get All Active Item views by All Attribute ValuesResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"file_count": 1,
"relationship_count": 1,
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200",
"item_code": "LR-20170210-1",
"status": "ACTIVE"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"file_count": {
"type": "number",
"description": "the number of files which are attached to this item"
},
"relationship_count": {
"type": "number",
"description": "the number of items which have relationship with the item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"id",
"version_id",
"title",
"custom_attributes",
"file_count",
"relationship_count",
"creation_date",
"version_date",
"item_code",
"status"
]
}
}
},
"required": [
"id",
"version_id",
"items"
],
"additionalProperties": false
}Create CategoryPOST/mdb/categories
Create a Labregister category
Example URI
POST /api/v2/mdb/categories
Request
Create Category in Private SpaceHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/categories/76625e69-52eb-40b5-a610-99ab8b801cf9Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "null",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}Request
Create Category with Barcode Attribute in Private SpaceHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Barcode",
"title": "Barcode",
"mandatory": false,
"options": [
"null"
],
"settings": {
"barcode_generation_method": "MANUAL",
"barcode_type": "CODE_128"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Barcode",
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": "object",
"properties": {
"barcode_generation_method": {
"type": "string",
"enum": [
"MANUAL",
"AUTO"
],
"description": "this enum should contain Barcode Attribute's generation method"
},
"barcode_type": {
"type": "string",
"enum": [
"CODE_128",
"DATA_MATRIX"
],
"description": "this enum should contain Barcode Attribute's type"
}
},
"required": [
"barcode_generation_method",
"barcode_type"
],
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory",
"settings"
]
},
"description": "The attribute definitions of the category"
}
},
"required": [
"title"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/categories/76625e69-52eb-40b5-a610-99ab8b801cf9Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Barcode",
"title": "Barcode",
"mandatory": false,
"options": [
"null"
],
"settings": {
"barcode_generation_method": "MANUAL",
"barcode_type": "CODE_128"
}
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "null",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Barcode",
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": "object",
"properties": {
"barcode_generation_method": {
"type": "string",
"enum": [
"MANUAL",
"AUTO"
],
"description": "this enum should contain Barcode Attribute's generation method"
},
"barcode_type": {
"type": "string",
"enum": [
"CODE_128",
"DATA_MATRIX"
],
"description": "this enum should contain Barcode Attribute's type"
}
},
"required": [
"barcode_generation_method",
"barcode_type"
],
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory",
"settings"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}Request
Create Category in a GroupHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"group_id": {
"type": "string",
"description": "the id of the group to which the category is associated"
}
},
"required": [
"title",
"group_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/categories/76625e69-52eb-40b5-a610-99ab8b801cf9Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}Update CategoryPUT/mdb/categories/{id}
Update a Labregister category. Note that you need to pass the attribute id if you want to update an existing attribute. Otherwise it will be created as new rather than being updated.
Example URI
PUT /api/v2/mdb/categories/b10b785d-d87d-48cf-9c0b-d7be08f377b2
URI Parameters
- id
string(required) Example: b10b785d-d87d-48cf-9c0b-d7be08f377b2the stable id of the category
Request
Update CategoryHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
}
},
"required": [
"title",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 2,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}Request
Update Category with Barcode AttributeHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Barcode",
"title": "Barcode",
"mandatory": false,
"options": [
"null"
],
"settings": {
"barcode_generation_method": "MANUAL",
"barcode_type": "CODE_128"
}
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Barcode",
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": "object",
"properties": {
"barcode_generation_method": {
"type": "string",
"enum": [
"MANUAL",
"AUTO"
],
"description": "this enum should contain Barcode Attribute's generation method"
},
"barcode_type": {
"type": "string",
"enum": [
"CODE_128",
"DATA_MATRIX"
],
"description": "this enum should contain Barcode Attribute's type"
}
},
"required": [
"barcode_generation_method",
"barcode_type"
],
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory",
"settings"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
}
},
"required": [
"title",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Barcode",
"title": "Barcode",
"mandatory": false,
"options": [
"null"
],
"settings": {
"barcode_generation_method": "MANUAL",
"barcode_type": "CODE_128"
}
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 2,
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Barcode",
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": "object",
"properties": {
"barcode_generation_method": {
"type": "string",
"enum": [
"MANUAL",
"AUTO"
],
"description": "this enum should contain Barcode Attribute's generation method"
},
"barcode_type": {
"type": "string",
"enum": [
"CODE_128",
"DATA_MATRIX"
],
"description": "this enum should contain Barcode Attribute's type"
}
},
"required": [
"barcode_generation_method",
"barcode_type"
],
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory",
"settings"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}Update Category StatusPATCH/mdb/categories/{id}
Update a Labregister category status.
Example URI
PATCH /api/v2/mdb/categories/49f15100-1906-46fd-bbb1-1e5f059b8866
URI Parameters
- id
string(required) Example: 49f15100-1906-46fd-bbb1-1e5f059b8866the stable id of the category
Request
Update Category statusHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/status",
"value": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/status"
],
"description": "JSON Pointer notation to the member named status"
},
"value": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "a new status of the category"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 2,
"status": "HIDDEN"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
]
}Delete CategoryDELETE/mdb/categories/{id}
Deletes the Category. Note: the entity is not deleted, but is flagged as ‘hidden’.
Example URI
DELETE /api/v2/mdb/categories/b10b785d-d87d-48cf-9c0b-d7be08f377b2
URI Parameters
- id
string(required) Example: b10b785d-d87d-48cf-9c0b-d7be08f377b2id of the category to delete
Response
204Category Attributes ¶
List User AttributesGET/mdb/categories/attributes/custom
Returns all custom category attributes created in categories the user has access to
Example URI
GET /api/v2/mdb/categories/attributes/custom
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
}
}List Dropdown Attribute ValuesGET/mdb/categories/attributes/{id}/dropdown-values
Returns a list of all possible values in a Dropdown attribute
Example URI
GET /api/v2/mdb/categories/attributes/f94bb81d-ad1d-4301-9f18-a9bf408b4e65/dropdown-values
URI Parameters
- id
string(required) Example: f94bb81d-ad1d-4301-9f18-a9bf408b4e65id of the dropdown attribute
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
"Hello, world!"
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "string"
}
}List Category Attribute Auto Complete SuggestionsGET/mdb/categories/attributes{?group_id,keyword,category_statuses}
Returns category attribute suggestions with category name the user has access to
Example URI
GET /api/v2/mdb/categories/attributes?group_id=1200&keyword=Fire&category_statuses=ACTIVE
URI Parameters
- group_id
string(required) Example: 1200Only return the category attribute suggestions that belong to a category of the specified group
- keyword
string(required) Example: FireThe search term that matches with the category title
- category_statuses
string(optional) Example: ACTIVEA comma separated list of list of category statuses for the attributes we want to search
- DEFAULT:
ACTIVE
Choices:
ACTIVEHIDDEN- DEFAULT:
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_title": "Luke's Private Weapons",
"attribute_id": "0553c003-9014-47ef-9522-115ad7d4b3a1",
"attribute_title": "Firepower",
"attribute_type": "Barcode",
"attribute_title_marked": "<mark>Fire</mark>power"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_title": {
"type": "string",
"description": "category title"
},
"attribute_id": {
"type": "string",
"description": "the attribute id of the category attribute"
},
"attribute_title": {
"type": "string",
"description": "the attribute title"
},
"attribute_type": {
"type": "string",
"enum": [
"Barcode",
"Date",
"Dropdown",
"LongText",
"Number",
"Text",
"Url"
],
"description": "the attribute type"
},
"attribute_title_marked": {
"type": "string",
"description": "the attribute title with search term marked"
}
},
"required": [
"category_title",
"attribute_id",
"attribute_title",
"attribute_type",
"attribute_title_marked"
]
}
}Items ¶
List ItemsGET/mdb/items{?category_id,title,query,expand,include_hidden}
Returns the list of all accessible items sorted by display title. Note that at least one of the parameters (category_id, title, or query) needs to be sent within the request.
Example URI
GET /api/v2/mdb/items?category_id=&title=&query=&expand=&include_hidden=
URI Parameters
- category_id
string(optional)The category id to show items for. If none provided will show all items.
- title
string(optional)The search term to filter items by
title. If not provided it will not filter.- query
string(optional)The search term to filter items by all attributes, including
title. If not provided it will not filter.- include_hidden
boolean(optional)The boolean flag to include hidden items in the response. The default value is false.
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned
Choices:
category
Request
Get All Active Items of a CategoryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
]
}
}Request
Get All Active or Hidden Items of a CategoryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
]
}
}Request
Get All Active Items by TitleResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
]
}
}Request
Get All Active Items by All Attribute ValuesResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
]
}
}Request
Get All Active Items of a Category with Category InformationResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"category": {
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"category": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"description": "the category referenced by the `category_id` property"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"category"
]
}
}Get ItemGET/mdb/items/{id}{?expand}
Returns the current version of a Labregister item
Example URI
GET /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3?expand=
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3stable id of item
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned.
Choices:
category, files_metadata, relationships_detail
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
],
"additionalProperties": false
}Request
?expand=categoryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"category": {
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"category": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"description": "the category referenced by the `category_id` property"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"category"
],
"additionalProperties": false
}Request
?expand=files_metadataResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"files_metadata": {
"703a2010-d061-4166-af22-aedc0e8435b5": {
"id": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"author_id": "11038",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"upload_date": "2019-02-01T13:34:56.789+0200"
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"files_metadata": {
"type": "object",
"properties": {
"703a2010-d061-4166-af22-aedc0e8435b5": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the file"
},
"author_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"upload_date": {
"type": "string",
"description": "the timestamp when the upload is completed"
}
},
"required": [
"id",
"author_id",
"file_name",
"file_size",
"content_type",
"upload_date"
]
}
},
"description": "the file metadata of the attached file UUIDs in files field of the item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"files_metadata"
],
"additionalProperties": false
}Request
?expand=relationships_detailResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"relationships_detail": {
"e8292212-2cce-433c-afb9-a39236b5f0ca": {
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca",
"outward_item_code": "LR-2017-08-01-2",
"outward_item_title": "Laser Gun",
"outward_item_category_title": "Luke's Private Weapons",
"outward_item_hidden": false
}
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"relationships_detail": {
"type": "object",
"properties": {
"e8292212-2cce-433c-afb9-a39236b5f0ca": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the outward item stable id"
},
"outward_item_code": {
"type": "string",
"description": "the outward item code"
},
"outward_item_title": {
"type": "string",
"description": "the outward item title"
},
"outward_item_category_title": {
"type": "string",
"description": "the outward item's category title"
},
"outward_item_hidden": {
"type": "boolean",
"description": "the outward item hidden flag"
}
},
"required": [
"type",
"outward_item_id",
"outward_item_code",
"outward_item_title",
"outward_item_category_title",
"outward_item_hidden"
]
}
},
"description": "the relationships detail of the item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"relationships_detail"
],
"additionalProperties": false
}Get Item Details ViewGET/mdb/items/{id}{?includeAllExpansions}
Returns the detailed view of the current version of a Labregister item
Example URI
GET /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3?includeAllExpansions=true
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3stable id of item
- includeAllExpansions
boolean(required) Example: trueif passed true the detailed view of the item is returned with all related information about item
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca",
"outward_item_code": "LR-2017-08-01-2",
"outward_item_title": "Laser Gun",
"outward_item_category_title": "Luke's Private Weapons",
"outward_item_hidden": false
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"category": {
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
},
"files_metadata": [
{
"id": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"author_id": "11038",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"upload_date": "2019-02-01T13:34:56.789+0200"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the outward item stable id"
},
"outward_item_code": {
"type": "string",
"description": "the outward item code"
},
"outward_item_title": {
"type": "string",
"description": "the outward item title"
},
"outward_item_category_title": {
"type": "string",
"description": "the outward item's category title"
},
"outward_item_hidden": {
"type": "boolean",
"description": "the outward item hidden flag"
}
},
"required": [
"type",
"outward_item_id",
"outward_item_code",
"outward_item_title",
"outward_item_category_title",
"outward_item_hidden"
]
},
"description": "the item relationships array with outward item information"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"category": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"description": "the category information"
},
"files_metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the file"
},
"author_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"upload_date": {
"type": "string",
"description": "the timestamp when the upload is completed"
}
},
"required": [
"id",
"author_id",
"file_name",
"file_size",
"content_type",
"upload_date"
]
},
"description": "the file metadata of the attached file UUIDs in files field of the item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"category",
"files_metadata"
],
"additionalProperties": false
}Get Item VersionGET/mdb/items/{id}/versions/{version_id}{?expand}
Returns the specified version of a Labregister item
Example URI
GET /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3/versions/2493713e-9316-47b5-b9c8-c83332bdee30?expand=
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3stable id of item
- version_id
string(required) Example: 2493713e-9316-47b5-b9c8-c83332bdee30version of the item
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned
Choices:
category
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"version_count": 10
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"version_count": {
"type": "number",
"description": "the total number of versions available for this item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"version_count"
],
"additionalProperties": false
}Request
?expand=categoryResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"version_count": 10,
"category": {
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"version_count": {
"type": "number",
"description": "the total number of versions available for this item"
},
"category": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"description": "the category referenced by the `category_id` property"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"version_count",
"category"
],
"additionalProperties": false
}Get Item Version Details ViewGET/mdb/items/{id}/versions/{version_id}{?includeAllExpansions}
Returns the detailed view of specified version of a Labregister item
Example URI
GET /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3/versions/2493713e-9316-47b5-b9c8-c83332bdee30?includeAllExpansions=true
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3stable id of item
- version_id
string(required) Example: 2493713e-9316-47b5-b9c8-c83332bdee30version of the item
- includeAllExpansions
boolean(required) Example: trueif passed true the detailed view of the item is returned with all related information about item
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE",
"version_count": 10,
"category": {
"title": "Luke's Private Vehicles",
"attributes": [
{
"type": "Text",
"title": "Model",
"mandatory": false,
"options": [
"null"
],
"settings": null
}
],
"id": "b10b785d-d87d-48cf-9c0b-d7be08f377b2",
"group_id": "1200",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"version_date": "2017-02-15T12:34:56.789+0200",
"version": 1,
"status": "ACTIVE"
},
"files_metadata": [
{
"id": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"author_id": "11038",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"upload_date": "2019-02-01T13:34:56.789+0200"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
},
"version_count": {
"type": "number",
"description": "the total number of versions available for this item"
},
"category": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the category"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"Text",
"LongText",
"Date",
"Number",
"Url",
"Dropdown",
"Barcode"
]
},
"title": {
"type": "string",
"description": "the display title of the attribute"
},
"mandatory": {
"type": "boolean",
"description": "when set to `true` the items created in this category should have an associated value for this attribute"
},
"options": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "when the attribute type is Dropdown, then this array should be sent together"
},
"settings": {
"type": [
"object",
"null"
],
"properties": {},
"description": "the field which contains additional settings data of attribute"
}
},
"required": [
"type",
"title",
"mandatory"
]
},
"description": "The attribute definitions of the category"
},
"id": {
"type": "string",
"description": "the stable id of the category"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the id of the group to which the category is associated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creation_date": {
"type": "string",
"description": "the creation date of the category"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the category"
},
"version_date": {
"type": "string",
"description": "the last modification date of the category"
},
"version": {
"type": "number",
"description": "the version number of the category (it is automatically incremented for each modification on the category)"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether category is active, hidden or deleted"
}
},
"required": [
"title",
"id",
"group_id",
"creator_id",
"creation_date",
"version_id",
"version_date",
"version",
"status"
],
"description": "the category information"
},
"files_metadata": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the file"
},
"author_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"upload_date": {
"type": "string",
"description": "the timestamp when the upload is completed"
}
},
"required": [
"id",
"author_id",
"file_name",
"file_size",
"content_type",
"upload_date"
]
},
"description": "the file metadata of the attached file UUIDs in files field of the item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status",
"version_count",
"category",
"files_metadata"
],
"additionalProperties": false
}Download All Files of an Item as ZipGET/mdb/items/{id}/files/data
Returns the data of the compressed Labregister file
Example URI
GET /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3/files/data
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3stable id of item
Response
200Headers
Content-Type: application/zip
Content-Disposition: `attachment;filename="LR-20170801-1_files.zip"`Create ItemPOST/mdb/items
Create a Labregister item
Example URI
POST /api/v2/mdb/items
Request
Create ItemHeaders
Content-Type: application/jsonBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/items/1d573349-347b-4e46-a956-863d4e2db356Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
],
"additionalProperties": false
}Create Bulk Items for specific CategoryPOST/mdb/categories/{id}/items
Create Labregister items for specific category as a bulk action.
Example URI
POST /api/v2/mdb/categories/e87e6534-2ae0-4139-bc48-cc668f330069/items
URI Parameters
- id
string(required) Example: e87e6534-2ae0-4139-bc48-cc668f330069id of Category to add multiple items
Request
Create Bulk ItemsHeaders
Content-Type: application/jsonBody
[
{
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute values of this mdb item according to the category field"
}
},
"required": [
"title",
"custom_attributes"
]
}
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: ``Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
]
}
}Update ItemPUT/mdb/items/{id}
Update a Labregister item.
Example URI
PUT /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3id of the item to update
Request
Update ItemHeaders
Content-Type: application/jsonBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "ACTIVE"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
],
"additionalProperties": false
}Update Item StatusPATCH/mdb/items/{id}
Update a Labregister item status.
Example URI
PATCH /api/v2/mdb/items/d395ff8e-3430-4cb5-8d34-b0a3399bf6b3
URI Parameters
- id
string(required) Example: d395ff8e-3430-4cb5-8d34-b0a3399bf6b3id of the item to update
Request
Change Item StatusHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/status",
"value": "ACTIVE"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/status"
],
"description": "JSON Pointer notation to the member named status"
},
"value": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "a new status of the item"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"title": "X-Wing Fighter",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"files": [
"703a2010-d061-4166-af22-aedc0e8435b5"
],
"relationships": [
{
"type": "PARENT",
"outward_item_id": "e8292212-2cce-433c-afb9-a39236b5f0ca"
}
],
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"item_code": "LR-20170210-1",
"version_id": "620c535d-45bd-497a-ad92-d0222f959d6b",
"category_version_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"creator_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version": 8,
"version_date": "2017-02-15T12:34:56.789+0200",
"version_author_id": "11040",
"status": "HIDDEN"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category which the item belongs to"
},
"title": {
"type": "string",
"description": "the display title of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"files": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array with the file uuids which are attached to this item"
},
"relationships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARENT",
"CHILD"
],
"description": "the type of the relationship"
},
"outward_item_id": {
"type": "string",
"description": "the stable id of the item"
}
},
"required": [
"type",
"outward_item_id"
]
},
"description": "The array with the relationship definitions of the item"
},
"id": {
"type": "string",
"description": "the stable id of the item"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"category_version_id": {
"type": "string",
"description": "the unique, version id of the category which the item belongs to"
},
"creator_id": {
"type": "string",
"description": "the id of the original author of this item"
},
"creation_date": {
"type": "string",
"description": "the creation date of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"version_date": {
"type": "string",
"description": "the last modification date of the item"
},
"version_author_id": {
"type": "string",
"description": "the id of the user which authored this version of the item"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"DELETED",
"HIDDEN"
],
"description": "indicates whether item is active, hidden or deleted"
}
},
"required": [
"category_id",
"title",
"custom_attributes",
"files",
"relationships",
"id",
"item_code",
"version_id",
"category_version_id",
"creator_id",
"creation_date",
"version",
"version_date",
"version_author_id",
"status"
],
"additionalProperties": false
}Delete ItemDELETE/mdb/items/{id}
Deletes the Item. Note: the entity is not deleted, but its status is changed to ‘DELETED’.
Example URI
DELETE /api/v2/mdb/items/e8292212-2cce-433c-afb9-a39236b5f0ca
URI Parameters
- id
string(required) Example: e8292212-2cce-433c-afb9-a39236b5f0caid of the item
Response
204Search items (Indexed)POST/mdb/search{?group_id,category_id}
Returns all accessible items that match the search query. In case no query is provided all accessible items inside the
group/category are returned.
One of the parameters, group_id or category_id, can be passed to determine the scope of the search.
If no parameters are passed, the search will return all the accessible items that exist in all the groups to which the user is a member.
This endpoint uses elasticsearch to efficiently search between indexed items.
Example URI
POST /api/v2/mdb/search?group_id=&category_id=
URI Parameters
- group_id
string(optional)the group id which based on it search would happen on accessible categories to the user that belong to this group
- category_id
string(optional)the id of category where the search would happen
Request
All Items which belong to accessible categories of group_id and match with the queryHeaders
Content-Type: application/jsonBody
{
"query": "test",
"include_hidden": false,
"pagination": {
"offset": "0",
"limit": "50"
},
"sort": {
"field": "ITEM_TITLE",
"direction": "ASC"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"query": {
"type": [
"string",
"null"
],
"description": "query term"
},
"include_hidden": {
"type": [
"boolean",
"null"
],
"description": "The boolean flag to include hidden items in the search. The default value is false."
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "string"
},
"limit": {
"type": "string"
}
},
"required": [
"offset",
"limit"
],
"additionalProperties": false,
"description": "page information"
},
"sort": {
"type": [
"object",
"null"
],
"properties": {
"field": {
"type": [
"string",
"null"
],
"enum": [
"ITEM_CODE",
"ITEM_TITLE",
"CATEGORY_NAME",
"CREATOR_FULL_NAME",
"LAST_UPDATER_FULL_NAME",
"CREATED_AT",
"LAST_UPDATED_AT",
null
],
"default": "ITEM_TITLE",
"description": "Sort order"
},
"direction": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC",
null
],
"default": "ASC",
"description": "Direction of sort"
}
},
"required": [
"field",
"direction"
],
"additionalProperties": false,
"description": "sort information"
}
},
"required": [
"query",
"include_hidden",
"pagination",
"sort"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"version": 1,
"item_code": "LR-20170801-1",
"item_title": "Lasersword",
"category_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"category_title": "Luke's Private Weapons",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"last_indexed_at": "2021-06-23T11:16:57.789+0200",
"created_at": "2019-02-01T13:34:56.789+0200",
"last_updated_at": "2019-02-01T13:34:56.789+0200",
"creator_id": "11038",
"creator_fullname": "Mr Luke Skywalker",
"last_updater_id": "11039",
"last_updater_fullname": "Ms. Princess Leia"
}
],
"aggregations": {
"category_hits": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": 1
}
},
"page_metadata": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA=",
"total_elements": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"item_title": {
"type": "string",
"description": "the display title of the item"
},
"category_id": {
"type": "string",
"description": "the unique, version id of the category of the item"
},
"category_title": {
"type": "string",
"description": "the display title of the category of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"last_indexed_at": {
"type": "string",
"description": "the creation date of the search index for the item"
},
"created_at": {
"type": "string",
"description": "the timestamp when the index was created"
},
"last_updated_at": {
"type": "string",
"description": "the timestamp when the index was last updated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creator_fullname": {
"type": "string",
"description": "full name of the original author"
},
"last_updater_id": {
"type": "string",
"description": "the user id of the author who updated last"
},
"last_updater_fullname": {
"type": "string",
"description": "the full name of the author who updated last"
}
},
"required": [
"id",
"version_id",
"version",
"item_code",
"item_title",
"category_id",
"category_title",
"custom_attributes",
"last_indexed_at",
"created_at",
"last_updated_at",
"creator_id"
]
}
},
"aggregations": {
"type": "object",
"properties": {
"category_hits": {
"type": "object",
"properties": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": {
"type": [
"number",
"null"
],
"description": "Key-value pair of the category id and its hits count"
}
},
"description": "The category hits count key-value map"
}
},
"required": [
"category_hits"
]
},
"page_metadata": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
},
"total_elements": {
"type": "number",
"description": "number of hits"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id",
"total_elements"
]
}
},
"required": [
"items",
"aggregations",
"page_metadata"
],
"additionalProperties": false
}Request
All Items which belong to passed category_id and match with the queryHeaders
Content-Type: application/jsonBody
{
"query": "test",
"include_hidden": false,
"pagination": {
"offset": "0",
"limit": "50"
},
"sort": {
"field": "ITEM_TITLE",
"direction": "ASC"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"query": {
"type": [
"string",
"null"
],
"description": "query term"
},
"include_hidden": {
"type": [
"boolean",
"null"
],
"description": "The boolean flag to include hidden items in the search. The default value is false."
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "string"
},
"limit": {
"type": "string"
}
},
"required": [
"offset",
"limit"
],
"additionalProperties": false,
"description": "page information"
},
"sort": {
"type": [
"object",
"null"
],
"properties": {
"field": {
"type": [
"string",
"null"
],
"enum": [
"ITEM_CODE",
"ITEM_TITLE",
"CATEGORY_NAME",
"CREATOR_FULL_NAME",
"LAST_UPDATER_FULL_NAME",
"CREATED_AT",
"LAST_UPDATED_AT",
null
],
"default": "ITEM_TITLE",
"description": "Sort order"
},
"direction": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC",
null
],
"default": "ASC",
"description": "Direction of sort"
}
},
"required": [
"field",
"direction"
],
"additionalProperties": false,
"description": "sort information"
}
},
"required": [
"query",
"include_hidden",
"pagination",
"sort"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"version": 1,
"item_code": "LR-20170801-1",
"item_title": "Lasersword",
"category_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"category_title": "Luke's Private Weapons",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"last_indexed_at": "2021-06-23T11:16:57.789+0200",
"created_at": "2019-02-01T13:34:56.789+0200",
"last_updated_at": "2019-02-01T13:34:56.789+0200",
"creator_id": "11038",
"creator_fullname": "Mr Luke Skywalker",
"last_updater_id": "11039",
"last_updater_fullname": "Ms. Princess Leia"
}
],
"aggregations": {
"category_hits": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": 1
}
},
"page_metadata": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA=",
"total_elements": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"item_title": {
"type": "string",
"description": "the display title of the item"
},
"category_id": {
"type": "string",
"description": "the unique, version id of the category of the item"
},
"category_title": {
"type": "string",
"description": "the display title of the category of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"last_indexed_at": {
"type": "string",
"description": "the creation date of the search index for the item"
},
"created_at": {
"type": "string",
"description": "the timestamp when the index was created"
},
"last_updated_at": {
"type": "string",
"description": "the timestamp when the index was last updated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creator_fullname": {
"type": "string",
"description": "full name of the original author"
},
"last_updater_id": {
"type": "string",
"description": "the user id of the author who updated last"
},
"last_updater_fullname": {
"type": "string",
"description": "the full name of the author who updated last"
}
},
"required": [
"id",
"version_id",
"version",
"item_code",
"item_title",
"category_id",
"category_title",
"custom_attributes",
"last_indexed_at",
"created_at",
"last_updated_at",
"creator_id"
]
}
},
"aggregations": {
"type": "object",
"properties": {
"category_hits": {
"type": "object",
"properties": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": {
"type": [
"number",
"null"
],
"description": "Key-value pair of the category id and its hits count"
}
},
"description": "The category hits count key-value map"
}
},
"required": [
"category_hits"
]
},
"page_metadata": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
},
"total_elements": {
"type": "number",
"description": "number of hits"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id",
"total_elements"
]
}
},
"required": [
"items",
"aggregations",
"page_metadata"
],
"additionalProperties": false
}Request
All Items that match the queryHeaders
Content-Type: application/jsonBody
{
"query": "test",
"include_hidden": false,
"pagination": {
"offset": "0",
"limit": "50"
},
"sort": {
"field": "ITEM_TITLE",
"direction": "ASC"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"query": {
"type": [
"string",
"null"
],
"description": "query term"
},
"include_hidden": {
"type": [
"boolean",
"null"
],
"description": "The boolean flag to include hidden items in the search. The default value is false."
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "string"
},
"limit": {
"type": "string"
}
},
"required": [
"offset",
"limit"
],
"additionalProperties": false,
"description": "page information"
},
"sort": {
"type": [
"object",
"null"
],
"properties": {
"field": {
"type": [
"string",
"null"
],
"enum": [
"ITEM_CODE",
"ITEM_TITLE",
"CATEGORY_NAME",
"CREATOR_FULL_NAME",
"LAST_UPDATER_FULL_NAME",
"CREATED_AT",
"LAST_UPDATED_AT",
null
],
"default": "ITEM_TITLE",
"description": "Sort order"
},
"direction": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC",
null
],
"default": "ASC",
"description": "Direction of sort"
}
},
"required": [
"field",
"direction"
],
"additionalProperties": false,
"description": "sort information"
}
},
"required": [
"query",
"include_hidden",
"pagination",
"sort"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"version": 1,
"item_code": "LR-20170801-1",
"item_title": "Lasersword",
"category_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"category_title": "Luke's Private Weapons",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"last_indexed_at": "2021-06-23T11:16:57.789+0200",
"created_at": "2019-02-01T13:34:56.789+0200",
"last_updated_at": "2019-02-01T13:34:56.789+0200",
"creator_id": "11038",
"creator_fullname": "Mr Luke Skywalker",
"last_updater_id": "11039",
"last_updater_fullname": "Ms. Princess Leia"
}
],
"aggregations": {
"category_hits": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": 1
}
},
"page_metadata": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA=",
"total_elements": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"item_title": {
"type": "string",
"description": "the display title of the item"
},
"category_id": {
"type": "string",
"description": "the unique, version id of the category of the item"
},
"category_title": {
"type": "string",
"description": "the display title of the category of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"last_indexed_at": {
"type": "string",
"description": "the creation date of the search index for the item"
},
"created_at": {
"type": "string",
"description": "the timestamp when the index was created"
},
"last_updated_at": {
"type": "string",
"description": "the timestamp when the index was last updated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creator_fullname": {
"type": "string",
"description": "full name of the original author"
},
"last_updater_id": {
"type": "string",
"description": "the user id of the author who updated last"
},
"last_updater_fullname": {
"type": "string",
"description": "the full name of the author who updated last"
}
},
"required": [
"id",
"version_id",
"version",
"item_code",
"item_title",
"category_id",
"category_title",
"custom_attributes",
"last_indexed_at",
"created_at",
"last_updated_at",
"creator_id"
]
}
},
"aggregations": {
"type": "object",
"properties": {
"category_hits": {
"type": "object",
"properties": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": {
"type": [
"number",
"null"
],
"description": "Key-value pair of the category id and its hits count"
}
},
"description": "The category hits count key-value map"
}
},
"required": [
"category_hits"
]
},
"page_metadata": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
},
"total_elements": {
"type": "number",
"description": "number of hits"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id",
"total_elements"
]
}
},
"required": [
"items",
"aggregations",
"page_metadata"
],
"additionalProperties": false
}Advanced Search items (Indexed)POST/mdb/search/advanced{?group_id,category_id}
Returns all accessible items that match the search query. In case no query is provided all accessible items inside the
group/category are returned.
One of the parameters, group_id or category_id, must be passed to determine the scope of the search.
This endpoint uses elasticsearch to efficiently search between indexed items.
Example URI
POST /api/v2/mdb/search/advanced?group_id=&category_id=
URI Parameters
- group_id
string(optional)the group id which based on it search would happen on accessible categories to the user that belong to this group
- category_id
string(optional)the id of category where the search would happen
Request
All Items which belong to accessible categories of group_id and match with the query; ?group_id=1200Headers
Content-Type: application/jsonBody
{
"statuses": [
"ACTIVE"
],
"pagination": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA="
},
"sort": {
"field": "ITEM_TITLE",
"direction": "ASC"
},
"query": [
{
"logical_operator": "null",
"terms": [
{
"logical_operator": "AND",
"criteria": "ITEM_TITLE",
"comparator": "CONTAINS",
"filter_options": null,
"value": "test"
},
{
"logical_operator": "OR",
"criteria": "ATTRIBUTE_NUMBER",
"comparator": "RANGE",
"filter_options": {
"ATTRIBUTE_ID": "149376e1-d524-487a-9c79-5c19712da628"
},
"min": "1",
"max": "10"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACTIVE",
"HIDDEN"
]
},
"description": "the item statuses that should be included on the search result"
},
"pagination": {
"type": [
"object",
"null"
],
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id"
],
"additionalProperties": false,
"description": "page information"
},
"sort": {
"type": [
"object",
"null"
],
"properties": {
"field": {
"type": [
"string",
"null"
],
"enum": [
"ITEM_CODE",
"ITEM_TITLE",
"CATEGORY_NAME",
"CREATOR_FULL_NAME",
"LAST_UPDATER_FULL_NAME",
"CREATED_AT",
"LAST_UPDATED_AT",
null
],
"default": "ITEM_TITLE",
"description": "Sort order"
},
"direction": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC",
null
],
"default": "ASC",
"description": "Direction of sort"
}
},
"required": [
"field",
"direction"
],
"additionalProperties": false,
"description": "sort information"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"logical_operator": {
"type": [
"string",
"null"
],
"enum": [
"AND",
"OR",
"null",
null
],
"description": "search operator; For the first one in a list it can be null. Otherwise, will be ignored."
},
"terms": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"logical_operator": {
"type": [
"string",
"null"
],
"enum": [
"AND",
"OR",
null
],
"description": "search operator; For the first one in a list it can be null. Otherwise, will be ignored."
},
"criteria": {
"type": "string",
"description": "the search criteria"
},
"comparator": {
"type": "string",
"description": "search comparator"
},
"filter_options": {
"type": [
"object",
"null"
],
"properties": {},
"additionalProperties": false,
"description": "can contain additional search filter options, like attribute ID, file type, etc.."
},
"value": {
"type": "string",
"description": "query term"
}
},
"required": [
"logical_operator",
"criteria",
"comparator",
"filter_options",
"value"
]
},
{
"type": "object",
"properties": {
"logical_operator": {
"type": [
"string",
"null"
],
"description": "search operator; For the first one in a list it can be null. Otherwise, will be ignored."
},
"criteria": {
"type": "string",
"description": "the search criteria"
},
"comparator": {
"type": "string",
"description": "search comparator"
},
"filter_options": {
"type": [
"object",
"null"
],
"properties": {
"ATTRIBUTE_ID": {
"type": "string"
}
},
"required": [
"ATTRIBUTE_ID"
],
"additionalProperties": false,
"description": "can contain additional search filter options, like attribute ID, file type, etc.."
},
"min": {
"type": "string",
"description": "min value of the range"
},
"max": {
"type": "string",
"description": "max value of the range"
}
},
"required": [
"logical_operator",
"criteria",
"comparator",
"filter_options",
"min",
"max"
]
}
],
"description": "search terms"
}
},
"required": [
"logical_operator",
"terms"
]
},
"description": "search queries"
}
},
"required": [
"statuses",
"pagination",
"sort",
"query"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"version": 1,
"item_code": "LR-20170801-1",
"item_title": "Lasersword",
"category_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"category_title": "Luke's Private Weapons",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"last_indexed_at": "2021-06-23T11:16:57.789+0200",
"created_at": "2019-02-01T13:34:56.789+0200",
"last_updated_at": "2019-02-01T13:34:56.789+0200",
"creator_id": "11038",
"creator_fullname": "Mr Luke Skywalker",
"last_updater_id": "11039",
"last_updater_fullname": "Ms. Princess Leia"
}
],
"aggregations": {
"category_hits": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": 1
}
},
"page_metadata": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA=",
"total_elements": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"item_title": {
"type": "string",
"description": "the display title of the item"
},
"category_id": {
"type": "string",
"description": "the unique, version id of the category of the item"
},
"category_title": {
"type": "string",
"description": "the display title of the category of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"last_indexed_at": {
"type": "string",
"description": "the creation date of the search index for the item"
},
"created_at": {
"type": "string",
"description": "the timestamp when the index was created"
},
"last_updated_at": {
"type": "string",
"description": "the timestamp when the index was last updated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creator_fullname": {
"type": "string",
"description": "full name of the original author"
},
"last_updater_id": {
"type": "string",
"description": "the user id of the author who updated last"
},
"last_updater_fullname": {
"type": "string",
"description": "the full name of the author who updated last"
}
},
"required": [
"id",
"version_id",
"version",
"item_code",
"item_title",
"category_id",
"category_title",
"custom_attributes",
"last_indexed_at",
"created_at",
"last_updated_at",
"creator_id"
]
}
},
"aggregations": {
"type": "object",
"properties": {
"category_hits": {
"type": "object",
"properties": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": {
"type": [
"number",
"null"
],
"description": "Key-value pair of the category id and its hits count"
}
},
"description": "The category hits count key-value map"
}
},
"required": [
"category_hits"
]
},
"page_metadata": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
},
"total_elements": {
"type": "number",
"description": "number of hits"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id",
"total_elements"
]
}
},
"required": [
"items",
"aggregations",
"page_metadata"
],
"additionalProperties": false
}Request
All Items which belong to passed category_id and match with the query; ?category_id=e87e6534-2ae0-4139-bc48-cc668f330069Headers
Content-Type: application/jsonBody
{
"statuses": [
"ACTIVE"
],
"pagination": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA="
},
"sort": {
"field": "ITEM_TITLE",
"direction": "ASC"
},
"query": [
{
"logical_operator": "null",
"terms": [
{
"logical_operator": "AND",
"criteria": "ITEM_TITLE",
"comparator": "CONTAINS",
"filter_options": null,
"value": "test"
},
{
"logical_operator": "OR",
"criteria": "ATTRIBUTE_NUMBER",
"comparator": "RANGE",
"filter_options": {
"ATTRIBUTE_ID": "149376e1-d524-487a-9c79-5c19712da628"
},
"min": "1",
"max": "10"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ACTIVE",
"HIDDEN"
]
},
"description": "the item statuses that should be included on the search result"
},
"pagination": {
"type": [
"object",
"null"
],
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id"
],
"additionalProperties": false,
"description": "page information"
},
"sort": {
"type": [
"object",
"null"
],
"properties": {
"field": {
"type": [
"string",
"null"
],
"enum": [
"ITEM_CODE",
"ITEM_TITLE",
"CATEGORY_NAME",
"CREATOR_FULL_NAME",
"LAST_UPDATER_FULL_NAME",
"CREATED_AT",
"LAST_UPDATED_AT",
null
],
"default": "ITEM_TITLE",
"description": "Sort order"
},
"direction": {
"type": [
"string",
"null"
],
"enum": [
"ASC",
"DESC",
null
],
"default": "ASC",
"description": "Direction of sort"
}
},
"required": [
"field",
"direction"
],
"additionalProperties": false,
"description": "sort information"
},
"query": {
"type": "array",
"items": {
"type": "object",
"properties": {
"logical_operator": {
"type": [
"string",
"null"
],
"enum": [
"AND",
"OR",
"null",
null
],
"description": "search operator; For the first one in a list it can be null. Otherwise, will be ignored."
},
"terms": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"logical_operator": {
"type": [
"string",
"null"
],
"enum": [
"AND",
"OR",
null
],
"description": "search operator; For the first one in a list it can be null. Otherwise, will be ignored."
},
"criteria": {
"type": "string",
"description": "the search criteria"
},
"comparator": {
"type": "string",
"description": "search comparator"
},
"filter_options": {
"type": [
"object",
"null"
],
"properties": {},
"additionalProperties": false,
"description": "can contain additional search filter options, like attribute ID, file type, etc.."
},
"value": {
"type": "string",
"description": "query term"
}
},
"required": [
"logical_operator",
"criteria",
"comparator",
"filter_options",
"value"
]
},
{
"type": "object",
"properties": {
"logical_operator": {
"type": [
"string",
"null"
],
"description": "search operator; For the first one in a list it can be null. Otherwise, will be ignored."
},
"criteria": {
"type": "string",
"description": "the search criteria"
},
"comparator": {
"type": "string",
"description": "search comparator"
},
"filter_options": {
"type": [
"object",
"null"
],
"properties": {
"ATTRIBUTE_ID": {
"type": "string"
}
},
"required": [
"ATTRIBUTE_ID"
],
"additionalProperties": false,
"description": "can contain additional search filter options, like attribute ID, file type, etc.."
},
"min": {
"type": "string",
"description": "min value of the range"
},
"max": {
"type": "string",
"description": "max value of the range"
}
},
"required": [
"logical_operator",
"criteria",
"comparator",
"filter_options",
"min",
"max"
]
}
],
"description": "search terms"
}
},
"required": [
"logical_operator",
"terms"
]
},
"description": "search queries"
}
},
"required": [
"statuses",
"pagination",
"sort",
"query"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"items": [
{
"id": "d395ff8e-3430-4cb5-8d34-b0a3399bf6b3",
"version_id": "2493713e-9316-47b5-b9c8-c83332bdee30",
"version": 1,
"item_code": "LR-20170801-1",
"item_title": "Lasersword",
"category_id": "1095e78f-9fba-4e8f-a224-b5f83f617809",
"category_title": "Luke's Private Weapons",
"custom_attributes": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": "1001",
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": "Available"
},
"last_indexed_at": "2021-06-23T11:16:57.789+0200",
"created_at": "2019-02-01T13:34:56.789+0200",
"last_updated_at": "2019-02-01T13:34:56.789+0200",
"creator_id": "11038",
"creator_fullname": "Mr Luke Skywalker",
"last_updater_id": "11039",
"last_updater_fullname": "Ms. Princess Leia"
}
],
"aggregations": {
"category_hits": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": 1
}
},
"page_metadata": {
"offset": 0,
"limit": 50,
"sort_values": [
"1656505618000"
],
"point_in_time_id": "z4S1AwEQbGFicmVnaXN0ZXJfaXRlbRYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnABZ6QjctdmI0YVItLXo5ei1QZm1OVjZnAAAAAAAAAAAuFmJWNFpLcnZhUUt1N3NtdVAzS0RBZ0EAARYtTjE4bHY1Q1NLNnRuaG5EQkhHLUJnAAA=",
"total_elements": 1
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the stable id of the item"
},
"version_id": {
"type": "string",
"description": "the unique, version id of the item"
},
"version": {
"type": "number",
"description": "the version number (it is automatically incremented for each modification on the item)"
},
"item_code": {
"type": "string",
"description": "server-based unique code to identify item in a user-friendly way"
},
"item_title": {
"type": "string",
"description": "the display title of the item"
},
"category_id": {
"type": "string",
"description": "the unique, version id of the category of the item"
},
"category_title": {
"type": "string",
"description": "the display title of the category of the item"
},
"custom_attributes": {
"type": "object",
"properties": {
"0553c003-9014-47ef-9522-115ad7d4b3a1": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
},
"f94bb81d-ad1d-4301-9f18-a9bf408b4e65": {
"type": [
"string",
"null"
],
"description": "Key-value pair of the attribute id and its associated value"
}
},
"description": "The attribute key-value map of this item based on its category attributes"
},
"last_indexed_at": {
"type": "string",
"description": "the creation date of the search index for the item"
},
"created_at": {
"type": "string",
"description": "the timestamp when the index was created"
},
"last_updated_at": {
"type": "string",
"description": "the timestamp when the index was last updated"
},
"creator_id": {
"type": "string",
"description": "the user id of the original author"
},
"creator_fullname": {
"type": "string",
"description": "full name of the original author"
},
"last_updater_id": {
"type": "string",
"description": "the user id of the author who updated last"
},
"last_updater_fullname": {
"type": "string",
"description": "the full name of the author who updated last"
}
},
"required": [
"id",
"version_id",
"version",
"item_code",
"item_title",
"category_id",
"category_title",
"custom_attributes",
"last_indexed_at",
"created_at",
"last_updated_at",
"creator_id"
]
}
},
"aggregations": {
"type": "object",
"properties": {
"category_hits": {
"type": "object",
"properties": {
"1095e78f-9fba-4e8f-a224-b5f83f617809": {
"type": [
"number",
"null"
],
"description": "Key-value pair of the category id and its hits count"
}
},
"description": "The category hits count key-value map"
}
},
"required": [
"category_hits"
]
},
"page_metadata": {
"type": "object",
"properties": {
"offset": {
"type": "number",
"description": "Start index of the desired results",
"default": 0
},
"limit": {
"type": "number",
"description": "Number of rows the result should return",
"default": 50
},
"sort_values": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "sort values from the previous page"
},
"point_in_time_id": {
"type": [
"string",
"null"
],
"description": "a point in time (PIT) base64 String to preserve the current index state over your searches"
},
"total_elements": {
"type": "number",
"description": "number of hits"
}
},
"required": [
"offset",
"limit",
"sort_values",
"point_in_time_id",
"total_elements"
]
}
},
"required": [
"items",
"aggregations",
"page_metadata"
],
"additionalProperties": false
}Permissions ¶
There are 4 different roles structured in a hierarchical way which can be assigned to users in the scope of a category:
-
CATEGORY_ADMIN (Owner) - Can update category attributes and permissions of the category in addition to “Editor” role capabilities
-
CATEGORY_EDITOR (Manager) - Can update category attributes in addition to “Manager” role capabilities
-
ITEM_EDITOR (Editor) - Can create/edit/delete items in the category in addition to “Viewer” role capabilities
-
CATEGORY_READER (Viewer) - Has only read access to the category and its items
Create PermissionPOST/mdb/permissions
Set role for a user, group or subgroup in the scope of a category. User, group and subgroup id fields have XOR relation between them which means only one of them can be passed in a request. Only group categories can be shared through permissions.
Note: A user/group/subgroup can only have one role in the scope of a single category.
Example URI
POST /api/v2/mdb/permissions
Request
Create PermissionHeaders
Content-Type: application/jsonBody
{
"user_id": "11040",
"group_id": "Hello, world!",
"subgroup_id": "Hello, world!",
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"role": "CATEGORY_ADMIN"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user_id": {
"type": [
"string",
"null"
],
"description": "the user id for the role assignment"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the group id for the role assignment"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the subgroup id for the role assignment"
},
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"role": {
"type": "string",
"enum": [
"CATEGORY_ADMIN",
"CATEGORY_EDITOR",
"ITEM_EDITOR",
"CATEGORY_READER"
]
}
},
"required": [
"category_id",
"role"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/permissions/5d69be48-6a11-4195-a25a-edce9973e291Body
{
"user_id": "11040",
"group_id": "Hello, world!",
"subgroup_id": "Hello, world!",
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"role": "CATEGORY_ADMIN",
"id": "5d69be48-6a11-4195-a25a-edce9973e291",
"creation_date": "2020-01-01T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user_id": {
"type": [
"string",
"null"
],
"description": "the user id for the role assignment"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the group id for the role assignment"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the subgroup id for the role assignment"
},
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"role": {
"type": "string",
"enum": [
"CATEGORY_ADMIN",
"CATEGORY_EDITOR",
"ITEM_EDITOR",
"CATEGORY_READER"
]
},
"id": {
"type": "string",
"description": "the unique id of the permission"
},
"creation_date": {
"type": "string",
"description": "the creation date of the mdb permission object"
}
},
"required": [
"category_id",
"role",
"id",
"creation_date"
],
"additionalProperties": false
}Delete PermissionDELETE/mdb/permissions/{id}
Deletes the Permission. Note: Each category must have at least one manager role assigned to them.
Example URI
DELETE /api/v2/mdb/permissions/49056fab-03ce-4835-8ad4-dbe3074c9323
URI Parameters
- id
string(required) Example: 49056fab-03ce-4835-8ad4-dbe3074c9323id of the permission to delete
Response
204Get Permissions By Category IdGET/mdb/permissions{?category_id,expand}
Returns the list of all role assignments of a category.
Example URI
GET /api/v2/mdb/permissions?category_id=b10b785d-d87d-48cf-9c0b-d7be08f377b2&expand=user
URI Parameters
- category_id
string(required) Example: b10b785d-d87d-48cf-9c0b-d7be08f377b2The category id to show permissions for.
- expand
string(optional) Example: userA comma separated list of related domain objects that should be expanded for all items returned
Choices:
user,group,subgroup
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"user_id": "11040",
"group_id": "Hello, world!",
"subgroup_id": "Hello, world!",
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"role": "CATEGORY_ADMIN",
"id": "5d69be48-6a11-4195-a25a-edce9973e291",
"creation_date": "2020-01-01T12:34:56.789+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"user_id": {
"type": [
"string",
"null"
],
"description": "the user id for the role assignment"
},
"group_id": {
"type": [
"string",
"null"
],
"description": "the group id for the role assignment"
},
"subgroup_id": {
"type": [
"string",
"null"
],
"description": "the subgroup id for the role assignment"
},
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"role": {
"type": "string",
"enum": [
"CATEGORY_ADMIN",
"CATEGORY_EDITOR",
"ITEM_EDITOR",
"CATEGORY_READER"
]
},
"id": {
"type": "string",
"description": "the unique id of the permission"
},
"creation_date": {
"type": "string",
"description": "the creation date of the mdb permission object"
}
},
"required": [
"category_id",
"role",
"id",
"creation_date"
]
}
}Get User's Rights on a CategoryGET/mdb/rights{?category_id}
Returns the list of rights of the requesting user on the specified category. It’s simply a list enum strings.
Example URI
GET /api/v2/mdb/rights?category_id=b10b785d-d87d-48cf-9c0b-d7be08f377b2
URI Parameters
- category_id
string(required) Example: b10b785d-d87d-48cf-9c0b-d7be08f377b2The category id to show rights for.
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
"GET_ITEM"
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "string",
"enum": [
"GET_ITEM",
"GET_CATEGORY",
"GET_PERMISSION",
"CREATE_ITEM",
"UPDATE_ITEM",
"HIDE_ITEM",
"RESTORE_ITEM",
"DELETE_ITEM",
"CREATE_CATEGORY",
"UPDATE_CATEGORY",
"DELETE_CATEGORY",
"HIDE_CATEGORY",
"RESTORE_CATEGORY",
"CREATE_PERMISSION",
"DELETE_PERMISSION",
"CREATE_IMPORT",
"CREATE_EXPORT"
]
}
}Import ¶
Import Items into CategoryPOST/mdb/imports
Creates an import request by uploading excel file.
Example URI
POST /api/v2/mdb/imports
Request
Import Items into CategoryHeaders
Content-Type: multipart/form-data; boundary=--BOUNDARYBody
----BOUNDARY
Content-Disposition: form-data; name="category_id"
e87e6534-2ae0-4139-bc48-cc668f330069
----BOUNDARY
Content-Disposition: form-data; name="file"; filename="file.xlsx"
Content-Transfer-Encoding: base64
[excel file content comes here]
----BOUNDARY
Content-Disposition: form-data; name="worksheet_index"
0
----BOUNDARY
Content-Disposition: form-data; name="attribute_to_column_map"
Name:0,attr-1-id:2,attr-2-id:1,attr-3-id:3
----BOUNDARY--Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/imports/20e699a3-4764-461f-a4bc-d10d7cbba3f0Body
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"status": "NEW",
"creation_date": "2019-02-01T13:34:56.789+0200",
"completion_date": "2019-02-01T13:35:30.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the import request"
},
"user_id": {
"type": "string",
"description": "the id of the user, who created the import request"
},
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the import request"
},
"creation_date": {
"type": "string",
"description": "the date when the import request was made"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "the date when the imported file process was completed"
}
},
"required": [
"id",
"user_id",
"category_id",
"status",
"creation_date",
"completion_date"
],
"additionalProperties": false
}List MDB ImportsGET/mdb/imports{?category_id,status}
Gets the list of MDB import summary
Example URI
GET /api/v2/mdb/imports?category_id=e87e6534-2ae0-4139-bc48-cc668f330069&status=NEW
URI Parameters
- category_id
string(required) Example: e87e6534-2ae0-4139-bc48-cc668f330069The category id to get MDB imports for.
- status
string(optional) Example: NEWThe imported data status.
Choices:
NEWRUNNINGFINISHEDREMOVEDERRORQUEUEDABORT_PARALLEL
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "20e699a3-4764-461f-a4bc-d10d7cbba3f0",
"user_id": "11038",
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"status": "NEW",
"creation_date": "2019-02-01T13:34:56.789+0200",
"completion_date": "2019-02-01T13:35:30.789+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the import request"
},
"user_id": {
"type": "string",
"description": "the id of the user, who created the import request"
},
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"status": {
"type": "string",
"enum": [
"NEW",
"RUNNING",
"FINISHED",
"REMOVED",
"ERROR",
"QUEUED",
"ABORT_PARALLEL"
],
"description": "the status of the import request"
},
"creation_date": {
"type": "string",
"description": "the date when the import request was made"
},
"completion_date": {
"type": [
"string",
"null"
],
"description": "the date when the imported file process was completed"
}
},
"required": [
"id",
"user_id",
"category_id",
"status",
"creation_date",
"completion_date"
]
}
}Export ¶
Export Category ItemsPOST/mdb/exports
Creates an export request for the specified category and returns the items as excel (xlsx) file.
Example URI
POST /api/v2/mdb/exports
Request
Export Category ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
}
},
"required": [
"category_id"
]
}Response
200Headers
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Disposition: `attachment;filename="export.xlsx"`Barcodes ¶
Get Barcode Image in Code 128 FormatGET/mdb/barcodes/code-128{?value,size}
Returns the image representation of the value passed in Code 128 Format. The image returned is in PNG format.
Example URI
GET /api/v2/mdb/barcodes/code-128?value=LR-20210303-1&size=MEDIUM
URI Parameters
- value
string(required) Example: LR-20210303-1The value which the barcode image should represent
- size
enum(optional) Example: MEDIUMThe desired size of the barcode image. If size is not passed, the default will be
MEDIUM-
SMALL -
MEDIUM -
LARGE
-
Response
200Headers
Content-Type: image/pngBody
... barcode image content as binary ...Get Barcode Image in Data Matrix FormatGET/mdb/barcodes/data-matrix{?value,size}
Returns the image representation of the value passed in Data Matrix Format. The image returned is in PNG format.
Example URI
GET /api/v2/mdb/barcodes/data-matrix?value=LR-20210303-1&size=MEDIUM
URI Parameters
- value
string(required) Example: LR-20210303-1The value which the barcode image should represent
- size
enum(optional) Example: MEDIUMThe desired size of the barcode image. If size is not passed, the default will be
MEDIUM-
SMALL -
MEDIUM -
LARGE
-
Response
200Headers
Content-Type: image/pngBody
... barcode image content as binary ...Files ¶
The following steps outline how to upload and retrieve files:
Uploading a file
To upload a file, follow these steps:
-
Generate a pre-signed URL for uploading the file by calling /presigned/upload.
-
Use the pre-signed URL to upload the file to S3.
-
Send a POST request to /mdb/files to register the uploaded file with a key. Make sure to include the file key in the request.
Retrieving a file
To retrieve a file, follow the step:
-
Generate a pre-signed URL for downloading the file by calling /presigned/download.
-
The pre-signed url will automatically redirect to the file content.
Upload FilePOST/mdb/files
Send the raw binary content of the file as the request body using the appropriate (matching) Content-Type header.
Example URI
POST /api/v2/mdb/files
Request
Upload FileHeaders
Content-Type: multipart/form-data; boundary=--BOUNDARYBody
----BOUNDARY
Content-Disposition: form-data; name="file"; filename="results.docx"
Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
Content-Transfer-Encoding: base64
Content-Length: 14020
Hello World!!!!
----BOUNDARY--Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/files/42f87689-4685-4949-ae09-b0c7c1f7ac59Body
{
"id": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"author_id": "11038",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"upload_date": "2019-02-01T13:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the file"
},
"author_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"upload_date": {
"type": "string",
"description": "the timestamp when the upload is completed"
}
},
"required": [
"id",
"author_id",
"file_name",
"file_size",
"content_type",
"upload_date"
],
"additionalProperties": false
}Request
Upload File With KeyHeaders
Content-Type: multipart/form-data; boundary=--BOUNDARYBody
----BOUNDARY
Content-Disposition: form-data; name="file"; filename="results.docx"
Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
Content-Transfer-Encoding: base64
Content-Length: 14020
Hello World!!!!
----BOUNDARY
Content-Disposition: form-data; name="fileKey"
acfa5ad9-83cd-405f-b3e5-e3b50d61f26e
----BOUNDARY--Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/files/42f87689-4685-4949-ae09-b0c7c1f7ac59Body
{
"id": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"author_id": "11038",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"upload_date": "2019-02-01T13:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the file"
},
"author_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"upload_date": {
"type": "string",
"description": "the timestamp when the upload is completed"
}
},
"required": [
"id",
"author_id",
"file_name",
"file_size",
"content_type",
"upload_date"
],
"additionalProperties": false
}Get File MetaDataGET/mdb/files/{id}
Returns the metadata for the Labregister file
Example URI
GET /api/v2/mdb/files/703a2010-d061-4166-af22-aedc0e8435b5
URI Parameters
- id
string(required) Example: 703a2010-d061-4166-af22-aedc0e8435b5id of file
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"id": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"author_id": "11038",
"file_name": "results.docx",
"file_size": 14020,
"content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"upload_date": "2019-02-01T13:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the unique id of the file"
},
"author_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "The name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"upload_date": {
"type": "string",
"description": "the timestamp when the upload is completed"
}
},
"required": [
"id",
"author_id",
"file_name",
"file_size",
"content_type",
"upload_date"
],
"additionalProperties": false
}Get FileGET/mdb/files/{id}/data
Returns the data for the Labregister file
Example URI
GET /api/v2/mdb/files/703a2010-d061-4166-af22-aedc0e8435b5/data
URI Parameters
- id
string(required) Example: 703a2010-d061-4166-af22-aedc0e8435b5id of file
Response
200Headers
Content-Type: text
Content-Disposition: `attachment;filename="text-file.txt"`Delete FileDELETE/mdb/files/{id}
Deletes the file by its ID when the file is not attached to any item versions. Returns 422 when file is attached or current user is not the file owner and 404 if file does not exists.
Example URI
DELETE /api/v2/mdb/files/39694cef-5e98-4660-b28d-35373e12bc2c
URI Parameters
- id
string(required) Example: 39694cef-5e98-4660-b28d-35373e12bc2cid of file
Response
204Bulk Actions ¶
Bulk ActionPOST/mdb/bulk-actions
Perform bulk action on resource for the selected ids, action specific fields are passed through settings field Settings based on action and resource:
-
update items: attribute_id (required), value (optional) null if not passed
-
duplicate items: duplication_count (optional) 1 if not passed
-
duplicate categories: category_title (optional) existing category title + suffix (1) if not passed , include_items (optional) false if not passed
Example URI
POST /api/v2/mdb/bulk-actions
Request
Bulk ActionHeaders
Content-Type: application/jsonBody
{
"category_id": "cb80222b-3a22-4cb9-b5de-52fce39d0262",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"duplication_count": "4"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DUPLICATE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"duplication_count": {
"type": "string",
"description": "the duplication count between 1 and 100"
}
},
"description": "this field contains duplication count"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"creator_id": "11038",
"completed_at": "2021-09-20T12:50:13.930+0200",
"result": [
"d5fcacf9-dfbd-4085-9218-9f0f9c58a310"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"creator_id": {
"type": "string",
"description": "the id of the user who performed the bulk action"
},
"completed_at": {
"type": "string",
"description": "the bulk action date"
},
"result": {
"type": "array",
"items": {
"type": "string"
},
"description": "The string array of resource ids: for duplicate action the created resource ids will be returned"
}
},
"required": [
"creator_id",
"completed_at",
"result"
],
"additionalProperties": false
}Create Async Bulk ActionPOST/mdb/bulk-actions-async
Submit bulk action on resource for the selected ids, actions will be performed asynchronously
Settings based on action and resource:
-
update items: attribute_id (required), value (optional) null if not passed
-
duplicate items: duplication_count (optional) 1 if not passed
Example URI
POST /api/v2/mdb/bulk-actions-async
Request
Bulk Delete ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DELETE",
"resource_ids": [
"d395ff8e-3430-4cb5-8d34-b0a3399bf6b3"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/bulk-actions-async/00a59361-ee18-41ed-89f8-be3bd026e9eaBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Request
Bulk Update ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "73e84ca0-7efe-4db0-966a-d52438cd9003",
"resource": "/items",
"type": "UPDATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"attribute_id": "149376e1-d524-487a-9c79-5c19712da628",
"value": "2021"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"UPDATE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"attribute_id": {
"type": "string",
"description": "attribute id"
},
"value": {
"type": [
"string",
"null"
],
"description": "new value"
}
},
"required": [
"attribute_id",
"value"
],
"description": "this field contains attribute id and value for update"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"settings"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/bulk-actions-async/00a59361-ee18-41ed-89f8-be3bd026e9eaBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "UPDATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"attribute_id": "149376e1-d524-487a-9c79-5c19712da628",
"value": "2021"
},
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"UPDATE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"attribute_id": {
"type": "string",
"description": "attribute id"
},
"value": {
"type": [
"string",
"null"
],
"description": "new value"
}
},
"required": [
"attribute_id",
"value"
],
"description": "this field contains attribute id and value for update"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"settings",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Request
Bulk Duplicate ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "cb80222b-3a22-4cb9-b5de-52fce39d0262",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"duplication_count": "4"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DUPLICATE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"duplication_count": {
"type": "string",
"description": "the duplication count between 1 and 100"
}
},
"description": "this field contains duplication count"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/bulk-actions-async/00a59361-ee18-41ed-89f8-be3bd026e9eaBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"duplication_count": "4"
},
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DUPLICATE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"duplication_count": {
"type": "string",
"description": "the duplication count between 1 and 100"
}
},
"description": "this field contains duplication count"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Request
Bulk Hide ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "bc412c4e-19ac-4a9e-b3c4-177ffcff6aba",
"resource": "/items",
"type": "HIDE",
"resource_ids": [
"e9ffced0-4acc-43cf-9728-e70bee0bda93"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"HIDE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/bulk-actions-async/00a59361-ee18-41ed-89f8-be3bd026e9eaBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "HIDE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"HIDE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Request
Bulk Restore ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "6ede0f4b-7f78-407e-8347-3f7ed1b89af5",
"resource": "/items",
"type": "RESTORE",
"resource_ids": [
"552d20ac-ba44-4564-8048-73886de6cc5d"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"RESTORE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/bulk-actions-async/00a59361-ee18-41ed-89f8-be3bd026e9eaBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "RESTORE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"RESTORE"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Request
Bulk Export ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "bc412c4e-19ac-4a9e-b3c4-177ffcff6aba",
"resource": "/items",
"type": "EXPORT",
"resource_ids": [
"e9ffced0-4acc-43cf-9728-e70bee0bda93"
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"EXPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /mdb/bulk-actions-async/00a59361-ee18-41ed-89f8-be3bd026e9eaBody
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "EXPORT",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"EXPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Request
Bulk Import ItemsHeaders
Content-Type: application/jsonBody
{
"category_id": "87a39a96-2474-4de5-a359-9a65388c1e76",
"resource": "/items",
"type": "IMPORT",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"file_id": "39694cef-5e98-4660-b28d-35373e12bc2c",
"import_config": "{\"worksheet_index\":\"0\",\"attribute_to_column_map\":{\"Name\":\"0\"}}"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"file_id": {
"type": "string",
"description": "the file id that has been uploaded for import"
},
"import_config": {
"type": "string",
"description": "the import file config, which contains the index of the worksheet to import data from and a map of attribute names to their corresponding column indexes in the imported data"
}
},
"required": [
"import_config"
],
"description": "this field contains additional settings for bulk actions"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "IMPORT",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"settings": {
"file_id": "39694cef-5e98-4660-b28d-35373e12bc2c",
"import_config": "{\"worksheet_index\":\"0\",\"attribute_to_column_map\":{\"Name\":\"0\"}}"
},
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {
"file_id": {
"type": "string",
"description": "the file id that has been uploaded for import"
},
"import_config": {
"type": "string",
"description": "the import file config, which contains the index of the worksheet to import data from and a map of attribute names to their corresponding column indexes in the imported data"
}
},
"required": [
"import_config"
],
"description": "this field contains duplication count"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Get Async Bulk Action InformationGET/mdb/bulk-actions-async/{id}
Returns the bulk action information
Example URI
GET /api/v2/mdb/bulk-actions-async/ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad
URI Parameters
- id
string(required) Example: ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfadid of bulk action
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}List Async Bulk Actions InformationGET/mdb/bulk-actions-async{?category_id,status,group_id,age}
Returns the list of all bulk actions on accessible categories, following filters can be applied (category_id, status).
Example URI
GET /api/v2/mdb/bulk-actions-async?category_id=&status=&group_id=&age=
URI Parameters
- category_id
string(optional)stable category id
- status
enum(optional)bulk action status
-
PROCESSING
-
FINISHED
-
CANCELED
-
ERROR
-
ABORTED
-
- group_id
string(optional)Only return the bulk actions performed on all categories that belong to the specified group
- age
number(optional)Only return bulk actions that have a certain age, have been created at X minutes ago
Request
Get All Bulk Actions filtered by category idResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
]
}
}Request
Get All Bulk Actions filtered by statusResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
]
}
}Request
Get All Bulk Actions filtered by status and category idResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
]
}
}Request
Get All Bulk Actions filtered by group id and ageResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"category_id": "e87e6534-2ae0-4139-bc48-cc668f330069",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "PROCESSING",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "ef30180a-b6d6-4afe-b2c7-ba5f4ef9bfad",
"progress_percentage": 0
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"PROCESSING",
"FINISHED",
"CANCELED",
"ERROR",
"ABORTED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
]
}
}Cancel Async Bulk ActionPATCH/mdb/bulk-actions-async/{id}
Cancel unfinished submitted async bulk action
Example URI
PATCH /api/v2/mdb/bulk-actions-async/694de4a0-45e9-4611-bfc2-1f82add30006
URI Parameters
- id
string(required) Example: 694de4a0-45e9-4611-bfc2-1f82add30006id of bulk action
Request
Change Bulk Action Status to CancelHeaders
Content-Type: application/json-patch+jsonBody
[
{
"op": "replace",
"path": "/status",
"value": "CANCELED"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
],
"description": "The replace operation defined by RFC 6902"
},
"path": {
"type": "string",
"enum": [
"/status"
],
"description": "JSON Pointer notation to the member named status"
},
"value": {
"type": "string",
"description": "a new status for the bulk action"
}
},
"required": [
"op",
"path",
"value"
]
}
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"category_id": "74f20f3f-fb25-4d9e-ad16-e824852c7aec",
"resource": "/items",
"type": "DUPLICATE",
"resource_ids": [
"8030deb3-f3e3-48e6-a33e-a0c62ffa990a"
],
"status": "CANCELED",
"status_message": "status message",
"created_by": 11038,
"created_at": "2022-02-01T15:18:59.930+0200",
"last_update_at": "2022-02-01T15:18:59.930+0200",
"id": "694de4a0-45e9-4611-bfc2-1f82add30006",
"progress_percentage": 0
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"category_id": {
"type": "string",
"description": "the stable id of the category"
},
"resource": {
"type": "string",
"description": "the resource where the action should be applied"
},
"type": {
"type": "string",
"enum": [
"DELETE",
"DUPLICATE",
"UPDATE",
"HIDE",
"RESTORE",
"EXPORT",
"IMPORT"
],
"description": "the action that should be applied"
},
"resource_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "this array contains the selected ids"
},
"settings": {
"type": "object",
"properties": {},
"description": "this field contains additional settings for bulk actions"
},
"status": {
"type": "string",
"enum": [
"CANCELED"
],
"description": "the bulk action status"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "information about the status"
},
"created_by": {
"type": "number",
"description": "the id of the user who performed the bulk action"
},
"created_at": {
"type": "string",
"description": "the bulk action creation date"
},
"last_update_at": {
"type": "string",
"description": "the bulk action last update date"
},
"id": {
"type": "string",
"description": "the unique bulk action id"
},
"progress_percentage": {
"type": "number",
"description": "the progress percentage of performing requested action on resource ids"
}
},
"required": [
"category_id",
"resource",
"type",
"resource_ids",
"status",
"status_message",
"created_by",
"created_at",
"last_update_at",
"id",
"progress_percentage"
],
"additionalProperties": false
}Get Async Bulk Action Exported File MetadataGET/mdb/bulk-actions-async/exported-file/{file_id}
Gets the exported file metadata
Example URI
GET /api/v2/mdb/bulk-actions-async/exported-file/12ffa34c-6949-466a-937b-80397c34bc1f
URI Parameters
- file_id
string(required) Example: 12ffa34c-6949-466a-937b-80397c34bc1fid of the file
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"bulk_action_id": "ae1235cc-6492-4dfe-b605-a00a0fb1325c",
"file_upload_id": "12ffa34c-6949-466a-937b-80397c34bc1f",
"user_id": "11038",
"file_name": "export file.xlsx",
"file_size": 14,
"content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"created_at": "2021-06-21T15:42:40.000+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"bulk_action_id": {
"type": "string",
"description": "the Export bulk action ID"
},
"file_upload_id": {
"type": "string",
"description": "the exported file ID"
},
"user_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "the name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"created_at": {
"type": "string",
"description": "the timestamp when the export file creation is completed"
}
},
"required": [
"bulk_action_id",
"file_upload_id",
"user_id",
"file_name",
"file_size",
"content_type",
"created_at"
],
"additionalProperties": false
}List Async Bulk Action Exported Files Metadata by Category IDGET/mdb/bulk-actions-async/exported-files{?category_id}
Gets the exported files of the given category
Example URI
GET /api/v2/mdb/bulk-actions-async/exported-files?category_id=
URI Parameters
- category_id
string(required)stable category id
Request
Get All Bulk Actions exports filtered by category idResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"bulk_action_id": "ae1235cc-6492-4dfe-b605-a00a0fb1325c",
"file_upload_id": "12ffa34c-6949-466a-937b-80397c34bc1f",
"user_id": "11038",
"file_name": "export file.xlsx",
"file_size": 14,
"content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"created_at": "2021-06-21T15:42:40.000+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"bulk_action_id": {
"type": "string",
"description": "the Export bulk action ID"
},
"file_upload_id": {
"type": "string",
"description": "the exported file ID"
},
"user_id": {
"type": "string",
"description": "the id of the user, who uploaded the file"
},
"file_name": {
"type": "string",
"description": "the name of the file"
},
"file_size": {
"type": "number",
"description": "The size of the file in bytes"
},
"content_type": {
"type": "string",
"description": "The type of the binary content which is sent on header parameter `Content-Type`"
},
"created_at": {
"type": "string",
"description": "the timestamp when the export file creation is completed"
}
},
"required": [
"bulk_action_id",
"file_upload_id",
"user_id",
"file_name",
"file_size",
"content_type",
"created_at"
]
}
}Delete Async Bulk Action Exported File DataDELETE/mdb/bulk-actions-async/exported-file/{file_id}
Deletes the exported file and it’s metadata information
Example URI
DELETE /api/v2/mdb/bulk-actions-async/exported-file/12ffa34c-6949-466a-937b-80397c34bc1f
URI Parameters
- file_id
string(required) Example: 12ffa34c-6949-466a-937b-80397c34bc1fid of the file
Response
204Presigned Url ¶
Upload ¶
Generate upload presigned urlPOST/presigned/upload{?contentType,fileSize}
Example URI
POST /api/v2/presigned/upload?contentType=image/jpeg&fileSize=12344
URI Parameters
- contentType
string(required) Example: image/jpegcontent type of the file
- fileSize
string(required) Example: 12344size of the file
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"file_key": "42f87689-4685-4949-ae09-b0c7c1f7ac59",
"url": "http://presigned.url.com"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"file_key": {
"type": "string",
"description": "the unique id of the file"
},
"url": {
"type": "string",
"description": "the id of the user, who uploaded the file"
}
},
"required": [
"file_key",
"url"
],
"additionalProperties": false
}Signature Workflows ¶
A Signature Workflow is a procedure in which the intentions, actions, and people responsible for undertaking a reviewing process are set out through one or more sequential signatures.
The following operations are available for signature workflows:
Signature Workflows ¶
List Signature WorkflowsGET/signature-workflows{?group_id,project_id,folder_id,status,limit,offset,expand}
Returns the list of all signature workflows. Exactly one of the parameters group_id, project_id, or folder_id must be provided.
Example URI
GET /api/v2/signature-workflows?group_id=1200&project_id=&folder_id=&status=DRAFT&limit=&offset=&expand=
URI Parameters
- group_id
string(optional) Example: 1200Only return the workflows that belong to the specified group
- project_id
string(optional)Only return the workflows that are applicable to the specified project
- folder_id
string(optional)Only return the workflows that are applicable to the specified folder
- status
string(optional) Example: DRAFTA comma separated list of statuses to be filtered.
Choices:
DRAFTPUBLISHEDACTIVEHIDDEN- expand
string(optional)A comma separated list of related domain objects that should be expanded for all workflows returned.
Choices:
owner- limit
number(optional) Default: 20Maximum number of signature workflow to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"title": "Luke's Signature Workflow",
"group_id": "1200",
"project_ids": [
"36276"
],
"folder_ids": [
"36277"
],
"target_project_id": "Hello, world!",
"signature_definitions": [
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
},
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
}
],
"status": "DRAFT",
"id": "6b08850a-3901-4499-b6f6-c0e15c72a19c",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature workflow"
},
"group_id": {
"type": "string",
"description": "the group id which the workflow belongs to"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the project ids which the workflow is applicable to"
},
"folder_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the folder ids which the workflow is applicable to"
},
"target_project_id": {
"type": [
"string",
"null"
],
"description": "the target project id which the entry will be moved to when the workflow is completed"
},
"signature_definitions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
}
],
"description": "the signature steps of the workflow as an ordered list"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"ACTIVE",
"HIDDEN"
],
"description": "the status of the workflow"
},
"id": {
"type": "string",
"description": "the unique id of the workflow"
},
"owner_id": {
"type": "string",
"description": "the id of the original author of this signature workflow"
},
"creation_date": {
"type": "string",
"description": "the creation date of the workflow"
},
"version_date": {
"type": "string",
"description": "the last modification date of the workflow"
}
},
"required": [
"title",
"group_id",
"project_ids",
"folder_ids",
"target_project_id",
"signature_definitions",
"status",
"id",
"owner_id",
"creation_date",
"version_date"
]
}
}Get Signature WorkflowGET/signature-workflows/{id}
Returns the signature workflow
Example URI
GET /api/v2/signature-workflows/c8ea2e7e-3755-497f-bd03-6b568dda025b
URI Parameters
- id
string(required) Example: c8ea2e7e-3755-497f-bd03-6b568dda025bthe unique id of the workflow
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Signature Workflow",
"group_id": "1200",
"project_ids": [
"36276"
],
"folder_ids": [
"36277"
],
"target_project_id": "Hello, world!",
"signature_definitions": [
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
},
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
}
],
"status": "DRAFT",
"id": "6b08850a-3901-4499-b6f6-c0e15c72a19c",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature workflow"
},
"group_id": {
"type": "string",
"description": "the group id which the workflow belongs to"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the project ids which the workflow is applicable to"
},
"folder_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the folder ids which the workflow is applicable to"
},
"target_project_id": {
"type": [
"string",
"null"
],
"description": "the target project id which the entry will be moved to when the workflow is completed"
},
"signature_definitions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
}
],
"description": "the signature steps of the workflow as an ordered list"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"ACTIVE",
"HIDDEN"
],
"description": "the status of the workflow"
},
"id": {
"type": "string",
"description": "the unique id of the workflow"
},
"owner_id": {
"type": "string",
"description": "the id of the original author of this signature workflow"
},
"creation_date": {
"type": "string",
"description": "the creation date of the workflow"
},
"version_date": {
"type": "string",
"description": "the last modification date of the workflow"
}
},
"required": [
"title",
"group_id",
"project_ids",
"folder_ids",
"target_project_id",
"signature_definitions",
"status",
"id",
"owner_id",
"creation_date",
"version_date"
],
"additionalProperties": false
}Create Signature WorkflowPOST/signature-workflows
Create a signature workflow
Example URI
POST /api/v2/signature-workflows
Request
Create Signature WorkflowHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Signature Workflow",
"group_id": "1200",
"project_ids": [
"36276"
],
"folder_ids": [
"36277"
],
"target_project_id": "Hello, world!",
"signature_definitions": [
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
},
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
}
],
"status": "DRAFT"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature workflow"
},
"group_id": {
"type": "string",
"description": "the group id which the workflow belongs to"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the project ids which the workflow is applicable to"
},
"folder_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the folder ids which the workflow is applicable to"
},
"target_project_id": {
"type": [
"string",
"null"
],
"description": "the target project id which the entry will be moved to when the workflow is completed"
},
"signature_definitions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
}
],
"description": "the signature steps of the workflow as an ordered list"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"ACTIVE",
"HIDDEN"
],
"description": "the status of the workflow"
}
},
"required": [
"title",
"group_id",
"project_ids",
"folder_ids",
"target_project_id",
"signature_definitions",
"status"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /signature-workflows/1d573349-347b-4e46-a956-863d4e2db356Body
{
"title": "Luke's Signature Workflow",
"group_id": "1200",
"project_ids": [
"36276"
],
"folder_ids": [
"36277"
],
"target_project_id": "Hello, world!",
"signature_definitions": [
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
},
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
}
],
"status": "DRAFT",
"id": "6b08850a-3901-4499-b6f6-c0e15c72a19c",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature workflow"
},
"group_id": {
"type": "string",
"description": "the group id which the workflow belongs to"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the project ids which the workflow is applicable to"
},
"folder_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the folder ids which the workflow is applicable to"
},
"target_project_id": {
"type": [
"string",
"null"
],
"description": "the target project id which the entry will be moved to when the workflow is completed"
},
"signature_definitions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
}
],
"description": "the signature steps of the workflow as an ordered list"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"ACTIVE",
"HIDDEN"
],
"description": "the status of the workflow"
},
"id": {
"type": "string",
"description": "the unique id of the workflow"
},
"owner_id": {
"type": "string",
"description": "the id of the original author of this signature workflow"
},
"creation_date": {
"type": "string",
"description": "the creation date of the workflow"
},
"version_date": {
"type": "string",
"description": "the last modification date of the workflow"
}
},
"required": [
"title",
"group_id",
"project_ids",
"folder_ids",
"target_project_id",
"signature_definitions",
"status",
"id",
"owner_id",
"creation_date",
"version_date"
],
"additionalProperties": false
}Update Signature WorkflowPUT/signature-workflows/{id}
Update an existing signature workflow
Example URI
PUT /api/v2/signature-workflows/6b08850a-3901-4499-b6f6-c0e15c72a19c
URI Parameters
- id
string(required) Example: 6b08850a-3901-4499-b6f6-c0e15c72a19cid of the signature workflow to update
Request
Update Signature WorkflowHeaders
Content-Type: application/jsonBody
{
"title": "Luke's Signature Workflow",
"group_id": "1200",
"project_ids": [
"36276"
],
"folder_ids": [
"36277"
],
"target_project_id": "Hello, world!",
"signature_definitions": [
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
},
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
}
],
"status": "DRAFT",
"id": "6b08850a-3901-4499-b6f6-c0e15c72a19c"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature workflow"
},
"group_id": {
"type": "string",
"description": "the group id which the workflow belongs to"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the project ids which the workflow is applicable to"
},
"folder_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the folder ids which the workflow is applicable to"
},
"target_project_id": {
"type": [
"string",
"null"
],
"description": "the target project id which the entry will be moved to when the workflow is completed"
},
"signature_definitions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
}
],
"description": "the signature steps of the workflow as an ordered list"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"ACTIVE",
"HIDDEN"
],
"description": "the status of the workflow"
},
"id": {
"type": "string",
"description": "the unique id of the workflow"
}
},
"required": [
"title",
"group_id",
"project_ids",
"folder_ids",
"target_project_id",
"signature_definitions",
"status",
"id"
]
}Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's Signature Workflow",
"group_id": "1200",
"project_ids": [
"36276"
],
"folder_ids": [
"36277"
],
"target_project_id": "Hello, world!",
"signature_definitions": [
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
},
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
]
}
],
"status": "DRAFT",
"id": "6b08850a-3901-4499-b6f6-c0e15c72a19c",
"owner_id": "11038",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature workflow"
},
"group_id": {
"type": "string",
"description": "the group id which the workflow belongs to"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the project ids which the workflow is applicable to"
},
"folder_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "the folder ids which the workflow is applicable to"
},
"target_project_id": {
"type": [
"string",
"null"
],
"description": "the target project id which the entry will be moved to when the workflow is completed"
},
"signature_definitions": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
}
},
"required": [
"title",
"approval_intention"
]
}
],
"description": "the signature steps of the workflow as an ordered list"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"ACTIVE",
"HIDDEN"
],
"description": "the status of the workflow"
},
"id": {
"type": "string",
"description": "the unique id of the workflow"
},
"owner_id": {
"type": "string",
"description": "the id of the original author of this signature workflow"
},
"creation_date": {
"type": "string",
"description": "the creation date of the workflow"
},
"version_date": {
"type": "string",
"description": "the last modification date of the workflow"
}
},
"required": [
"title",
"group_id",
"project_ids",
"folder_ids",
"target_project_id",
"signature_definitions",
"status",
"id",
"owner_id",
"creation_date",
"version_date"
],
"additionalProperties": false
}Get Signature DefinitionGET/signature-workflows/{workflow_id}/signature-definitions/{definition_id}{?expand}
Returns the specific signature definition of the workflow
Example URI
GET /api/v2/signature-workflows/c8ea2e7e-3755-497f-bd03-6b568dda025b/signature-definitions/441646aa-449e-4d46-a493-c0cf6406db21?expand=
URI Parameters
- workflow_id
string(required) Example: c8ea2e7e-3755-497f-bd03-6b568dda025bthe unique id of the signature workflow
- definition_id
string(required) Example: 441646aa-449e-4d46-a493-c0cf6406db21the unique id of the signature definition
- expand
string(optional)Choices:
signees
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"title": "Luke's First Signature",
"approval_intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"rejection_intention": {
"label": "Rejected By",
"body": "I observe that the documented results do not match with my findings"
},
"signable_by_author": true,
"rejectable_by_reviewer": false,
"notify_reviewer_by_email": false,
"actions": [
{
"triggered_by": "APPROVAL",
"type": "ADD_COMMENT",
"body": "{}"
}
],
"signee_ids": [
"11038"
],
"id": "c8ea2e7e-3755-497f-bd03-6b568dda025b",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "the display name of the signature definition"
},
"approval_intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the approval intention of the signature definition"
},
"rejection_intention": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the rejection intention of the signature definition"
},
"signable_by_author": {
"type": "boolean",
"description": "indicates that the author of the entry can apply the signature"
},
"rejectable_by_reviewer": {
"type": "boolean",
"description": "indicates that the reviewer of the entry can reject"
},
"notify_reviewer_by_email": {
"type": "boolean",
"description": "indicates that reviewers are notified by email when they receive a review request"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"triggered_by": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "action trigger event"
},
"type": {
"type": "string",
"enum": [
"ADD_COMMENT",
"ADD_TAGS",
"MOVE_TO_PROJECT"
],
"description": "the type of the action"
},
"body": {
"type": "string",
"description": "action details based on the type"
}
},
"required": [
"triggered_by",
"type",
"body"
]
},
"description": "the actions taking place following the signature step"
},
"signee_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "possible reviewers/signees user ids of the signature"
},
"id": {
"type": "string",
"description": "the unique id of the signature definition"
},
"creation_date": {
"type": "string",
"description": "the creation date of the signature definition"
},
"version_date": {
"type": "string",
"description": "the last modification date of the signature definition"
}
},
"required": [
"title",
"approval_intention",
"id",
"creation_date",
"version_date"
]
}Signatures ¶
A Signature is applied to an entry and documents the authorizing of a cheque for the entries content.
List SignaturesGET/signatures{?entry_id,entry_version_id,expand}
Returns the list of signatures
Note that exactly one of the parameters entry_id or entry_version_id is mandatory to provide with the request.
Example URI
GET /api/v2/signatures?entry_id=938302&entry_version_id=&expand=
URI Parameters
- entry_id
string(optional) Example: 938302filter signatures being applied to latest version of specific entry
- entry_version_id
string(optional)filter signatures being applied to specific entry version
- expand
string(optional)Choices:
owner
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"entry_id": "938303",
"signature_definition_id": "441646aa-449e-4d46-a493-c0cf6406db21",
"intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"type": "APPROVAL",
"id": "21e16a61-fd64-4b55-b679-7a0c74cf855b",
"owner_id": "11038",
"biometric_doc_id": "465862",
"hash": "90b30ef9902ae4c4c691d2d78c2f8fa0aa785afbc5545286b310f68e91dd2299c84a2484f0419fc5eaa7de598940799e1091c4948926ae1c9488dddae180bb80",
"hash_version": 4,
"hash_description": "SHA-1",
"creation_date": "2018-11-07T16:32:12.729+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the id of the entry that is signed with the signature"
},
"signature_definition_id": {
"type": "string",
"description": "id of the signature definition as defined in the signature workflow"
},
"intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the intention describing the signature"
},
"type": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "signature submit type"
},
"id": {
"type": "string",
"description": "uuid of the entry signature"
},
"owner_id": {
"type": "string",
"description": "the unique id of the user who created the signature"
},
"biometric_doc_id": {
"type": [
"string",
"null"
],
"description": "file id containing the biometric signature"
},
"hash": {
"type": "string",
"description": "SHA hash value of the entry content"
},
"hash_version": {
"type": "number",
"description": "indicating which version of the internal hash implementation was used to produce the hash value"
},
"hash_description": {
"type": "string",
"description": "Digest algorithm description used to create the hash value"
},
"creation_date": {
"type": "string",
"description": "timestamp of the signature creation"
}
},
"required": [
"entry_id",
"signature_definition_id",
"intention",
"type",
"id",
"owner_id",
"biometric_doc_id",
"hash",
"hash_version",
"hash_description",
"creation_date"
]
}
}Create SignaturePOST/signatures
Create a signature for an entry
Example URI
POST /api/v2/signatures
Request
Create SignatureHeaders
Content-Type: application/jsonBody
{
"entry_id": "938303",
"signature_definition_id": "441646aa-449e-4d46-a493-c0cf6406db21",
"intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"type": "APPROVAL",
"target_entry_version_id": "938303",
"biometric_sign_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/TQBcNTh/AAAAAXRSTlMAQObYZgAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII="
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the id of the entry that is signed with the signature"
},
"signature_definition_id": {
"type": "string",
"description": "id of the signature definition as defined in the signature workflow"
},
"intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the intention describing the signature"
},
"type": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "signature submit type"
},
"target_entry_version_id": {
"type": "string",
"description": "[beta] the most recent version id of the entry"
},
"biometric_sign_data": {
"type": "string",
"description": "base64 encoded image data, containing biometrical signature"
}
},
"required": [
"entry_id",
"signature_definition_id",
"intention",
"type",
"target_entry_version_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /signatures/1d573349-347b-4e46-a956-863d4e2db356Body
{
"entry_id": "938303",
"signature_definition_id": "441646aa-449e-4d46-a493-c0cf6406db21",
"intention": {
"label": "Signed By",
"body": "I hereby certify that I carried out the documented steps"
},
"type": "APPROVAL",
"id": "21e16a61-fd64-4b55-b679-7a0c74cf855b",
"owner_id": "11038",
"biometric_doc_id": "465862",
"hash": "90b30ef9902ae4c4c691d2d78c2f8fa0aa785afbc5545286b310f68e91dd2299c84a2484f0419fc5eaa7de598940799e1091c4948926ae1c9488dddae180bb80",
"hash_version": 4,
"hash_description": "SHA-1",
"creation_date": "2018-11-07T16:32:12.729+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "the id of the entry that is signed with the signature"
},
"signature_definition_id": {
"type": "string",
"description": "id of the signature definition as defined in the signature workflow"
},
"intention": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "the label of the signature intention"
},
"body": {
"type": "string",
"description": "the content body of the signature intention"
}
},
"required": [
"label",
"body"
],
"description": "the intention describing the signature"
},
"type": {
"type": "string",
"enum": [
"APPROVAL",
"REJECTION"
],
"description": "signature submit type"
},
"id": {
"type": "string",
"description": "uuid of the entry signature"
},
"owner_id": {
"type": "string",
"description": "the unique id of the user who created the signature"
},
"biometric_doc_id": {
"type": [
"string",
"null"
],
"description": "file id containing the biometric signature"
},
"hash": {
"type": "string",
"description": "SHA hash value of the entry content"
},
"hash_version": {
"type": "number",
"description": "indicating which version of the internal hash implementation was used to produce the hash value"
},
"hash_description": {
"type": "string",
"description": "Digest algorithm description used to create the hash value"
},
"creation_date": {
"type": "string",
"description": "timestamp of the signature creation"
}
},
"required": [
"entry_id",
"signature_definition_id",
"intention",
"type",
"id",
"owner_id",
"biometric_doc_id",
"hash",
"hash_version",
"hash_description",
"creation_date"
],
"additionalProperties": false
}Signature Requests ¶
List Signature RequestsGET/signature-requests{?reviewer_id,expand,limit,offset}
Returns the list of all signature requests, which are applied to entries the user can access.
Example URI
GET /api/v2/signature-requests?reviewer_id=11039&expand=&limit=&offset=
URI Parameters
- reviewer_id
string(optional) Example: 11039Filter signature requests by requested reviewer
- expand
string(optional)A comma separated list of related domain objects that should be expanded for all items returned
Choices:
ownerreviewer- limit
number(optional) Default: 20Maximum number of signature requests to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"entry_id": "938303",
"signature_definition_id": "791c1a54-3e97-453d-b219-4c338dea5ff7",
"reviewer_id": "11039",
"id": "21e16a61-fd64-4b55-b679-7a0c74cf855b",
"owner_id": "11038",
"signature_id": "null",
"creation_date": "2018-11-07T16:32:12.729+0200",
"fulfilled_date": "null"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry that is to be reviewed"
},
"signature_definition_id": {
"type": "string",
"description": "id of the signature definition as defined in the signature workflow"
},
"reviewer_id": {
"type": "string",
"description": "id of the user who is requested to review the entry"
},
"id": {
"type": "string",
"description": "id of the review request"
},
"owner_id": {
"type": "string",
"description": "id of the user who requested the review"
},
"signature_id": {
"type": [
"string",
"null"
],
"description": "id of the signature which fulfills this request"
},
"creation_date": {
"type": "string",
"description": "timestamp of the review request"
},
"fulfilled_date": {
"type": [
"string",
"null"
],
"description": "timestamp of the review fulfilled"
}
},
"required": [
"entry_id",
"signature_definition_id",
"reviewer_id",
"id",
"owner_id",
"creation_date"
]
}
}Create Signature RequestPOST/signature-requests
Create a signature request for an entry to be reviewed by a reviewer
Example URI
POST /api/v2/signature-requests
Request
Create Signature RequestHeaders
Content-Type: application/jsonBody
{
"entry_id": "938303",
"signature_definition_id": "791c1a54-3e97-453d-b219-4c338dea5ff7",
"reviewer_id": "11039"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry that is to be reviewed"
},
"signature_definition_id": {
"type": "string",
"description": "id of the signature definition as defined in the signature workflow"
},
"reviewer_id": {
"type": "string",
"description": "id of the user who is requested to review the entry"
}
},
"required": [
"entry_id",
"signature_definition_id",
"reviewer_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /signature-requests/21e16a61-fd64-4b55-b679-7a0c74cf855bBody
{
"entry_id": "938303",
"signature_definition_id": "791c1a54-3e97-453d-b219-4c338dea5ff7",
"reviewer_id": "11039",
"id": "21e16a61-fd64-4b55-b679-7a0c74cf855b",
"owner_id": "11038",
"signature_id": "null",
"creation_date": "2018-11-07T16:32:12.729+0200",
"fulfilled_date": "null"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"entry_id": {
"type": "string",
"description": "id of the entry that is to be reviewed"
},
"signature_definition_id": {
"type": "string",
"description": "id of the signature definition as defined in the signature workflow"
},
"reviewer_id": {
"type": "string",
"description": "id of the user who is requested to review the entry"
},
"id": {
"type": "string",
"description": "id of the review request"
},
"owner_id": {
"type": "string",
"description": "id of the user who requested the review"
},
"signature_id": {
"type": [
"string",
"null"
],
"description": "id of the signature which fulfills this request"
},
"creation_date": {
"type": "string",
"description": "timestamp of the review request"
},
"fulfilled_date": {
"type": [
"string",
"null"
],
"description": "timestamp of the review fulfilled"
}
},
"required": [
"entry_id",
"signature_definition_id",
"reviewer_id",
"id",
"owner_id",
"creation_date"
],
"additionalProperties": false
}Signature Workflow Executions ¶
List SignatureWorkflowExecutionsGET/signature-workflow-executions{?entry_id,first_signee_id,signature_workflow_id,status,expand,limit,offset}
Returns the list of signature workflows the user has access to
Example URI
GET /api/v2/signature-workflow-executions?entry_id=938302&first_signee_id=11038&signature_workflow_id=c8ea2e7e-3755-497f-bd03-6b568dda025b&status=ACTIVE&expand=signature_request,reviewer&limit=&offset=
URI Parameters
- entry_id
string(optional) Example: 938302filter signatures being applied to latest version of specific entry
- first_signee_id
string(optional) Example: 11038filter execution with only the given first signee id
- signature_workflow_id
string(optional) Example: c8ea2e7e-3755-497f-bd03-6b568dda025bfilter execution for only the given signature workflow id
- status
enum(optional) Example: ACTIVEfilter by current status of the execution
Choices:
ACTIVEAPPROVEDREJECTED- expand
string(optional) Example: signature_request,reviewerA comma separated list of related domain objects that should be expanded for all items returned
Choices
first_signee,signature_request,reviewer,next_signature_definition- limit
number(optional) Default: 20Maximum number of signature workflow executions to return
- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "86a2e72c-ca99-438b-b910-3d86806d561d",
"entry_id": "96853",
"first_signee_id": "11038",
"signature_request_id": "32765a7d-4785-4b23-a314-cdce2c90e2b0",
"next_signature_definition_id": "f2fb283e-3178-4935-8a78-d2a512108f83",
"status": "ACTIVE",
"creation_date": "2017-02-10T12:34:56.789+0200",
"version_date": "2017-02-15T12:34:56.789+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "the id of the workflow execution"
},
"entry_id": {
"type": "string",
"description": "the id of the entry for which the workflow execution is processed"
},
"first_signee_id": {
"type": "string",
"description": "the id of the first signee in this workflow execution"
},
"signature_request_id": {
"type": [
"string",
"null"
],
"description": "the id of the current signature request int the workflow execution"
},
"next_signature_definition_id": {
"type": [
"string",
"null"
],
"description": "the id of the next signature definition in the workflow execution"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"APPROVED",
"REJECTED"
],
"description": "the execution status of the workflow execution"
},
"creation_date": {
"type": "string",
"description": "the creation date of the workflow execution"
},
"version_date": {
"type": "string",
"description": "the last modification date of the workflow execution"
}
},
"required": [
"id",
"entry_id",
"first_signee_id",
"signature_request_id",
"next_signature_definition_id",
"status",
"creation_date",
"version_date"
]
}
}Delete SignatureWorkflowExecutionDELETE/signature-workflow-executions/{id}
Deletes the signature workflow execution as well as its last assigned request and revokes all previously applied signatures.
Example URI
DELETE /api/v2/signature-workflow-executions/20158d69-3f7c-4ef3-afe6-7159723ee180
URI Parameters
- id
string(required) Example: 20158d69-3f7c-4ef3-afe6-7159723ee180id of the signature workflow execution
Response
204Reports ¶
Incident Reports ¶
An Incident Report is a system generated file used to maintain information about data inconsistencies, security incidents and similar. Each report relates to a single incident in the context of one group or the user’s private space.
List Incident ReportsGET/incident-reports
Returns all available incident reports for the active user. The response contains all reports that exist for groups, where the requesting user is group admin, as well as those reports, that relate to the current users private content.
Example URI
GET /api/v2/incident-reports
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
[
{
"id": "d1125edc-d43f-44ef-bb8e-c337ac25af81",
"file_name: `30.05.2023_Private": "Hello, world!",
"file_size": 12589
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "unique id of the report"
},
"file_name: `30.05.2023_Private": {
"type": "string",
"description": "space_Broken-LR-Item-links.zip` (string,required) - the filename of the report"
},
"file_size": {
"type": "number",
"description": "the file size of the report in bytes"
}
},
"required": [
"id",
"file_size"
]
}
}Download Incident Report DataGET/incident-reports/{id}/data
Download the data file of a specific incident report.
Example URI
GET /api/v2/incident-reports/3c0f7c2f-c970-4341-9b53-182d617edec6/data
URI Parameters
- id
string(required) Example: 3c0f7c2f-c970-4341-9b53-182d617edec6The unique identifier of the incident report.
Response
200Headers
Content-Type: application/zip
Content-Disposition: `attachment;filename="30.05.2023_Private-space_Broken-LR-Item-links.zip"`
Content-Length: 10Apps ¶
App Installations ¶
List Group App InstallationsGET/app-installations/group{?app_id,group_id,limit,offset}
Returns a list of the group app installations for any groups the requesting user is a member of.
The list is ordered by creation date descending.
Example URI
GET /api/v2/app-installations/group?app_id=13&group_id=1200&limit=&offset=
URI Parameters
- app_id
string(optional) Example: 13Only return app installations of specific app
- group_id
string(optional) Example: 1200Only return app installations of specific group
- limit
number(optional) Default: 20Maximum number of app installations to return. The maximum for
limitis 50 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"app_id": "13",
"group_id": "1200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "the id of the app to create an installation for"
},
"group_id": {
"type": "string",
"description": "the id of the group to activate the app for"
}
},
"required": [
"app_id",
"group_id"
]
}
}Server Admin ¶
These endpoints are restricted to labfolder server admin users only.
App Installations ¶
List Group App Installations As AdminGET/admin/app-installations/group{?app_id,group_id,limit,offset}
Returns a list of all App Installations on the server.
Currently the use of this endpoint is restricted to labfolder server admin users only.
The list is ordered by creation date descending.
Example URI
GET /api/v2/admin/app-installations/group?app_id=13&group_id=1200&limit=&offset=
URI Parameters
- app_id
string(optional) Example: 13Only return app installations of specific app
- group_id
string(optional) Example: 1200Only return app installations of specific group
- limit
number(optional) Default: 20Maximum number of app installations to return. The maximum for
limitis 50 items.- offset
number(optional) Default: 0Offset into result-set (useful for pagination)
Response
200Headers
Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0Body
[
{
"app_id": "13",
"group_id": "1200",
"id": "85695",
"type": "GROUP",
"creation_date": "2017-02-10T12:34:56.789+0200"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "the id of the app to create an installation for"
},
"group_id": {
"type": "string",
"description": "the id of the group to activate the app for"
},
"id": {
"type": "string",
"description": "id of the app installation"
},
"type": {
"type": "string",
"enum": [
"GROUP"
],
"description": "the type of the app installation"
},
"creation_date": {
"type": "string",
"description": "the date when the app installation was created"
}
},
"required": [
"app_id",
"group_id",
"id",
"type",
"creation_date"
]
}
}Create Group App Installation As AdminPOST/admin/app-installations/group
Create an App Installation for a group.
Currently the use of this endpoint is restricted to labfolder server admin users only.
Example URI
POST /api/v2/admin/app-installations/group
Request
Create App InstallationHeaders
Content-Type: application/jsonBody
{
"app_id": "13",
"group_id": "1202"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "the id of the app to create an installation for"
},
"group_id": {
"type": "string",
"description": "An Advanced Group Id without the specified App (in the request) installed"
}
},
"required": [
"app_id"
]
}Response
201Headers
Content-Type: application/json;charset=UTF-8
Location: /app-installations/group/19674Body
{
"app_id": "13",
"group_id": "1200",
"id": "85695",
"type": "GROUP",
"creation_date": "2017-02-10T12:34:56.789+0200"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"app_id": {
"type": "string",
"description": "the id of the app to create an installation for"
},
"group_id": {
"type": "string",
"description": "the id of the group to activate the app for"
},
"id": {
"type": "string",
"description": "id of the app installation"
},
"type": {
"type": "string",
"enum": [
"GROUP"
],
"description": "the type of the app installation"
},
"creation_date": {
"type": "string",
"description": "the date when the app installation was created"
}
},
"required": [
"app_id",
"group_id",
"id",
"type",
"creation_date"
],
"additionalProperties": false
}Delete Group App Installation As AdminDELETE/admin/app-installations/group/{id}
Deletes an App Installation of a group.
Currently the use of this endpoint is restricted to labfolder server admin users only.
Example URI
DELETE /api/v2/admin/app-installations/group/19674
URI Parameters
- id
string(required) Example: 19674id of the group app installation
Response
204Server Environment ¶
Environment Variables ¶
Endpoints used to receive server environment specific values
Get Signup EnvironmentGET/env/signup
Returns environment variables related to the signup pages and process
Example URI
GET /api/v2/env/signup
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"TERMS_OF_USE_LINK": "https://www.labfolder.com/terms-external-servers",
"PRIVACY_LINK": "https://www.labfolder.com/privacy-external-servers",
"FEATURE_ENABLE_SIGNUP": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"TERMS_OF_USE_LINK": {
"type": "string",
"description": "url to the terms of use of the server"
},
"PRIVACY_LINK": {
"type": "string",
"description": "url to the privacy informations of the server"
},
"FEATURE_ENABLE_SIGNUP": {
"type": "boolean",
"description": "indicate if the signup process is enabled on the server"
}
},
"required": [
"TERMS_OF_USE_LINK",
"PRIVACY_LINK",
"FEATURE_ENABLE_SIGNUP"
],
"additionalProperties": false
}Get Server EnvironmentGET/env/server
Returns environment variables related to the server setup
Example URI
GET /api/v2/env/server
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"feature_flags": [
"FEATURE_XHTML_EXPORT",
"FEATURE_DROPBOX"
],
"build_number": "b18efb152428bf",
"spread_js_license_key": "428bf722d2a1",
"spread_js_designer_license_key": "7362f722d2ae3",
"dropbox_consumer_key": "2428bf722d",
"dropbox_integrity_hash": "sha384-AncVDCIsLmo5RCRYKL",
"froala_license_key": "a076e06f1b89",
"ckeditor_license_key": "c890f15b1b23",
"intercom_app_id": "b89ad62a1df5",
"intercom_environment": "dev",
"is_labfolder_cloud": false,
"max_filesize": 25000000,
"max_tablesize": 25000000,
"max_textsize": 8000000,
"signup_url": "/eln/access/signup",
"base_upgrade_url": "https://labforward.io/labfolder#utm_campaign=ELN&utm_source=Internal&utm_medium=labfolderSoftware",
"upgrade_url": "https://www.labfolder.com/team-upgrade/#utm_campaign=ELN&utm_source=Internal&utm_medium=labfolderSoftware",
"upgrade_url_de": "https://www.labfolder.com/de/team-upgrade-2/#utm_campaign=ELN&utm_source=Internal&utm_medium=labfolderSoftware",
"upgrade_advanced_url": "https://www.labfolder.com/team-upgrade-advanced/#utm_campaign=ELN&utm_source=Internal&utm_medium=labfolderSoftware",
"request_demo_url": "https://www.labfolder.com/request-a-demo/#utm_campaign=ELN&utm_source=Internal&utm_medium=labfolderSoftware",
"request_demo_url_de": "https://www.labfolder.com/de/demo-anfordern-2/#utm_campaign=ELN&utm_source=Internal&utm_medium=labfolderSoftware",
"siwor_intention_body_max_length": 255,
"mdb_bulk_action_max_operations": 1000,
"mdb_export_bulk_action_max_items_count": 10000,
"iam_refresh_token_interval": 6000,
"iam_profile_url": "https://account.test.labforward.io/auth/realms/labforward",
"iam_logout_url": "https://account.localk8s.labforward.com/realms/labforward/account/#/iam-logout",
"iam_profile_picture_url": "https://account.test.labforward.app/realms/labforward/iam-account/user-photo",
"laboperator_url": "https://laboperator.test.labforward.app",
"websocket_host": "ws://labfolder.labforward.app",
"max_concurrent_requests": 10,
"public_url": "https://labfolder.labforward.app",
"labtwin_api_url": "https://api.labtwin.com/",
"indigo_api_url": "https://indigo.test.labforward.app",
"high_image_display_quality": false,
"indigo_aromatize_skip_superatoms": true,
"indigo_dearomatize_on_load": false,
"indigo_gross_formula_add_rsites": true,
"indigo_ignore_no_chiral_flag": false,
"indigo_ignore_stereochemistry_errors": true,
"indigo_mass_skip_error_on_pseudoatoms": false,
"indigo_render_bond_line_width": 1,
"indigo_render_label_mode": "terminal-hetero",
"indigo_render_output_format": "png",
"indigo_smart_layout": true
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"feature_flags": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
}
],
"description": "List of enabled feature flags on the server"
},
"build_number": {
"type": "string",
"description": "current build number"
},
"spread_js_license_key": {
"type": "string"
},
"spread_js_designer_license_key": {
"type": "string"
},
"dropbox_consumer_key": {
"type": "string",
"description": "dropbox consumer key"
},
"dropbox_integrity_hash": {
"type": "string",
"description": "Dropbox Subresource Integrity Hash, a hash of the file https://www.dropbox.com/static/api/2/dropins.js"
},
"froala_license_key": {
"type": "string",
"description": "froala licence key"
},
"ckeditor_license_key": {
"type": "string",
"description": "ck editor licence key"
},
"intercom_app_id": {
"type": "string",
"description": "intercom app id"
},
"intercom_environment": {
"type": "string",
"description": "intercom environment"
},
"is_labfolder_cloud": {
"type": "boolean",
"description": "server is a cloud server"
},
"max_filesize": {
"type": "number",
"description": "maximum size for uploaded files (eg. for file element)"
},
"max_tablesize": {
"type": "number",
"description": "maximum size of tables (eg. for table element)"
},
"max_textsize": {
"type": "number",
"description": "maximum size of texts (eg. text element)"
},
"signup_url": {
"type": "string",
"description": "url for signup for the server"
},
"base_upgrade_url": {
"type": "string",
"description": "base link for upgrading information"
},
"upgrade_url": {
"type": "string",
"description": "url for upgrading groups for the server"
},
"upgrade_url_de": {
"type": "string",
"description": "german url for upgrading groups for the server"
},
"upgrade_advanced_url": {
"type": "string",
"description": "url for upgrading advanced groups for the server"
},
"request_demo_url": {
"type": "string",
"description": "url for demo"
},
"request_demo_url_de": {
"type": "string",
"description": "german url for demo"
},
"siwor_intention_body_max_length": {
"type": "number",
"description": "maximum allowed number of characters for the signing statement"
},
"mdb_bulk_action_max_operations": {
"type": "number",
"description": "maximum allowed number of operations for labregister bulk actions"
},
"mdb_export_bulk_action_max_items_count": {
"type": "number",
"description": "maximum items count for Labregister Export bulk action"
},
"iam_refresh_token_interval": {
"type": "number",
"description": "iam refresh token interval"
},
"iam_profile_url": {
"type": "string",
"description": "URL for IAM user profile"
},
"iam_logout_url": {
"type": "string",
"description": "URL to logout from IAM"
},
"iam_profile_picture_url": {
"type": "string",
"description": "URL for IAM user profile picture"
},
"laboperator_url": {
"type": "string",
"description": "URL for Laboperator"
},
"websocket_host": {
"type": "string",
"description": "URL for websocket host"
},
"max_concurrent_requests": {
"type": [
"number",
"null"
],
"description": "maximum number of concurrent requests"
},
"public_url": {
"type": "string",
"description": "public URL for the server"
},
"labtwin_api_url": {
"type": "string",
"description": "url for labtwin api server"
},
"indigo_api_url": {
"type": "string",
"description": "URL for Indigo API"
},
"high_image_display_quality": {
"type": "boolean",
"description": "display image in high quality"
},
"indigo_aromatize_skip_superatoms": {
"type": "boolean",
"description": "display settings for chemical structures for the Indigo service"
},
"indigo_dearomatize_on_load": {
"type": "boolean",
"description": "display settings for chemical structures for the Indigo service"
},
"indigo_gross_formula_add_rsites": {
"type": "boolean",
"description": "display settings for chemical structures for the Indigo service"
},
"indigo_ignore_no_chiral_flag": {
"type": "boolean",
"description": "display settings for chemical structures for the Indigo service"
},
"indigo_ignore_stereochemistry_errors": {
"type": "boolean",
"description": "display settings for chemical structures for the Indigo service"
},
"indigo_mass_skip_error_on_pseudoatoms": {
"type": "boolean",
"description": "display settings for chemical structures for the Indigo service"
},
"indigo_render_bond_line_width": {
"type": "number",
"description": "bond line width for chemical structures for the Indigo service"
},
"indigo_render_label_mode": {
"type": "string",
"description": "label mode for chemical structures for the Indigo service"
},
"indigo_render_output_format": {
"type": "string",
"description": "output format for chemical structures for the Indigo service."
},
"indigo_smart_layout": {
"type": "boolean",
"description": "layout setting for chemical structures for the Indigo service"
}
},
"required": [
"feature_flags",
"build_number",
"spread_js_license_key",
"spread_js_designer_license_key",
"dropbox_consumer_key",
"dropbox_integrity_hash",
"froala_license_key",
"ckeditor_license_key",
"intercom_app_id",
"intercom_environment",
"is_labfolder_cloud",
"max_filesize",
"max_tablesize",
"max_textsize",
"signup_url",
"base_upgrade_url",
"upgrade_url",
"upgrade_url_de",
"upgrade_advanced_url",
"request_demo_url",
"request_demo_url_de",
"siwor_intention_body_max_length",
"mdb_bulk_action_max_operations",
"mdb_export_bulk_action_max_items_count",
"iam_refresh_token_interval",
"iam_profile_url",
"iam_logout_url",
"iam_profile_picture_url",
"laboperator_url",
"websocket_host",
"public_url",
"labtwin_api_url",
"indigo_api_url",
"high_image_display_quality",
"indigo_aromatize_skip_superatoms",
"indigo_dearomatize_on_load",
"indigo_gross_formula_add_rsites",
"indigo_ignore_no_chiral_flag",
"indigo_ignore_stereochemistry_errors",
"indigo_mass_skip_error_on_pseudoatoms",
"indigo_render_bond_line_width",
"indigo_render_label_mode",
"indigo_render_output_format",
"indigo_smart_layout"
],
"additionalProperties": false
}Get Support EnvironmentGET/env/support
Returns environment variables related to support needs
Example URI
GET /api/v2/env/support
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"help_documentation": "https://support.labforward.io/en/support/solutions/19000105157",
"video_tutorial": "https://www.youtube.com/watch?v=54CfDjKMg18&list=PL3XR7KnCbDl8mQ9p5NjMefmJB7AIOVg_m",
"support_request": "https://support.labforward.io/en/support/tickets/new",
"release_notes": "https://trace.labforward.app/products/ELN/release-notes?maxVersions=3&expanded=false",
"system_status": "https://status.labforward.app/",
"terms_and_conditions": "https://labforward.io/terms/gtc-cloud/",
"privacy_policy": "https://labforward.io/privacy/",
"platform_version": "3.26.2",
"labfolder_version": "v3.12.2",
"server_date": "21/11/2024 23:29"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"help_documentation": {
"type": "string",
"description": "url for help documentation"
},
"video_tutorial": {
"type": "string",
"description": "url for quick video tutorials"
},
"support_request": {
"type": "string",
"description": "url for submitting a request to the support team"
},
"release_notes": {
"type": "string",
"description": "url for where to find the Labfolder Release Notes"
},
"system_status": {
"type": [
"string",
"null"
],
"description": "url for status overview of Labforward products"
},
"terms_and_conditions": {
"type": "string",
"description": "url for accessing the Terms & Conditions"
},
"privacy_policy": {
"type": "string",
"description": "url for accessing the Privacy Policy"
},
"platform_version": {
"type": [
"string",
"null"
],
"description": "version number of the Labforward platform"
},
"labfolder_version": {
"type": [
"string",
"null"
],
"description": "version number of the Labfolder application"
},
"server_date": {
"type": "string",
"description": "Server local datetime"
}
},
"required": [
"help_documentation",
"video_tutorial",
"support_request",
"release_notes",
"system_status",
"terms_and_conditions",
"privacy_policy",
"platform_version",
"labfolder_version",
"server_date"
],
"additionalProperties": false
}Me ¶
User info ¶
Endpoint to get user info
Get User InfoGET/me{?expand}
Returns current user’s specific info
Example URI
GET /api/v2/me?expand=
URI Parameters
- expand
string(optional)A comma separated list of related domain objects that should be expanded
Choices:
user
Response
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"user_id": "11038",
"signup_date": "2017-04-22T12:47:14.00+0200",
"installed_apps": [
"WELL_PLATES",
"SIGNATURE_WORKFLOWS",
"XHTML_EXPORT"
],
"user_settings": {
"language": "en",
"show_hidden_items": false,
"show_invite_button": true,
"innovation_level": "USER",
"order_by_create_ts": true,
"order_asc": true,
"zone_id": "Europe/Berlin",
"private_content_allowed": true,
"highest_group_membership_type": "NO_GROUP",
"used_storage_with_unit": "300.0 MB",
"max_storage_with_unit": "3.0 GB",
"used_storage_percent": 10,
"user_uuid": "455d70cc-d229-1d42-e79e-d8b2b4de9938",
"intercom_user_hash": "null",
"admin": false
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "the user id of the requesting (logged in) user"
},
"signup_date": {
"type": "string",
"description": "date of the user's signup"
},
"installed_apps": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
],
"description": "list of app keys of all apps which are installed for the user. This includes all apps which might be installed by default given the server settings or the user's groups settings."
},
"user_settings": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "the user's language setting"
},
"show_hidden_items": {
"type": "boolean",
"description": "the user's setting for showing hidden items"
},
"show_invite_button": {
"type": "boolean",
"description": "the user's setting for showing an invite button"
},
"innovation_level": {
"type": "string",
"enum": [
"USER",
"INNOVATOR",
"ADMIN"
],
"description": "the user's innovation level setting"
},
"order_by_create_ts": {
"type": "boolean",
"description": "the user's setting to order by creation timestamp"
},
"order_asc": {
"type": "boolean",
"description": "the user's setting to order ascending"
},
"zone_id": {
"type": "string",
"description": "the user's selected time zone"
},
"private_content_allowed": {
"type": "boolean",
"description": "the flag which controls private content creation for the user based on their group memberships and settings of those groups"
},
"highest_group_membership_type": {
"type": "string",
"enum": [
"NO_GROUP",
"FREE_GROUP",
"PAID_GROUP"
],
"description": "the user's highest group membership type"
},
"used_storage_with_unit": {
"type": "string",
"description": "the user's used storage with unit"
},
"max_storage_with_unit": {
"type": "string",
"description": "the maximum storage limit for the user"
},
"used_storage_percent": {
"type": "number",
"description": "the percentage of used storage to the maximum storage limit"
},
"user_uuid": {
"type": "string",
"description": "a unique key to the user which is to be used across 3rd party applications"
},
"intercom_user_hash": {
"type": [
"string",
"null"
],
"description": "the user's intercom hash"
},
"admin": {
"type": "boolean",
"description": "the flag which shows if the user is a server admin"
}
},
"required": [
"language",
"show_hidden_items",
"show_invite_button",
"innovation_level",
"order_by_create_ts",
"order_asc",
"zone_id",
"private_content_allowed",
"highest_group_membership_type",
"used_storage_with_unit",
"max_storage_with_unit",
"used_storage_percent",
"user_uuid",
"intercom_user_hash",
"admin"
]
}
},
"required": [
"user_id",
"signup_date",
"installed_apps",
"user_settings"
],
"additionalProperties": false
}Request
?expand=userResponse
200Headers
Content-Type: application/json;charset=UTF-8Body
{
"user_id": "11038",
"signup_date": "2017-04-22T12:47:14.00+0200",
"installed_apps": [
"WELL_PLATES",
"SIGNATURE_WORKFLOWS",
"XHTML_EXPORT"
],
"user_settings": {
"language": "en",
"show_hidden_items": false,
"show_invite_button": true,
"innovation_level": "USER",
"order_by_create_ts": true,
"order_asc": true,
"zone_id": "Europe/Berlin",
"private_content_allowed": true,
"highest_group_membership_type": "NO_GROUP",
"used_storage_with_unit": "300.0 MB",
"max_storage_with_unit": "3.0 GB",
"used_storage_percent": 10,
"user_uuid": "455d70cc-d229-1d42-e79e-d8b2b4de9938",
"intercom_user_hash": "null",
"admin": false
},
"user": {
"id": "11038",
"email": "luke.skywalker@starwars.com",
"deactivated": false,
"first_name": "Luke",
"last_name": "Skywalker",
"profile_picture_hash": "bhOwHTKEjrPTDeiMtTnc",
"iam_id": "d229cc70-455d-421d-9938-b2d8b4dee79e"
}
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "the user id of the requesting (logged in) user"
},
"signup_date": {
"type": "string",
"description": "date of the user's signup"
},
"installed_apps": {
"type": "array",
"items": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
],
"description": "list of app keys of all apps which are installed for the user. This includes all apps which might be installed by default given the server settings or the user's groups settings."
},
"user_settings": {
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "the user's language setting"
},
"show_hidden_items": {
"type": "boolean",
"description": "the user's setting for showing hidden items"
},
"show_invite_button": {
"type": "boolean",
"description": "the user's setting for showing an invite button"
},
"innovation_level": {
"type": "string",
"enum": [
"USER",
"INNOVATOR",
"ADMIN"
],
"description": "the user's innovation level setting"
},
"order_by_create_ts": {
"type": "boolean",
"description": "the user's setting to order by creation timestamp"
},
"order_asc": {
"type": "boolean",
"description": "the user's setting to order ascending"
},
"zone_id": {
"type": "string",
"description": "the user's selected time zone"
},
"private_content_allowed": {
"type": "boolean",
"description": "the flag which controls private content creation for the user based on their group memberships and settings of those groups"
},
"highest_group_membership_type": {
"type": "string",
"enum": [
"NO_GROUP",
"FREE_GROUP",
"PAID_GROUP"
],
"description": "the user's highest group membership type"
},
"used_storage_with_unit": {
"type": "string",
"description": "the user's used storage with unit"
},
"max_storage_with_unit": {
"type": "string",
"description": "the maximum storage limit for the user"
},
"used_storage_percent": {
"type": "number",
"description": "the percentage of used storage to the maximum storage limit"
},
"user_uuid": {
"type": "string",
"description": "a unique key to the user which is to be used across 3rd party applications"
},
"intercom_user_hash": {
"type": [
"string",
"null"
],
"description": "the user's intercom hash"
},
"admin": {
"type": "boolean",
"description": "the flag which shows if the user is a server admin"
}
},
"required": [
"language",
"show_hidden_items",
"show_invite_button",
"innovation_level",
"order_by_create_ts",
"order_asc",
"zone_id",
"private_content_allowed",
"highest_group_membership_type",
"used_storage_with_unit",
"max_storage_with_unit",
"used_storage_percent",
"user_uuid",
"intercom_user_hash",
"admin"
]
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id of the user"
},
"email": {
"type": "string",
"description": "email of the user"
},
"deactivated": {
"type": "boolean",
"description": "the flags shows if the user's account is deactivated"
},
"first_name": {
"type": "string",
"description": "first name of the user"
},
"last_name": {
"type": "string",
"description": "last name of the user"
},
"profile_picture_hash": {
"type": [
"string",
"null"
],
"description": "a hash to be used for the profile picture location url"
},
"iam_id": {
"type": [
"string",
"null"
],
"description": "user uuid identifying the user in IAM"
}
},
"required": [
"id",
"email",
"deactivated",
"first_name",
"last_name",
"profile_picture_hash",
"iam_id"
]
}
},
"required": [
"user_id",
"signup_date",
"installed_apps",
"user_settings",
"user"
],
"additionalProperties": false
}