API docs by Redocly

Lytho API (V1.5.2)

Download OpenAPI specification:Download

lytho support: support@lytho.com URL: www.lytho.com License: Apache 2.0 Terms of Service

The Lytho API allows developers to safely and securely access information from Lytho. You can use this API to build private services and applications. To learn how to get your API key and create private applications, read our documentation about authorization. All endpoints are available via HTTPS and based on which region you are using, the API is located at

  • openapi.lytho.io - EU Region
  • openapi.us-1.lytho.us - US Region

For instance you can list all Assets using https://[region-hostname]/v1/assets/.

openapi

Get Collection

Retrieve a Collection from Lytho by providing the Id of this Collection

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
withoutTags
boolean
Default: false
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Update Collection

Update a Collection by providing collectionId that need to be updated and the new data.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
string
description
string
permissions
Array of integers <int64> unique [ items <int64 > ]
visibleToEveryone
boolean
object (ThumbnailUpdateRequest)
headerBackgroundColor
string
headerTextColor
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "permissions": [
    ],
  • "visibleToEveryone": true,
  • "thumbnail": {
    },
  • "headerBackgroundColor": "string",
  • "headerTextColor": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Delete Collection

Delete a Collection in Lytho by providing collectionId of Collection that needs to be deleted. The assets within the collection will not be deleted only the collection itself.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Add Permissions to Collection

Add Permissions to a Collection by providing the collectionId and a List of permissionIds to be added.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Replace all Permissions for a Collection

Replace all Permissions for a Collection by providing the collectionId and a List of permissionIds that will replace the current permissions.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Permissions from Collection

Remove Permissions from a Collection by providing the collectionId and a list of permissionIds to be removed.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Add Permission to Collection

Add a Permission to a Collection by providing the collectionId and permissionId to be added.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Permission from Collection

Remove a Permission from a Collection by providing the collectionId and permissionId to be removed.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Get Paginated Assets

Retrieve Paginated Assets from Lytho by providing the Collection Id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Add Assets to Collection

Add Assets to a Collection by providing the collectionId and list with assetIds to be added.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Replace all Assets in Collection

Replace all Assets within a Collection by providing the collectionId and a List of assetIds that will replace the current Assets.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Assets from Collection

Remove Assets from a Collection by providing the collectionId and list with assetIds to be removed.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Add Asset to Collection

Add an Asset to a Collection by providing the collectionId and assetId to be added.

Authorizations:
api_key
path Parameters
id
required
string
assetId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Asset from Collection

Remove an Asset from a Collection by providing the collectionId and assetId to be removed.

Authorizations:
api_key
path Parameters
id
required
string
assetId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Get Asset

Retrieve an Asset from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Update Asset

