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 #

ab641314d86009b37ebfc019ea4eb98740f035f4

Changelog ¶

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 ¶

Requests to the API have to be authenticated using an API token which is received after successfully providing your application credentials to the API.

Once acquired the token can either be provided as…

1. set in the Authorization header using other tools, or
2. the username field for HTTP-Basic authentication (Only available when IAM Feature is disabled)

The following examples illustrate the two different ways to provide the token when using curl

# via Authorization header

# Preferred approach -
> curl -H "Authorization: Bearer $LABFOLDER_API_TOKEN" <API_RESOURCE_PATH_GOES_HERE>

# OR deprecated approach -
> curl -H "Authorization: Bearer $LABFOLDER_API_TOKEN" <API_RESOURCE_PATH_GOES_HERE>

# via HTTP-Basic (Only available when IAM Feature is disabled)
# Note the proceeding ':'

> curl -u "$LABFOLDER_API_TOKEN:" <API_RESOURCE_PATH_GOES_HERE>

Content-Type: application/json

{
  "user": "luke.skywalker@starwars.com",
  "password": "password"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8

{
  "token": "MTZmNTigNWMtNWJ34y00NDgwL12wM2ItZTM4NzFGYzU1NTJm",
  "expires": "2017-09-04T13:27:55.641+0200"
}

{
  "$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"
  ]
}

Concepts ¶

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.tld

if 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=-title

The 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: gzip

if 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

OR

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 ¶

Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0

[
  {
    "title": "Luke's Private Group",
    "description": "This group is intended to be used for private projects",
    "id": "46123",
    "owner_id": "11038",
    "type": "BASIC",
    "creation_date": "2017-02-10T12:34:56.789+0200",
    "version_date": "2017-02-15T12:34:56.789+0200"
  }
]

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string",
        "description": "the display title of the group"
      },
      "description": {
        "type": "string",
        "description": "details about the group usage, functionality, etc."
      },
      "id": {
        "type": "string",
        "description": "the unique id of the group"
      },
      "owner_id": {
        "type": "string",
        "description": "the id of the group owner"
      },
      "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"
      }
    },
    "required": [
      "title",
      "id",
      "owner_id",
      "type",
      "creation_date",
      "version_date"
    ]
  }
}

Content-Type: application/json;charset=UTF-8

{
  "title": "Luke's Private Group",
  "description": "This group is intended to be used for private projects",
  "id": "46123",
  "owner_id": "11038",
  "type": "BASIC",
  "creation_date": "2017-02-10T12:34:56.789+0200",
  "version_date": "2017-02-15T12:34:56.789+0200"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "the display title of the group"
    },
    "description": {
      "type": "string",
      "description": "details about the group usage, functionality, etc."
    },
    "id": {
      "type": "string",
      "description": "the unique id of the group"
    },
    "owner_id": {
      "type": "string",
      "description": "the id of the group owner"
    },
    "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"
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "type",
    "creation_date",
    "version_date"
  ],
  "additionalProperties": false
}

Content-Type: application/json;charset=UTF-8

{
  "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": "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
}

Content-Type: application/json;charset=UTF-8

[
  {
    "id": "12585",
    "title": "Rogue One",
    "group_id": "1200",
    "parent_id": "12587"
  }
]

{
  "$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"
    ]
  }
}

Content-Type: application/json;charset=UTF-8

[
  {
    "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": "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"
    ]
  }
}

Content-Type: application/json;charset=UTF-8

{
  "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": "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
}

Content-Type: application/json

{
  "email": "princess.leia@starwars.com",
  "group_id": "1203"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /group-memberships/12585

{
  "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": "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
}

Content-Type: application/json

{
  "email": "han.solo@starwars.com",
  "group_id": "1203",
  "subgroup_id": "235"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /group-memberships/12585

{
  "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": "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
}

Projects ¶

Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0

[
  {
    "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
  }
]

{
  "$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."
      }
    },
    "required": [
      "title",
      "id",
      "owner_id",
      "group_id",
      "folder_id",
      "hidden",
      "creation_date",
      "version_date",
      "collaborative"
    ]
  }
}

