lianadeveloper
API docs by Redocly

LianaCMS REST API (3.0)

Download OpenAPI specification:Download

API Documentation for LianaCMS REST v. 3

Authentication

Liana CMS REST API supports Token based authentication. Token is included with header X-Auth-Token.

Users

Returns all users that match given filters

Fields from firstname to iban are only returned if Account module is enabled

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

group_id
Array of integers non-empty

Groups to search by id. Example group_id[]=4&group_id[]=7

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "first": {},
  • "prev": {},
  • "next": {},
  • "items": [
    ],
  • "meta": {
    }
}

Create new user

Fields from firstname to iban are only available if Account module is enabled

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
groups
required
Array of integers
username
required
string
email
required
string
name
required
string
active
boolean
Default: true
valid_to
string <date-time>
password
string >= 8 characters
firstname
string
lastname
string
birthdate
string <date-time>
city
string
address1
string
address2
string
address3
string
address4
string
postalcode
string
description
string
avatar
string
extra1
string
extra2
string
extra3
string
sex
string or null
Default: null
Enum: "m" "f"
phone
string
company_name
string
company_code
string
company_address
string
company_city
string
company_postalcode
string
company_phone
string
company_www
string
company_field
string
company_size
string
company_state
string
company_country
string
some1
string
some2
string
some3
string
ssn
string
iban
string

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "username": "user21",
  • "email": "john.tester@test.com",
  • "name": "John",
  • "active": true,
  • "valid_to": "2045-02-04T05:24:28Z",
  • "password": "LJHADGUS",
  • "firstname": "John",
  • "lastname": "Tester",
  • "birthdate": "1947-02-04T05:24:28Z",
  • "city": "Enontekiö",
  • "address1": "Kansankatu",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "postalcode": "90250",
  • "description": "Tester",
  • "avatar": "string",
  • "extra1": "string",
  • "extra2": "string",
  • "extra3": "string",
  • "sex": "m",
  • "phone": "string",
  • "company_name": "string",
  • "company_code": "string",
  • "company_address": "string",
  • "company_city": "string",
  • "company_postalcode": "string",
  • "company_phone": "string",
  • "company_www": "string",
  • "company_field": "string",
  • "company_size": "string",
  • "company_state": "string",
  • "company_country": "string",
  • "some1": "string",
  • "some2": "string",
  • "some3": "string",
  • "ssn": "string",
  • "iban": "string"
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Return specified user

Fields from firstname to iban are only returned if Account module is enabled

Authorizations:
ApiTokenKeyAuth
path Parameters
user-id
required
integer

Id of user

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Edit specified user

Fields from firstname to iban are only editable if Account module is enabled. password field is returned only with new password.

Authorizations:
ApiTokenKeyAuth
path Parameters
user-id
required
integer

Id of user

Request Body schema: application/json
groups
Array of integers
username
string
email
string
name
string
active
boolean
Default: true
valid_to
string <date-time>
password
string >= 8 characters
firstname
string
lastname
string
birthdate
string <date-time>
city
string
address1
string
address2
string
address3
string
address4
string
postalcode
string
description
string
avatar
string
extra1
string
extra2
string
extra3
string
sex
string or null
Default: null
Enum: "m" "f"
phone
string
company_name
string
company_code
string
company_address
string
company_city
string
company_postalcode
string
company_phone
string
company_www
string
company_field
string
company_size
string
company_state
string
company_country
string
some1
string
some2
string
some3
string
ssn
string
iban
string

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ],
  • "username": "user21",
  • "email": "john.tester@test.com",
  • "name": "John",
  • "active": true,
  • "valid_to": "2045-02-04T05:24:28Z",
  • "password": "LJHADGUS",
  • "firstname": "John",
  • "lastname": "Tester",
  • "birthdate": "1947-02-04T05:24:28Z",
  • "city": "Enontekiö",
  • "address1": "Kansankatu",
  • "address2": "string",
  • "address3": "string",
  • "address4": "string",
  • "postalcode": "90250",
  • "description": "Tester",
  • "avatar": "string",
  • "extra1": "string",
  • "extra2": "string",
  • "extra3": "string",
  • "sex": "m",
  • "phone": "string",
  • "company_name": "string",
  • "company_code": "string",
  • "company_address": "string",
  • "company_city": "string",
  • "company_postalcode": "string",
  • "company_phone": "string",
  • "company_www": "string",
  • "company_field": "string",
  • "company_size": "string",
  • "company_state": "string",
  • "company_country": "string",
  • "some1": "string",
  • "some2": "string",
  • "some3": "string",
  • "ssn": "string",
  • "iban": "string"
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Delete specified user