Update name, description and/or embargo data of an Asset by providing the id of the asset you want to update, and the updated data in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
string
description
string
object (UpdateEmbargoRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "embargo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Delete Asset

Delete an Asset in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Add Tags to Asset

Add existing Tags to an Asset in Lytho by providing list of tag ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Overwrite Tags

Overwrite Tags on an Asset by providing a list of Tag ids. Use this endpoint if you want to completely replace the set of Tags for a single Asset.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Tags

Remove Tags from an Asset by providing a list of Tag ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Add Tag to Asset

Add an existing Tag to an Asset in Lytho by providing tagId of Tag to be added and assetId of Asset where Tag will be added on.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Tag

Remove a Tag from an Asset by providing the Tag id.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Add Permissions

Add Permissions to an Asset by providing List of Permission ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Overwrite Permissions

Overwrite Permisisons on an Asset by providing a list of Permission ids. Use this endpoint if you want to completely replace the set of Permissions for a single Asset.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Permissions

Remove Permissions from an Asset by providing a List of Permission ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Add Permission

Add a Permission to an Asset by providing a Permission id.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Permission

Remove a Permission from an Asset by providing a Permission id.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Activate Asset file version

Update the Asset version by providing the id of the asset you want to update,and the id of existing version of that Asset in the request body.

Authorizations:
api_key
path Parameters
id
required
string
versionId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Update Custom Metadata

Update Custom Metadata from an Asset by providing an Asset id and custom metadata key.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
value
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Create Custom Metadata

Create Custom Metadata from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
value
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Delete Custom Metadata

Remove a Custom Metadata from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Get Collections

Retrieve a paged list of Collections from Lytho. Optionally searched for on name

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
name
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Create new Collection

Create a new Collection in Lytho

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string
description
string or null
visibleToEveryone
boolean or null
object or null (CollectionExternalThumbnailRequest)
assets
Array of strings or null or null
permissions
Array of integers or null or null <int64> unique
headerTextColor
string or null
headerBackgroundColor
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibleToEveryone": true,
  • "thumbnailRequest": {
    },
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string",
  • "headerBackgroundColor": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Get Collections

Retrieve a paged list of Collections from Lytho for a list of collectionIds.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete embedded link for given asset

Remove an embedded link from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Create Embedded link for original Asset

Create embedded link from an Asset by providing an Asset id.This embedded link is an embedded link for the original provided asset and can be used in the following way1. use link to get an embedded link with full dimensions 2. use width and height as url parameters to specify a width and/or height (f.e. width=200&height=200) 3. use crop as url parameters to specify if an image needs to be cropped (f.e. crop=true or crop=false) 4. from within Lytho also a focal point can be set for an embedded link these values can also be added as an url parameter using fx and fy parameters (f.e. fx=57.11805555555556&fy=30.512820512820515)

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "link": "string"
}

Delete embedded link for given original asset

Remove an embedded link from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset upload

Complete the asset upload process using the key retrieved from the /upload/link endpoint

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset file version upload

Complete the asset file version upload process using the id of an asset and the key retrieved from the /upload/link endpoint

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset upload

Complete the asset multipart upload process using the key retrieved from the /upload/link-multipart endpoint, the upload id and the aws eTags per part

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
uploadId
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "uploadId": "string",
  • "tagsByPart": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset upload

Complete the asset file version multipart upload process using the key retrieved from the /upload/link-multipart endpoint, the upload id and the aws eTags per part

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
uploadId
string or null
object or null
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "uploadId": "string",
  • "tagsByPart": {
    },
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Get Assets

Retrieve a list of Assets from Lytho by providing a list of ids. A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Paginated Tags

Retrieve Paginated Tags from Lytho by providing the Collection Id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Get Assets

Retrieve a paginated list of Assets from Lytho. Optionally filtered on exact filename and/or contain all given tag ids. A maximum of 50 Assets can be retrieved per request. All date fields are based on ISO-8601 format.

Authorizations:
api_key
query Parameters
fileName
string
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
creationDateFrom
string <date-time>
creationDateTo
string <date-time>
modificationDateFrom
string <date-time>
modificationDateTo
string <date-time>
tagIds
Array of strings
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Get Assets

Retrieve a paginated list of Assets from Lytho. Optionally filtered on exact filename. A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Get Asset statistics

Retrieve a paginated list of Asset statistics from Lytho using dates to filter specific periods. A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
from
required
string <date-time>
to
required
string <date-time>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Search Assets

Retrieve a paginated list of Assets from Lytho filtered on a given search term A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
query Parameters
searchQuery
string
Default: ""
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Update User pre-filled field one by one

add a value and a field type to save a pre-filled field, the field type need to be compatible with the field type of the pre-filled field we are updating.

Authorizations:
api_key
path Parameters
userId
required
string
fieldId
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
value
required
string
fieldType
required
string
Enum: "TEXT" "FILE"

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "fieldType": "TEXT"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Get Permission

Retrieve a Permissions from Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Update Permission

Update Permission by providing the id of the Permission you want to update, and the updated data in the request body.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Delete Permission

Delete a Permission in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Get Permissions

Retrieve a paginated list of Permissions from Lytho. A maximum of 50Permissions can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "last": true,
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Create Permission

Create a Permission in Lytho by providing its representation in the request body If a Permission already exists an error is thrown.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get or Create Permission by name

Retrieve a Permission from Lytho by providing its name. If Permission cannot be found it will be created.

Authorizations:
api_key
path Parameters
name
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Permissions by ids

