v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
Templates

Search Service Record Templates.

Allows to search service record templates by different criteria.

get/templates

Query parameters

limitinteger

The number of records to return per page, up to 20.

offsetinteger

The offset for pagination. Calculated as (page - 1) * limit (page starts at 1).

defaultsFirstboolean

Indicates whether to return default service record templates first in the result list.

excludeSubTypesboolean

Indicates whether service record templates converted from sub-types need to be excluded.

sortBy'id' | 'templateName' | 'srType' | 'createdBy' | 'updatedBy' | 'dateCreated' | 'dateUpdated' | 'coreSubType' | 'coreTemplate'

A service record template field to sort by.

sortDir'asc' | 'desc'

Service record templates sorting direction.

templateNamestring

Search service record templates by name.

srTypeServiceRecordType[]

Search service record templates by service record type.

createdBystring[]

Search service record templates by usernames who created templates.

updatedBystring[]

Search service record templates by usernames who updated templates.

coreSubTypeinteger[]

Search service record templates by core sub-type ids.

coreTemplateinteger[]

Search service record templates by core template ids.

dateCreatedFromstring date

Search service record templates by date from which template were created.

dateCreatedTostring date

Search service record templates by date to which template were created.

dateUpdatedFromstring date

Search service record templates by date from which template were updated.

dateUpdatedTostring date

Search service record templates by date to which template were updated.

Response

Service record templates list.

limitinteger

The number of items that are returned per page

offsetinteger

The offset used for pagination.

totalinteger

The total number of elements across all pages.

Example response

{
  "limit": 20,
  "total": 50
}