Authorizations:
ApiTokenKeyAuth
path Parameters
user-id
required
integer

Id of user

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Starts process to insert multiple users.

Fields from firstname to iban are only available if Account module is enabled

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
groups
required
Array of integers
username
required
string
email
required
string
name
required
string
active
boolean
Default: true
valid_to
string <date-time>
password
required
string >= 8 characters
firstname
string
lastname
string
birthdate
string <date-time>
city
string
address1
string
address2
string
address3
string
address4
string
postalcode
string
description
string
avatar
string
extra1
string
extra2
string
extra3
string
sex
string or null
Default: null
Enum: "m" "f"
phone
string
company_name
string
company_code
string
company_address
string
company_city
string
company_postalcode
string
company_phone
string
company_www
string
company_field
string
company_size
string
company_state
string
company_country
string
some1
string
some2
string
some3
string
ssn
string
iban
string

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple users.

Fields from firstname to iban are only available if Account module is enabled

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
groups
Array of integers
username
string
email
string
name
string
active
boolean
Default: true
valid_to
string <date-time>
password
string >= 8 characters
firstname
string
lastname
string
birthdate
string <date-time>
city
string
address1
string
address2
string
address3
string
address4
string
postalcode
string
description
string
avatar
string
extra1
string
extra2
string
extra3
string
sex
string or null
Default: null
Enum: "m" "f"
phone
string
company_name
string
company_code
string
company_address
string
company_city
string
company_postalcode
string
company_phone
string
company_www
string
company_field
string
company_size
string
company_state
string
company_country
string
some1
string
some2
string
some3
string
ssn
string
iban
string

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Groups

Returns all groups that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

group_id
Array of integers non-empty

Groups to search by id. Example group_id[]=4&group_id[]=7

Responses

Response samples

Content type
application/json
{}

Return specified group

Authorizations:
ApiTokenKeyAuth
path Parameters
group-id
required
integer

Id of group

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Forms

Returns all forms that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

Responses

Response samples

Content type
application/json
{}

Returns all submissions of specified form

Authorizations:
ApiTokenKeyAuth
path Parameters
form-id
required
integer

Id of form

query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

Responses

Response samples

Content type
application/json
{}

Returns specified submission

Authorizations:
None
path Parameters
form-id
required
integer

Id of form

submission-id
required
integer

Id of submission

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Categories

Returns all categories that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

langcode
Array of strings non-empty

Categories to search by language. Example langcode[]=FI&langcode[]=EN

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "first": {},
  • "prev": {},
  • "next": {},
  • "items": [
    ],
  • "meta": {
    }
}

Return specified category

Authorizations:
ApiTokenKeyAuth
path Parameters
category-id
required
integer

Id of category

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Job Queue

Returns specified job queue

Authorizations:
ApiTokenKeyAuth
path Parameters
job-queue-id
required
integer

Id of job queue

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "status": {
    },
  • "meta": {
    }
}

Batch

Starts process to insert multiple users.

Fields from firstname to iban are only available if Account module is enabled

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
groups
required
Array of integers
username
required
string
email
required
string
name
required
string
active
boolean
Default: true
valid_to
string <date-time>
password
required
string >= 8 characters
firstname
string
lastname
string
birthdate
string <date-time>
city
string
address1
string
address2
string
address3
string
address4
string
postalcode
string
description
string
avatar
string
extra1
string
extra2
string
extra3
string
sex
string or null
Default: null
Enum: "m" "f"
phone
string
company_name
string
company_code
string
company_address
string
company_city
string
company_postalcode
string
company_phone
string
company_www
string
company_field
string
company_size
string
company_state
string
company_country
string
some1
string
some2
string
some3
string
ssn
string
iban
string

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple users.