Retrieve a list of Permissions from Lytho by providing a list of ids. A maximum of 50 Permissions can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Users by Creation date range

Retrieve a paginated list of Users from Lytho. Specific periods can be filtered by using dates. A maximum of 50 Users can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
from
string <date-time>
to
string <date-time>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "last": true,
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get User pre-filled fields

Retrieve a list of all pre-filled fields coupled to a Users, if no fields are present value will be returned as a null value and only field name, description and type are present.

Authorizations:
api_key
path Parameters
userId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Permission by name

Retrieve a Permission from Lytho by providing its name.

Authorizations:
api_key
path Parameters
name
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Add Permission

Add a Permission to a Template by providing a Permission id.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
query Parameters
includePermissions
boolean
Default: false
includeTags
boolean
Default: false
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fields": [
    ],
  • "permissions": [
    ],
  • "tags": [
    ]
}

removePermission

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
query Parameters
includePermissions
boolean
Default: false
includeTags
boolean
Default: false
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fields": [
    ],
  • "permissions": [
    ],
  • "tags": [
    ]
}

Get File upload link

This endpoint is used in the following manner to upload a file for use in a publication:1. Get upload link by providing a file name and its content-type

  1. Use the upload link to upload the file, include the content-type header to match the content type of step 1

  2. Use the key from step 1 to notify the backend the file was uploaded by supplying it to the create publication endpoint in the desired asset field value.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
fileName
required
string
contentType
required
string

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "contentType": "string"
}

Response samples

Content type
application/json
{
  • "uploadLink": "string",
  • "objectKey": "string",
  • "exp": 0
}

Create a publication and fill fields

This endpoint is used to both create a publication and update the publication fields.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
id
required
string
required
Array of objects (PublicationExternalFieldRequest)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ],
  • "outputs": [
    ]
}

Generate all outputs for a publication

This endpoint starts the generation process for all outputs that can be generated for a publication. This relates to the different input idmls available in the publication.Each output is split into different formats (png, jpg, pdf, etc..) which will be produces and can be downloaded in bulk by output.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "publication": {
    },
  • "outputPollEndpoints": [
    ]
}

Generate a pdf output for a publication with a webhook

This endpoint starts the generation process for a pdf output that can be generated for a publication. Each output of a template relates to a different input idml. Each Output can have multiple OutputFormats, an OutputFormat defines what should be generated (PDF, PNG etc.)

Authorizations:
api_key
path Parameters
id
required
string
outputId
required
string
outputFormatId
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
webhook
string or null
authorization
string or null

Responses

Request samples

Content type
application/json
{
  • "webhook": "string",
  • "authorization": "string"
}

Response samples

Content type
application/json
{
  • "publication": {
    },
  • "outputPollEndpoints": [
    ]
}

Get template

Retrieve a Template from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
includePermissions
boolean
Default: false
includeTags
boolean
Default: false
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fields": [
    ],
  • "permissions": [
    ],
  • "tags": [
    ]
}

Get Publishing statistics

Retrieve a paginated list of Publishing statistics from Lytho using dates to filter specific periods. A maximum of 50 entries can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
from
required
string <date-time>
to
required
string <date-time>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Polling endpoint for generating outputs

This endpoint is used to poll the progress of the generation of a publications output. It will provide either a progress boolean and when complete a link for retrieving the download link

Authorizations:
api_key
path Parameters
id
required
string
outputId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "doneProcessing": true,
  • "successful": true,
  • "downloadLinkResponses": [
    ]
}

Get Publication Downloads

Retrieve a paginated list of PDF outputs for a publication from Lytho. Optionally filtered on given tag ids. A maximum of 50 Publication PDF outputs can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
creationDateFrom
string <date-time>
creationDateTo
string <date-time>
modificationDateFrom
string <date-time>
modificationDateTo
string <date-time>
tagIds
Array of strings
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Get Tag by id

Retrieve a Tag from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Update Tag

Update name of a Tag by providing the id of the Tag you want to update, and the updated data in the request body. Optionally a locale can be provided to update the tag for this locale, if no locale is provided the default locale will be used.

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Delete Tag

