Get list of Template Catalogs

  • 2 minute(s) read
Prev Next
Get
/templates/

Operation is used to get a list of Template Catalogs.

Template Catalogs can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Query parameters
offset
integer

Offset to start returning results.

Minimum0
limit
integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1
__any of the object fields__
string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

  • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
  • For numerics: gt, lt, gte, lte, isnull
  • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++
orderby
string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses
200

A result response object.

{
  "Next": null,
  "Previous": null,
  "Results": [
    {
      "contentType": {
        "id": 161,
        "identifier": "addressdefaults",
        "instanceAPIUrl": null,
        "name": "Address defaults",
        "objectTypesUrl": "https://example.keypro.fi/api/v2/object-types/"
      },
      "createdBy": "test.creator",
      "createdTs": "17.03.2025",
      "id": 2,
      "isActive": true,
      "name": "testcatalog",
      "template": [
        {
          "material": "plastic",
          "owner": "Private"
        }
      ],
      "templateJsonLabel": [
        {
          "diameter": "300 mm",
          "material": "concrete"
        }
      ],
      "updatedBy": "test.updater",
      "updatedTs": "17.03.2025"
    },
    {
      "contentType": {
        "id": 161,
        "identifier": "addressdefaults",
        "instanceAPIUrl": null,
        "name": "Address defaults",
        "objectTypesUrl": "https://example.keypro.fi/api/v2/object-types/"
      },
      "createdBy": "test.creator",
      "createdTs": "19.03.2025",
      "id": 836,
      "isActive": true,
      "name": "My Test Template",
      "template": [
        {
          "diameter": "200 mm",
          "material": "plastic"
        }
      ],
      "templateJsonLabel": [
        {
          "diameter": "200 mm",
          "material": "plastic"
        }
      ],
      "updatedBy": "test.updater",
      "updatedTs": "19.03.2025"
    }
  ],
  "Total": 2
}
Expand All
object
Next
string (url)

Url to next page of Template Catalogs list. Null if No next page exist

Prev
string (url)

Url to previous page of Template Catalogs list. Null if No previous page exist

Results
Array of object (TemplateCatalog)

List of fetched Template Catalogs

object

Template Catalog

contentType
integer

Reference to content type

createdBy
string

User who created the template catalog

createdTs
string (date-time)

Created date and time

id
integer

Unique id of template catalog

isActive
boolean

Whether the template catalog is active

Defaulttrue
listUrl
string

URL to the template catalog list

name
string

Catalog name

template
object

Template data stored as JSON

templateJsonLabel
object

Template JSON labels

updatedBy
string

User who updated the template catalog

updatedTs
string (date-time)

Last updated date and time

Total
integer

Total number of Template Catalogs in the list

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error