Fields from firstname to iban are only available if Account module is enabled

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
groups
Array of integers
username
string
email
string
name
string
active
boolean
Default: true
valid_to
string <date-time>
password
string >= 8 characters
firstname
string
lastname
string
birthdate
string <date-time>
city
string
address1
string
address2
string
address3
string
address4
string
postalcode
string
description
string
avatar
string
extra1
string
extra2
string
extra3
string
sex
string or null
Default: null
Enum: "m" "f"
phone
string
company_name
string
company_code
string
company_address
string
company_city
string
company_postalcode
string
company_phone
string
company_www
string
company_field
string
company_size
string
company_state
string
company_country
string
some1
string
some2
string
some3
string
ssn
string
iban
string

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns result for specified users job queue

items field contains all uninserted/unupdated elements

Authorizations:
ApiTokenKeyAuth
path Parameters
job-queue-id
required
integer

Id of job queue

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Starts process to insert multiple products.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
required
object
commenting
string (CommentingTypes)
Default: "none"
Enum: "public" "registered" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
required
Array of integers
Array of objects (ProductProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple products.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
object
commenting
string (CommentingTypes)
Default: "none"
Enum: "public" "registered" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
Array of integers
Array of objects (ProductProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns result for specified products job queue

items field contains all uninserted/unupdated elements

Authorizations:
ApiTokenKeyAuth
path Parameters
job-queue-id
required
integer

Id of job queue

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Starts process to insert multiple contacts.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
One of
firstname
required
string
lastname
required
string
type
string
Value: "person"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
required
Array of integers
Array of objects (ContactProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple contacts.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
One of
firstname
string
lastname
string
type
string
Value: "person"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
Array of integers
Array of objects (ContactProperties)
id
required
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns result for specified contacts job queue

items field contains all uninserted/unupdated elements

Authorizations:
ApiTokenKeyAuth
path Parameters
job-queue-id
required
integer

Id of job queue

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Starts process to insert multiple news.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
required
object
object
object
object
object
object
object
object
required
object
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple news.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
translation
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
Array of integers
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns result for specified news job queue

items field contains all uninserted/unupdated elements

Authorizations:
ApiTokenKeyAuth
path Parameters
job-queue-id
required
integer

Id of job queue

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Starts process to insert multiple events.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
required
object
object
object
object
object
object
object
object
required
object
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple events.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
translation
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
Array of integers
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns result for specified events job queue

items field contains all uninserted/unupdated elements

Authorizations:
ApiTokenKeyAuth
path Parameters
job-queue-id
required
integer

Id of job queue

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Products

Starts process to insert multiple products.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
required
object
commenting
string (CommentingTypes)
Default: "none"
Enum: "public" "registered" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
required
Array of integers
Array of objects (ProductProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple products.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
object
commenting
string (CommentingTypes)
Default: "none"
Enum: "public" "registered" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
Array of integers
Array of objects (ProductProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns all products that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

langcode
Array of strings non-empty

Products to search by language. Example langcode[]=FI&langcode[]=EN

categories
Array of integers non-empty

Products to search by categories. Example categories[]=1&categories[]=2

visibility
Array of strings non-empty
Enum: "public" "private" "registered" "hidden"

Products to search by visibility. Example visibility[]=hidden&visibility[]=public

commenting
Array of strings non-empty
Enum: "public" "none" "registered"

Products to search by commenting. Example commenting[]=registered&commenting[]=public

owner
Array of integers non-empty

Products to search by owner. Example owner[]=1&owner[]=2

valid_from_before
string <date-time> non-empty

Products to search by validity start before given date-time. Example valid_from_before=2019-12-13T10:47:00Z

valid_from_after
string <date-time> non-empty

Products to search by validity start after given date-time. Example valid_from_after=2019-12-13T10:47:00Z

valid_to_before
string <date-time> non-empty

Products to search by validity end before given date-time. Example valid_to_before=2019-12-13T10:47:00Z

valid_to_after
string <date-time> non-empty

Products to search by validity end after given date-time. Example valid_to_after=2019-12-13T10:47:00Z

posted_before
string <date-time> non-empty

Products to search by posted before before given date-time. Example posted_before=2019-12-13T10:47:00Z

posted_after
string <date-time> non-empty

Products to search by posted after given date-time. Example posted_after=2019-12-13T10:47:00Z

modified_before
string <date-time> non-empty

Products to search by modified before before given date-time. Example modified_before=2019-12-13T10:47:00Z

modified_after
string <date-time> non-empty

Products to search by modified after given date-time. Example modified_after=2019-12-13T10:47:00Z

show_properties
boolean <boolean>
Example: show_properties=true

List Product Properties

Responses

Response samples

Content type
application/json
{}

Create new product

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
required
object
commenting
string (CommentingTypes)
Default: "none"
Enum: "public" "registered" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
required
Array of integers
Array of objects (ProductProperties)

Responses

Request samples

Content type
application/json
{
  • "translations": {
    },
  • "commenting": "public",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Returns specified product

Authorizations:
ApiTokenKeyAuth
path Parameters
product-id
required
integer

Id of product

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Edit specified product

Authorizations:
ApiTokenKeyAuth
path Parameters
product-id
required
integer

Id of product

Request Body schema: application/json
object
commenting
string (CommentingTypes)
Default: "none"
Enum: "public" "registered" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
Array of integers
Array of objects (ProductProperties)

Responses

Request samples

Content type
application/json
{
  • "translations": {
    },
  • "commenting": "public",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Delete specified product

Authorizations:
ApiTokenKeyAuth
path Parameters
product-id
required
integer

Id of product

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Contacts

Starts process to insert multiple contacts.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
One of
firstname
required
string
lastname
required
string
type
string
Value: "person"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
required
Array of integers
Array of objects (ContactProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple contacts.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
One of
firstname
string
lastname
string
type
string
Value: "person"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
Array of integers
Array of objects (ContactProperties)
id
required
integer <int64>

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns all contacts that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

langcode
Array of strings non-empty

Contacts to search by language. Example langcode[]=FI&langcode[]=EN

langcode
Array of strings non-empty

Contacts to search by language. Example langcode[]=FI&langcode[]=EN

categories
Array of integers non-empty

Contacts to search by categories. Example categories[]=1&categories[]=2

visibility
Array of strings non-empty
Enum: "public" "private" "registered" "hidden"

Contacts to search by visibility. Example visibility[]=hidden&visibility[]=public

owner
Array of integers non-empty

Contacts to search by owner. Example owner[]=1&owner[]=2

valid_from_before
string <date-time> non-empty

contacts to search by validity start before given date-time. Example valid_from_before=2019-12-13T10:47:00Z

valid_from_after
string <date-time> non-empty

Contacts to search by validity start after given date-time. Example valid_from_after=2019-12-13T10:47:00Z

valid_to_before
string <date-time> non-empty

Contacts to search by validity end before given date-time. Example valid_to_before=2019-12-13T10:47:00Z

valid_to_after
string <date-time> non-empty

Contacts to search by validity end after given date-time. Example valid_to_after=2019-12-13T10:47:00Z

posted_before
string <date-time> non-empty

Contacts to search by posted before before given date-time. Example posted_before=2019-12-13T10:47:00Z

posted_after
string <date-time> non-empty

Contacts to search by posted after given date-time. Example posted_after=2019-12-13T10:47:00Z

modified_before
string <date-time> non-empty

Contacts to search by modified before before given date-time. Example modified_before=2019-12-13T10:47:00Z

modified_after
string <date-time> non-empty

Contacts to search by modified after given date-time. Example modified_after=2019-12-13T10:47:00Z

show_properties
boolean <boolean>
Example: show_properties=true

List contact Properties

Responses

Response samples

Content type
application/json
{}

Create new contact

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
One of
firstname
required
string
lastname
required
string
type
string
Value: "person"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
required
Array of integers
Array of objects (ContactProperties)

Responses

Request samples

Content type
application/json
Example
{
  • "firstname": "John",
  • "lastname": "Tester",
  • "type": "person",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Returns specified contact

Authorizations:
ApiTokenKeyAuth
path Parameters
contact-id
required
integer

Id of contact

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Edit specified contact

Authorizations:
ApiTokenKeyAuth
path Parameters
contact-id
required
integer

Id of contact

Request Body schema: application/json
One of
firstname
string
lastname
string
type
string
Value: "person"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (VisibilityTypes)
Default: "public"
Enum: "public" "private" "registered" "hidden"
categories
Array of integers
Array of objects (ContactProperties)

Responses

Request samples

Content type
application/json
Example
{
  • "firstname": "John",
  • "lastname": "Tester",
  • "type": "person",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Delete specified contact

Authorizations:
ApiTokenKeyAuth
path Parameters
contact-id
required
integer

Id of contact

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

News

Starts process to insert multiple news.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
required
object
object
object
object
object
object
object
object
required
object
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple news.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
translation
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
Array of integers
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns all news that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

langcode
required
Array of strings non-empty

News to search by language. Example langcode[]=FI&langcode[]=EN

categories
Array of integers non-empty

News to search by categories. Example categories[]=1&categories[]=2

visibility
Array of strings non-empty
Enum: "public" "private" "registered" "hidden"

News to search by visibility. Example visibility[]=hidden&visibility[]=public

commenting
Array of strings non-empty
Enum: "public" "none" "registered"

News to search by commenting. Example commenting[]=registered&commenting[]=public

owner
Array of integers non-empty

News to search by owner. Example owner[]=1&owner[]=2

valid_from_before
string <date-time> non-empty

News to search by validity start before given date-time. Example valid_from_before=2019-12-13T10:47:00Z

valid_from_after
string <date-time> non-empty

News to search by validity start after given date-time. Example valid_from_after=2019-12-13T10:47:00Z

valid_to_before
string <date-time> non-empty

News to search by validity end before given date-time. Example valid_to_before=2019-12-13T10:47:00Z

valid_to_after
string <date-time> non-empty

News to search by validity end after given date-time. Example valid_to_after=2019-12-13T10:47:00Z

posted_before
string <date-time> non-empty

News to search by posted before before given date-time. Example posted_before=2019-12-13T10:47:00Z

posted_after
string <date-time> non-empty

News to search by posted after given date-time. Example posted_after=2019-12-13T10:47:00Z

modified_before
string <date-time> non-empty

News to search by modified before before given date-time. Example modified_before=2019-12-13T10:47:00Z

modified_after
string <date-time> non-empty

News to search by modified after given date-time. Example modified_after=2019-12-13T10:47:00Z

show_properties
boolean <boolean>
Example: show_properties=true

List news Properties

Responses

Response samples

Content type
application/json
{}

Create new news

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
required
object
object
object
object
object
object
object
object
required
object
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
{
  • "translations": {
    },
  • "intros": {
    },
  • "bodies": {
    },
  • "commentings": {
    },
  • "owners": {
    },
  • "valid_froms": {
    },
  • "valid_tos": {
    },
  • "visibilities": {
    },
  • "categories": {
    },
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Returns specified language version of news

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Add new language version for existing news

news-id should match existing language version of an news

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
translation
required
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
required
Array of integers
language
required
string
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
{
  • "translation": "Uutinen",
  • "intro": "Intro",
  • "body": "Sisältö",
  • "commenting": "public",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "language": "FI",
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Edit specified language version of news

Authorizations:
ApiTokenKeyAuth
path Parameters
news-id
required
integer

Id of news

Request Body schema: application/json
translation
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
Array of integers
Array of objects (NewsProperties)

Responses

Request samples

Content type
application/json
{
  • "translation": "Uutinen",
  • "intro": "Intro",
  • "body": "Sisältö",
  • "commenting": "public",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Delete specified news

Authorizations:
ApiTokenKeyAuth
path Parameters
news-id
required
integer

Id of news

Request Body schema: application/json
remove_all_versions
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "remove_all_versions": false
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Events

Starts process to insert multiple events.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
required
object
object
object
object
object
object
object
object
required
object
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Starts process to edit multiple events.

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
Array
id
required
integer <int64>
translation
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
Array of integers
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": {
    },
  • "href": "http://link.to/self",
  • "meta": {
    }
}

Returns all events that match given filters

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

langcode
required
Array of strings non-empty

Events to search by language. Example langcode[]=FI&langcode[]=EN

langcode
required
Array of strings non-empty

Events to search by language. Example langcode[]=FI&langcode[]=EN

categories
Array of integers non-empty

Events to search by categories. Example categories[]=1&categories[]=2

visibility
Array of strings non-empty
Enum: "public" "private" "registered" "hidden"

Events to search by visibility. Example visibility[]=hidden&visibility[]=public

commenting
Array of strings non-empty
Enum: "public" "none" "registered"

Events to search by commenting. Example commenting[]=registered&commenting[]=public

owner
Array of integers non-empty

Events to search by owner. Example owner[]=1&owner[]=2

valid_from_before
string <date-time> non-empty

Events to search by validity start before given date-time. Example valid_from_before=2019-12-13T10:47:00Z

valid_from_after
string <date-time> non-empty

Events to search by validity start after given date-time. Example valid_from_after=2019-12-13T10:47:00Z

valid_to_before
string <date-time> non-empty

Events to search by validity end before given date-time. Example valid_to_before=2019-12-13T10:47:00Z

valid_to_after
string <date-time> non-empty

Events to search by validity end after given date-time. Example valid_to_after=2019-12-13T10:47:00Z

posted_before
string <date-time> non-empty

Events to search by posted before before given date-time. Example posted_before=2019-12-13T10:47:00Z

posted_after
string <date-time> non-empty

Events to search by posted after given date-time. Example posted_after=2019-12-13T10:47:00Z

modified_before
string <date-time> non-empty

Events to search by modified before before given date-time. Example modified_before=2019-12-13T10:47:00Z

modified_after
string <date-time> non-empty

Events to search by modified after given date-time. Example modified_after=2019-12-13T10:47:00Z

show_properties
boolean <boolean>
Example: show_properties=true

List event Properties

Responses

Response samples

Content type
application/json
{}

Create new event

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
required
object
object
object
object
object
object
object
object
required
object
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
{
  • "translations": {
    },
  • "intros": {
    },
  • "bodies": {
    },
  • "commentings": {
    },
  • "owners": {
    },
  • "valid_froms": {
    },
  • "valid_tos": {
    },
  • "visibilities": {
    },
  • "categories": {
    },
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Returns specified language version of event

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Add new language version for existing event

event-id should match existing language version of an event

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
translation
required
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
required
Array of integers
language
required
string
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
{
  • "translation": "Tapahtuma",
  • "intro": "Intro",
  • "body": "Sisältö",
  • "commenting": "public",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "language": "FI",
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Edit specified language version of event

Authorizations:
ApiTokenKeyAuth
path Parameters
event-id
required
integer

Id of event

Request Body schema: application/json
translation
string
intro
string
body
string
commenting
string (schemas-CommentingTypes)
Default: "none"
Enum: "public" "none"
owner
integer
valid_from
string <date-time>
valid_to
string <date-time>
visibility
string (schemas-VisibilityTypes)
Default: "public"
Enum: "public" "hidden"
categories
Array of integers
Array of objects (EventProperties)

Responses

Request samples

Content type
application/json
{
  • "translation": "Tapahtuma",
  • "intro": "Intro",
  • "body": "Sisältö",
  • "commenting": "public",
  • "owner": 54,
  • "valid_from": "2045-02-04T05:24:28Z",
  • "valid_to": "2050-02-04T05:24:28Z",
  • "visibility": "public",
  • "categories": [
    ],
  • "properties": [
    ]
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Delete specified event

Authorizations:
ApiTokenKeyAuth
path Parameters
event-id
required
integer

Id of event

Request Body schema: application/json
remove_all_versions
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "remove_all_versions": false
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Media

Create new folder or file

Authorizations:
ApiTokenKeyAuth
Request Body schema: application/json
One of
name
required
string
object
object
type
required
string
Value: "folder"
target
required
integer <int64>

Responses

Request samples

Content type
application/json
Example
{
  • "name": "Tiedosto",
  • "titles": {
    },
  • "descriptions": {
    },
  • "type": "folder",
  • "target": 5
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Returns specified folder or file.

Id 0 corresponds to the root path

Authorizations:
ApiTokenKeyAuth
query Parameters
limit
integer >= 1
Default: 20
Example: limit=30

The number of items to return. Default is 20.

offset
integer >= 0

The number of items to skip.

private
boolean
Default: false

Show private files.

Responses

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}

Edit specified folder or file

Files are only allowed to be moved to another directory

Authorizations:
ApiTokenKeyAuth
path Parameters
news-id
required
integer

Id of media

Request Body schema: application/json
name
string
object
object
move_to
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "Tiedosto",
  • "titles": {
    },
  • "descriptions": {
    },
  • "move_to": 5
}

Response samples

Content type
application/json
{
  • "href": "http://link.to/self",
  • "items": [
    ],
  • "meta": {
    }
}