Delete a Tag in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Update Tag translations

Update translations of a Tag by providing the id of the Tag you want to update, and the updated translations data in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "nameByLocale": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get Tag

Retrieve a Taggroup from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Update Taggroup

Update a Taggroup by providing id of Taggroup you want to update, and the updated data in the request body. Optionally a locale can be provided to update the tag for this locale, if no locale is provided the default locale will be used.

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Delete Taggroup

Delete a Taggroup in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Update Taggroup translations

Update translations of a Taggroup by providing the id of the Taggroup you want to update, and the updated translations data in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "nameByLocale": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Tag

Retrieve a Tags from a tagGroup by providing its id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "empty": true
}

Add Tags to Taggroup

Add multiple Tags to a Taggroup in Lytho by providing the taggroup Id and a list of tag Ids in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Overwrite tags of a Taggroup

Overwrite Tags from a Taggroup in Lytho by providing the taggroup Id and tag Ids as a request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Remove Tags from Taggroup

Remove Tags from a Taggroup in Lytho by providing the taggroup Id and tag Ids as a request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Add Tag to Taggroup

Add a Tag to a Taggroup in Lytho by providing the taggroup Id and tag Id.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Remove Tag from Taggroup

Remove a Tag from a Taggroup in Lytho by providing the taggroup Id and tag Id.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Tags

Retrieve a paginated list of Tags from Lytho.A maximum of 50 Tags can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "empty": true
}

Create Tag

Create a Tag in Lytho by providing its name. Optionally locale can be provided, if no locale is provided the default locale will be used. If a Tag already exists an error is thrown.

Authorizations:
api_key
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get or Create Tag

Retrieve a Tag from Lytho by providing its name. Optionally locale to search in can be provided, if no locale is provided the default locale will be used. If Tag cannot be found it will be created.

Authorizations:
api_key
path Parameters
name
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get Tag by name

Retrieve a Tag from Lytho by providing its name in the request body. Optionally locale to search in can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get Tags by ids

Retrieve a list of Tags from Lytho by providing a list of ids. A maximum of 50 Tags can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Taggroups

Retrieve a paginated list of Taggroups from Lytho.A maximum of 50 Taggroups can be retrieved per request. Optionally a specific taggroup name and/or locale to search in can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
name
string
locale
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "empty": true
}

Create Taggroups

Create a Taggroup in Lytho by providing the data in the request body. Optionally locale can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Taggroups

Retrieve a list of Taggroups from Lytho by providing a list of ids. A maximum of 50 Taggroups can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Tag by name

Retrieve a Tag from Lytho by providing its name. Optionally locale to search in can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
path Parameters
name
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Collections

Get Collection

Retrieve a Collection from Lytho by providing the Id of this Collection

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
withoutTags
boolean
Default: false
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Update Collection

Update a Collection by providing collectionId that need to be updated and the new data.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
string
description
string
permissions
Array of integers <int64> unique [ items <int64 > ]
visibleToEveryone
boolean
object (ThumbnailUpdateRequest)
headerBackgroundColor
string
headerTextColor
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "permissions": [
    ],
  • "visibleToEveryone": true,
  • "thumbnail": {
    },
  • "headerBackgroundColor": "string",
  • "headerTextColor": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Delete Collection

Delete a Collection in Lytho by providing collectionId of Collection that needs to be deleted. The assets within the collection will not be deleted only the collection itself.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Add Permissions to Collection

Add Permissions to a Collection by providing the collectionId and a List of permissionIds to be added.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Replace all Permissions for a Collection

Replace all Permissions for a Collection by providing the collectionId and a List of permissionIds that will replace the current permissions.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Permissions from Collection

Remove Permissions from a Collection by providing the collectionId and a list of permissionIds to be removed.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Add Permission to Collection

Add a Permission to a Collection by providing the collectionId and permissionId to be added.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Permission from Collection

Remove a Permission from a Collection by providing the collectionId and permissionId to be removed.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Get Paginated Assets

Retrieve Paginated Assets from Lytho by providing the Collection Id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Add Assets to Collection