Content-Type: application/json

{
  "title": "Luke's Private Project"
}

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "the display name of the project"
    }
  },
  "required": [
    "title"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /projects/1234

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ]
}

Content-Type: application/json

{
  "title": "Luke's Private Project",
  "folder_id": "36273"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /projects/1234

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ]
}

Content-Type: application/json

{
  "title": "Luke's Private Project",
  "group_id": "1200"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /projects/1234

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ]
}

Content-Type: application/json

{
  "title": "Luke's Private Project",
  "folder_id": "36274",
  "group_id": "1200"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /projects/1234

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ]
}

Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/owner_id",
    "value": "3130"
  }
]

{
  "$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"
    ]
  }
}

Content-Type: application/json;charset=UTF-8

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ],
  "additionalProperties": false
}

Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/folder_id",
    "value": "36284"
  }
]

{
  "$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"
      }
    },
    "required": [
      "op",
      "path",
      "value"
    ]
  }
}

Content-Type: application/json;charset=UTF-8

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ],
  "additionalProperties": false
}

Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/hidden",
    "value": false
  }
]

{
  "$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",
        "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"
    ]
  }
}

Content-Type: application/json;charset=UTF-8

{
  "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
}

{
  "$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."
    }
  },
  "required": [
    "title",
    "id",
    "owner_id",
    "group_id",
    "folder_id",
    "hidden",
    "creation_date",
    "version_date",
    "collaborative"
  ],
  "additionalProperties": false
}

Content-Type: application/json

{
  "project_id": "36275",
  "group_membership_ids": [
    "3127",
    "3129"
  ],
  "subgroup_ids": [
    "234"
  ],
  "full_group_access": false,
  "collaborative": false
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8

{
  "project_id": "36275",
  "group_membership_ids": [
    "3127",
    "3129"
  ],
  "subgroup_ids": [
    "234"
  ],
  "full_group_access": false,
  "collaborative": false
}

{
  "$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
}

Folders ¶

Content-Type: application/json;charset=UTF-8
X-Total-Count: 1
X-Limit: 20
X-Offset: 0

[
  {
    "id": "46123",
    "title": "Luke's Folder",
    "owner_id": "11038",
    "group_id": "1200",
    "parent_folder_id": "null",
    "hidden": false,
    "content_type": "Hello, world!",
    "creation_date": "2017-02-10T12:34:56.789+0200",
    "version_date": "2017-02-15T12:34:56.789+0200"
  }
]

{
  "$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",
          "PROJECTS"
        ],
        "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"
    ]
  }
}

Content-Type: application/json

{
  "title": "Luke's Private Folder",
  "content_type": "PROJECTS"
}

{
  "$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",
        "PROJECTS"
      ],
      "default": "PROJECTS",
      "description": "indicate if the folder should hold Projects or Templates"
    }
  },
  "required": [
    "title"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /folders/46123

{
  "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": "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",
        "PROJECTS"
      ],
      "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"
  ]
}

Content-Type: application/json

{
  "title": "Luke's Private Folder",
  "content_type": "TEMPLATES"
}

{
  "$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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /folders/46123

{
  "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": "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"
  ]
}

Content-Type: application/json

{
  "title": "Luke's Private Folder",
  "content_type": "PROJECTS",
  "parent_folder_id": "36273"
}

{
  "$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",
        "PROJECTS"
      ],
      "default": "PROJECTS",
      "description": "indicate if the folder should hold Projects or Templates"
    },
    "parent_folder_id": {
      "type": "string"
    }
  },
  "required": [
    "title",
    "parent_folder_id"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /folders/46123

{
  "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": "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",
        "PROJECTS"
      ],
      "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"
  ]
}

Content-Type: application/json

{
  "title": "Group Folder",
  "content_type": "PROJECTS",
  "group_id": "1200"
}

{
  "$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",
        "PROJECTS"
      ],
      "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"
  ]
}

Content-Type: application/json;charset=UTF-8
Location: /folders/46123

{
  "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": "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",
        "PROJECTS"
      ],
      "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"
  ]
}