Add Assets to a Collection by providing the collectionId and list with assetIds to be added.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Replace all Assets in Collection

Replace all Assets within a Collection by providing the collectionId and a List of assetIds that will replace the current Assets.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Assets from Collection

Remove Assets from a Collection by providing the collectionId and list with assetIds to be removed.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Add Asset to Collection

Add an Asset to a Collection by providing the collectionId and assetId to be added.

Authorizations:
api_key
path Parameters
id
required
string
assetId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Remove Asset from Collection

Remove an Asset from a Collection by providing the collectionId and assetId to be removed.

Authorizations:
api_key
path Parameters
id
required
string
assetId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Get Collections

Retrieve a paged list of Collections from Lytho. Optionally searched for on name

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
name
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Create new Collection

Create a new Collection in Lytho

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string
description
string or null
visibleToEveryone
boolean or null
object or null (CollectionExternalThumbnailRequest)
assets
Array of strings or null or null
permissions
Array of integers or null or null <int64> unique
headerTextColor
string or null
headerBackgroundColor
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "visibleToEveryone": true,
  • "thumbnailRequest": {
    },
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string",
  • "headerBackgroundColor": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tags": [
    ],
  • "name": "string",
  • "description": "string",
  • "header": {
    },
  • "visibleToEveryone": true,
  • "assets": [
    ],
  • "permissions": [
    ],
  • "headerTextColor": "string"
}

Get Collections

Retrieve a paged list of Collections from Lytho for a list of collectionIds.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Paginated Tags

Retrieve Paginated Tags from Lytho by providing the Collection Id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

cors

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string
permissionId
required
integer <int64>

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string
assetId
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string
tagId
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string
permissionId
required
integer <int64>

Responses

Enable Cors

path Parameters
id
required
string
versionId
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

path Parameters
userId
required
string
fieldId
required
string

Responses

Enable Cors

path Parameters
id
required
integer <int64>

Responses

Enable Cors

Responses

Enable Cors

path Parameters
name
required
string

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

path Parameters
userId
required
string

Responses

Enable Cors

path Parameters
name
required
string

Responses

Enable Cors

path Parameters
id
required
string
permissionId
required
integer <int64>

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string
outputId
required
string
outputFormatId
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string
outputId
required
string

Responses

Enable Cors

path Parameters
id
required
string
outputId
required
string

Responses

Enable Cors

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string

Responses

Enable Cors

path Parameters
id
required
string
tagId
required
string

Responses

Enable Cors

Responses

Enable Cors

path Parameters
name
required
string

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

Responses

Enable Cors

path Parameters
name
required
string

Responses

Assets

Get Asset

Retrieve an Asset from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Update Asset

Update name, description and/or embargo data of an Asset by providing the id of the asset you want to update, and the updated data in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
string
description
string
object (UpdateEmbargoRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "embargo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Delete Asset

Delete an Asset in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Add Tags to Asset

Add existing Tags to an Asset in Lytho by providing list of tag ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Overwrite Tags

Overwrite Tags on an Asset by providing a list of Tag ids. Use this endpoint if you want to completely replace the set of Tags for a single Asset.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Tags

Remove Tags from an Asset by providing a list of Tag ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Add Tag to Asset

Add an existing Tag to an Asset in Lytho by providing tagId of Tag to be added and assetId of Asset where Tag will be added on.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Tag

Remove a Tag from an Asset by providing the Tag id.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Add Permissions

Add Permissions to an Asset by providing List of Permission ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Overwrite Permissions

Overwrite Permisisons on an Asset by providing a list of Permission ids. Use this endpoint if you want to completely replace the set of Permissions for a single Asset.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Permissions

Remove Permissions from an Asset by providing a List of Permission ids as the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Add Permission

Add a Permission to an Asset by providing a Permission id.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Remove Permission

Remove a Permission from an Asset by providing a Permission id.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Activate Asset file version

Update the Asset version by providing the id of the asset you want to update,and the id of existing version of that Asset in the request body.

Authorizations:
api_key
path Parameters
id
required
string
versionId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Update Custom Metadata

Update Custom Metadata from an Asset by providing an Asset id and custom metadata key.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
value
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Create Custom Metadata

Create Custom Metadata from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
value
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Delete Custom Metadata

Remove a Custom Metadata from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Delete embedded link for given asset

Remove an embedded link from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Create Embedded link for original Asset

Create embedded link from an Asset by providing an Asset id.This embedded link is an embedded link for the original provided asset and can be used in the following way1. use link to get an embedded link with full dimensions 2. use width and height as url parameters to specify a width and/or height (f.e. width=200&height=200) 3. use crop as url parameters to specify if an image needs to be cropped (f.e. crop=true or crop=false) 4. from within Lytho also a focal point can be set for an embedded link these values can also be added as an url parameter using fx and fy parameters (f.e. fx=57.11805555555556&fy=30.512820512820515)

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "link": "string"
}

Delete embedded link for given original asset

Remove an embedded link from an Asset by providing an Asset id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset upload

Complete the asset upload process using the key retrieved from the /upload/link endpoint

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset file version upload

Complete the asset file version upload process using the id of an asset and the key retrieved from the /upload/link endpoint

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset upload

Complete the asset multipart upload process using the key retrieved from the /upload/link-multipart endpoint, the upload id and the aws eTags per part

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
uploadId
string or null
object or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "uploadId": "string",
  • "tagsByPart": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Finalize asset upload

Complete the asset file version multipart upload process using the key retrieved from the /upload/link-multipart endpoint, the upload id and the aws eTags per part

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
key
required
string
uploadId
string or null
object or null
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "uploadId": "string",
  • "tagsByPart": {
    },
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "fileType": "string",
  • "assetType": "string",
  • "status": {
    },
  • "statusChange": {
    },
  • "name": "string",
  • "fileName": "string",
  • "description": "string",
  • "tags": [
    ],
  • "metadata": {
    },
  • "permissions": [
    ],
  • "relations": [
    ],
  • "copyright": {
    },
  • "processing": true,
  • "version": 0,
  • "fileVersions": [
    ],
  • "height": 0,
  • "width": 0,
  • "size": 0,
  • "extension": "string",
  • "useTimeFrameStart": "2019-08-24T14:15:22Z",
  • "useTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameStart": "2019-08-24T14:15:22Z",
  • "visibleTimeFrameEnd": "2019-08-24T14:15:22Z",
  • "embeddedLink": {
    }
}

Get Assets

Retrieve a list of Assets from Lytho by providing a list of ids. A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Assets

Retrieve a paginated list of Assets from Lytho. Optionally filtered on exact filename and/or contain all given tag ids. A maximum of 50 Assets can be retrieved per request. All date fields are based on ISO-8601 format.

Authorizations:
api_key
query Parameters
fileName
string
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
creationDateFrom
string <date-time>
creationDateTo
string <date-time>
modificationDateFrom
string <date-time>
modificationDateTo
string <date-time>
tagIds
Array of strings
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Get Assets

Retrieve a paginated list of Assets from Lytho. Optionally filtered on exact filename. A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Search Assets

Retrieve a paginated list of Assets from Lytho filtered on a given search term A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
query Parameters
searchQuery
string
Default: ""
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Assets statistics

Get Asset statistics

Retrieve a paginated list of Asset statistics from Lytho using dates to filter specific periods. A maximum of 50 Assets can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
from
required
string <date-time>
to
required
string <date-time>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Users

Update User pre-filled field one by one

add a value and a field type to save a pre-filled field, the field type need to be compatible with the field type of the pre-filled field we are updating.

Authorizations:
api_key
path Parameters
userId
required
string
fieldId
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
value
required
string
fieldType
required
string
Enum: "TEXT" "FILE"

Responses

Request samples

Content type
application/json
{
  • "value": "string",
  • "fieldType": "TEXT"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Get Users by Creation date range

Retrieve a paginated list of Users from Lytho. Specific periods can be filtered by using dates. A maximum of 50 Users can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
from
string <date-time>
to
string <date-time>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "last": true,
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Get User pre-filled fields

Retrieve a list of all pre-filled fields coupled to a Users, if no fields are present value will be returned as a null value and only field name, description and type are present.

Authorizations:
api_key
path Parameters
userId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Permissions

Get Permission

Retrieve a Permissions from Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Update Permission

Update Permission by providing the id of the Permission you want to update, and the updated data in the request body.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Delete Permission

Delete a Permission in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
integer <int64>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Get Permissions

Retrieve a paginated list of Permissions from Lytho. A maximum of 50Permissions can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "last": true,
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Create Permission

Create a Permission in Lytho by providing its representation in the request body If a Permission already exists an error is thrown.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get or Create Permission by name

Retrieve a Permission from Lytho by providing its name. If Permission cannot be found it will be created.

Authorizations:
api_key
path Parameters
name
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Permissions by ids

Retrieve a list of Permissions from Lytho by providing a list of ids. A maximum of 50 Permissions can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of integers <int64> unique [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Permission by name

Retrieve a Permission from Lytho by providing its name.

Authorizations:
api_key
path Parameters
name
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Publish Templates

Add Permission

Add a Permission to a Template by providing a Permission id.

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
query Parameters
includePermissions
boolean
Default: false
includeTags
boolean
Default: false
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fields": [
    ],
  • "permissions": [
    ],
  • "tags": [
    ]
}

removePermission

Authorizations:
api_key
path Parameters
id
required
string
permissionId
required
integer <int64>
query Parameters
includePermissions
boolean
Default: false
includeTags
boolean
Default: false
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fields": [
    ],
  • "permissions": [
    ],
  • "tags": [
    ]
}

Get template

Retrieve a Template from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
includePermissions
boolean
Default: false
includeTags
boolean
Default: false
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "fields": [
    ],
  • "permissions": [
    ],
  • "tags": [
    ]
}

Publish Publication

Get File upload link

This endpoint is used in the following manner to upload a file for use in a publication:1. Get upload link by providing a file name and its content-type

  1. Use the upload link to upload the file, include the content-type header to match the content type of step 1

  2. Use the key from step 1 to notify the backend the file was uploaded by supplying it to the create publication endpoint in the desired asset field value.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
fileName
required
string
contentType
required
string

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "contentType": "string"
}

Response samples

Content type
application/json
{
  • "uploadLink": "string",
  • "objectKey": "string",
  • "exp": 0
}

Create a publication and fill fields

This endpoint is used to both create a publication and update the publication fields.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
id
required
string
required
Array of objects (PublicationExternalFieldRequest)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ],
  • "outputs": [
    ]
}

Generate all outputs for a publication

This endpoint starts the generation process for all outputs that can be generated for a publication. This relates to the different input idmls available in the publication.Each output is split into different formats (png, jpg, pdf, etc..) which will be produces and can be downloaded in bulk by output.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "publication": {
    },
  • "outputPollEndpoints": [
    ]
}

Generate a pdf output for a publication with a webhook

This endpoint starts the generation process for a pdf output that can be generated for a publication. Each output of a template relates to a different input idml. Each Output can have multiple OutputFormats, an OutputFormat defines what should be generated (PDF, PNG etc.)

Authorizations:
api_key
path Parameters
id
required
string
outputId
required
string
outputFormatId
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
webhook
string or null
authorization
string or null

Responses

Request samples

Content type
application/json
{
  • "webhook": "string",
  • "authorization": "string"
}

Response samples

Content type
application/json
{
  • "publication": {
    },
  • "outputPollEndpoints": [
    ]
}

Polling endpoint for generating outputs

This endpoint is used to poll the progress of the generation of a publications output. It will provide either a progress boolean and when complete a link for retrieving the download link

Authorizations:
api_key
path Parameters
id
required
string
outputId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "doneProcessing": true,
  • "successful": true,
  • "downloadLinkResponses": [
    ]
}

Get Publication Downloads

Retrieve a paginated list of PDF outputs for a publication from Lytho. Optionally filtered on given tag ids. A maximum of 50 Publication PDF outputs can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
creationDateFrom
string <date-time>
creationDateTo
string <date-time>
modificationDateFrom
string <date-time>
modificationDateTo
string <date-time>
tagIds
Array of strings
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Publishing statistics

Get Publishing statistics

Retrieve a paginated list of Publishing statistics from Lytho using dates to filter specific periods. A maximum of 50 entries can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
from
required
string <date-time>
to
required
string <date-time>
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "pageable": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "last": true,
  • "empty": true
}

Tags

Get Tag by id

Retrieve a Tag from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Update Tag

Update name of a Tag by providing the id of the Tag you want to update, and the updated data in the request body. Optionally a locale can be provided to update the tag for this locale, if no locale is provided the default locale will be used.

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Delete Tag

Delete a Tag in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Update Tag translations

Update translations of a Tag by providing the id of the Tag you want to update, and the updated translations data in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "nameByLocale": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get Tags

Retrieve a paginated list of Tags from Lytho.A maximum of 50 Tags can be retrieved per request.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "empty": true
}

Create Tag

Create a Tag in Lytho by providing its name. Optionally locale can be provided, if no locale is provided the default locale will be used. If a Tag already exists an error is thrown.

Authorizations:
api_key
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get or Create Tag

Retrieve a Tag from Lytho by providing its name. Optionally locale to search in can be provided, if no locale is provided the default locale will be used. If Tag cannot be found it will be created.

Authorizations:
api_key
path Parameters
name
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get Tag by name

Retrieve a Tag from Lytho by providing its name in the request body. Optionally locale to search in can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Get Tags by ids

Retrieve a list of Tags from Lytho by providing a list of ids. A maximum of 50 Tags can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Tag by name

Retrieve a Tag from Lytho by providing its name. Optionally locale to search in can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
path Parameters
name
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "tagGroupId": "string"
}

Taggroups

Get Tag

Retrieve a Taggroup from Lytho by providing its id

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Update Taggroup

Update a Taggroup by providing id of Taggroup you want to update, and the updated data in the request body. Optionally a locale can be provided to update the tag for this locale, if no locale is provided the default locale will be used.

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Delete Taggroup

Delete a Taggroup in Lytho by providing its id.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "traceId": "string"
}

Update Taggroup translations

Update translations of a Taggroup by providing the id of the Taggroup you want to update, and the updated translations data in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "nameByLocale": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Tag

Retrieve a Tags from a tagGroup by providing its id

Authorizations:
api_key
path Parameters
id
required
string
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "empty": true
}

Add Tags to Taggroup

Add multiple Tags to a Taggroup in Lytho by providing the taggroup Id and a list of tag Ids in the request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Overwrite tags of a Taggroup

Overwrite Tags from a Taggroup in Lytho by providing the taggroup Id and tag Ids as a request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Remove Tags from Taggroup

Remove Tags from a Taggroup in Lytho by providing the taggroup Id and tag Ids as a request body.

Authorizations:
api_key
path Parameters
id
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Add Tag to Taggroup

Add a Tag to a Taggroup in Lytho by providing the taggroup Id and tag Id.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string
content-type
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Remove Tag from Taggroup

Remove a Tag from a Taggroup in Lytho by providing the taggroup Id and tag Id.

Authorizations:
api_key
path Parameters
id
required
string
tagId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Taggroups

Retrieve a paginated list of Taggroups from Lytho.A maximum of 50 Taggroups can be retrieved per request. Optionally a specific taggroup name and/or locale to search in can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
query Parameters
page
integer <int32>
Default: 0
size
integer <int32>
Default: 20
name
string
locale
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "totalPages": 0,
  • "totalElements": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": {
    },
  • "first": true,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "last": true,
  • "empty": true
}

Create Taggroups

Create a Taggroup in Lytho by providing the data in the request body. Optionally locale can be provided, if no locale is provided the default locale will be used.

Authorizations:
api_key
query Parameters
locale
string
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "nameTranslation": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z"
}

Get Taggroups

Retrieve a list of Taggroups from Lytho by providing a list of ids. A maximum of 50 Taggroups can be retrieved per request.

Authorizations:
api_key
header Parameters
x-api-key
required
string
content-type
string
Request Body schema: application/json
ids
required
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]