Skip to main content
API docs by Redocly

TSM Document management system API (2.0)

Download OpenAPI specification:Download

TSM Info: tsm@datalite.cz URL: http://tsm.datalite.cz

API for Telco Service Management - Document management system

Sharing Public API

Sharing allows you to share any entity in the system with other entities. The sharing is defined by the owning entity and to whom it is shared. The sharing can be public, which means that it is visible to all users.

Finds all sharings by it's type

Returns all sharings matching the filter.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this sharing is related to.

refType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this sharing is related to.

refId
required
string

An identification of the ref entity which the sharing is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds all sharings by owning entity

Returns all sharings.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this sharing is related to.

ownerId
required
string

An identification of the owning entity which the sharing is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds all sharings that are either public or match given ownerType, refType, subType and refIds

Returns all sharings matching the filter.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this sharing is related to.

subType
required
string

A code used to further distinguish sharings of particular ref entity

refIds
required
Array of strings

An identifications of the ref entities which the sharing is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds all sharings that are either public or match given ownerType and refIds

Returns all sharings matching the filter.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this sharing is related to.

refIds
required
Array of strings

An identifications of the ref entities which the sharing is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Admin

Admin public API

Update elastic mapping for worklog.

Authorizations:
(JWTBasic)
path Parameters
indexName
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

DmsAdminPublicApi.create

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Refresh selected records async.

Refresh selected records by filterable query async.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

DmsAdminPublicApi.reindexAsyncCompleted

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
startDate
required
string <date-time>
status
required
string
Enum: "NEW" "IN_PROGRESS" "COMPLETED" "FAILED"
jobType
required
string
data
object
endDate
string <date-time>
required
Array of objects (JobStepPublic)
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobType": "string",
  • "data": { },
  • "endDate": "2019-08-24T14:15:22Z",
  • "jobSteps": [
    ],
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Recreates an index and updates all logs.

Recreates an index and updates all logs.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

DmsAdminPublicApi.createKafkaDql

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

DmsAdminPublicApi.resend

Authorizations:
(JWTBasic)
path Parameters
jobStepId
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

DmsAdminPublicApi.resendFaild

Authorizations:
(JWTBasic)
path Parameters
jobId
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Evict Javers cache.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Send kafka message for update all elastic indexes.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

WorklogType

Worklog type public API

Returns a row by primary key

Returns existing row by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

form
string
privilege
string
icon
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

WorklogTypePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

WorklogTypePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

form
string
privilege
string
icon
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

WorklogTypePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (Worklog Type public)
object (Worklog Type public)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

WorklogTypePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

WorklogTypePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (Worklog Type public)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

WorklogTypePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WorklogTypePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

WorklogTypePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search worklog types Deprecated

Search by worklog type filter - filtering, sorting, paging. Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

Search worklog types Deprecated

Search by worklog type filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

WorklogTypePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

WorklogTypePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "privilege": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationRule

Notification rule public API

Returns a Notification rule

Returns existing notification rule by ID or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of user

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

apiSenderBeanName
string

Name of a Spring Bean which sends the data. The bean must implement the TsmNotificationSender interface . Default implementation is: email - embedded SMTP client SMS - embedded SNMP client letter - unsupported

                            Other delivery item types are not configurable and are always delivered by TSM (application, userComment, pushNotification ).
object

Configuration of the notification rule

configFormCode
string

Code of form defining data structure for NotificationTemplate.config

evalNotificationUrl
string

Absolute or relative (to microservice backendUrl) URL to gather notification data.

eventType
string
Enum: "SYSTEM" "PROCESS" "KAFKA" "REST" "DIRECT"

Event type. As defined in NotificationRuleEventType enum.

microserviceCode
string

Code of related microservice.

configTypeCode
string

Code of config type used for further distinct configuration from different application areas.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

NotificationRulePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

NotificationRulePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

apiSenderBeanName
string

Name of a Spring Bean which sends the data. The bean must implement the TsmNotificationSender interface . Default implementation is: email - embedded SMTP client SMS - embedded SNMP client letter - unsupported

                            Other delivery item types are not configurable and are always delivered by TSM (application, userComment, pushNotification ).
object

Configuration of the notification rule

configFormCode
string

Code of form defining data structure for NotificationTemplate.config

evalNotificationUrl
string

Absolute or relative (to microservice backendUrl) URL to gather notification data.

eventType
string
Enum: "SYSTEM" "PROCESS" "KAFKA" "REST" "DIRECT"

Event type. As defined in NotificationRuleEventType enum.

microserviceCode
string

Code of related microservice.

configTypeCode
string

Code of config type used for further distinct configuration from different application areas.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

NotificationRulePublicApi.processNotificationRule

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
Authorization
string
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

NotificationRulePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (NotificationRule)
object (NotificationRule)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

NotificationRulePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

NotificationRulePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (NotificationRule)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

NotificationRulePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationRulePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

NotificationRulePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search notification rules Deprecated

Search by notification rule filter - filtering, sorting, paging. Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

Search notification rules Deprecated

Search by notification rule filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationRulePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

NotificationRulePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "apiSenderBeanName": "string",
  • "config": {
    },
  • "configFormCode": "string",
  • "evalNotificationUrl": "string",
  • "eventType": "SYSTEM",
  • "microserviceCode": "string",
  • "configTypeCode": "string",
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Job

Job public API

Returns a job step

Returns existing job step by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

Identifier of job step UUID

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Update existing job step

Updates all properties of an existing job step.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

Identifier of job step UUID

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
name
required
string
startDate
string <date-time>
status
required
string
Enum: "NEW" "IN_PROGRESS" "COMPLETED" "FAILED"
jobId
required
string <uuid>
chunkId
string <uuid>
chunk
Array of strings
endDate
string <date-time>
stepData
object
processingInfo
object
log
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Update properties of an existing job step

Updates properties of an existing job step.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

Identifier of job step UUID

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Create new job

Creates a job with basic properties set.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
startDate
required
string <date-time>
status
required
string
Enum: "NEW" "IN_PROGRESS" "COMPLETED" "FAILED"
jobType
required
string
data
object
endDate
string <date-time>
required
Array of objects (JobStepPublic)
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobType": "string",
  • "data": { },
  • "endDate": "2019-08-24T14:15:22Z",
  • "jobSteps": [
    ],
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobType": "string",
  • "data": { },
  • "endDate": "2019-08-24T14:15:22Z",
  • "jobSteps": [
    ],
  • "auditInfo": {
    }
}

JobStepPublicApi.create

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
name
required
string
startDate
string <date-time>
status
required
string
Enum: "NEW" "IN_PROGRESS" "COMPLETED" "FAILED"
jobId
required
string <uuid>
chunkId
string <uuid>
chunk
Array of strings
endDate
string <date-time>
stepData
object
processingInfo
object
log
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Returns a job

Returns existing job by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

Identifier of job UUID

query Parameters
expand
Array of strings
Items Value: "JOB_STEPS"
Example: expand=JOB_STEPS

Possible extensions of the job object

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobType": "string",
  • "data": { },
  • "endDate": "2019-08-24T14:15:22Z",
  • "jobSteps": [
    ],
  • "auditInfo": {
    }
}

Returns a job step

Returns existing job step by chunk ID and name

Authorizations:
(JWTBasic)
path Parameters
chunkId
required
string <uuid>

Identifier of chunkId

name
required
string

Name

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "NEW",
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "chunkId": "90e1f3df-a8a1-438e-8dd5-10e45398d051",
  • "chunk": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "stepData": { },
  • "processingInfo": { },
  • "log": "string"
}

Notification Public API

API for creating and retrieving notifications. Notifications are used for sending emails, SMS, etc. for any entity in the system identified by ownerId and ownerType. A notification is defined by a template, which defines notification type, output format and required parameters).

Updates notification's state

Finds a Notification by given UUID and updates it's state.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
newState
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Send a notification

Notification using a template, optionally with formatter and attachments.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Notification unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this notification is attached. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this notification is attached. See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

required
Array of objects (Target of the notification)

Target of the notification.

Array of objects (RelatedEntity)

Additional entities this notification relates to.

object

Source data for layout engine to create the notification.

object

Override for Formatter Document Template Data (salutation, content, footer,...)

Array of objects (Attachment of a notification)

List of attachments to add to this notification.

from
string

Override from email address in the notification.

templateCode
required
string

Identification of related notification template.

subject
string

Notification subject.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "notificationTo": [
    ],
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "data": {
    },
  • "formatterDocumentTemplateDataOverride": {
    },
  • "attachments": [
    ],
  • "from": "string",
  • "templateCode": "string",
  • "subject": "string"
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Send a notification

Notification using a template, optionally with formatter and attachments.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
id
string <uuid>

Notification unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this notification is attached. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this notification is attached. See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

required
Array of objects (Target of the notification)

Target of the notification.

Array of objects (RelatedEntity)

Additional entities this notification relates to.

object

Source data for layout engine to create the notification.

object

Override for Formatter Document Template Data (salutation, content, footer,...)

Array of objects (Attachment of a notification)

List of attachments to add to this notification.

from
string

Override from email address in the notification.

templateCode
required
string

Identification of related notification template.

subject
string

Notification subject.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Send a notification

Notification using a template, optionally with formatter and attachments.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Notification unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this notification is attached. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this notification is attached. See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

required
Array of objects (Target of the notification)

Target of the notification.

Array of objects (RelatedEntity)

Additional entities this notification relates to.

object

Source data for layout engine to create the notification.

object

Override for Formatter Document Template Data (salutation, content, footer,...)

Array of objects (Attachment of a notification)

List of attachments to add to this notification.

from
string

Override from email address in the notification.

templateCode
required
string

Identification of related notification template.

subject
string

Notification subject.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "notificationTo": [
    ],
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "data": {
    },
  • "formatterDocumentTemplateDataOverride": {
    },
  • "attachments": [
    ],
  • "from": "string",
  • "templateCode": "string",
  • "subject": "string"
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

NotificationPublicApi.getByOwners

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

NotificationPublicApi.getByNotificationIdAndRefType

Authorizations:
(JWTBasic)
path Parameters
notificationId
required
string <uuid>
refType
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a Notification

Returns an existing Notification by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "subject": "string",
  • "contents": "string",
  • "notificationTo": [
    ],
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "status": "PLAN",
  • "data": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "templateCode": "string",
  • "params": {
    },
  • "sent": "2019-08-24T14:15:22Z",
  • "deliveryFromTime": "2019-08-24T14:15:22Z",
  • "deliveryToTime": "2019-08-24T14:15:22Z",
  • "fromUserId": "1dace4d0-98e4-4ab4-97cf-c23ae5cef503",
  • "from": "string",
  • "auditInfo": {
    }
}

NotificationPublicApi.getByOwner

Authorizations:
(JWTBasic)
path Parameters
ownerId
required
string
ownerType
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationPublicApi.getAllFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Log

Log public API

Returns a log

Returns existing log by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "logType": {
    },
  • "logTypeCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "request": "string",
  • "response": "string",
  • "resultCode": "200, 500, 400",
  • "resultMessage": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "correlationId": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "messageId": "string",
  • "description": "string",
  • "duration": 0,
  • "module": "string",
  • "relatedData": {
    },
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ..."
}

Update logs

Updates all properties of an existing log.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

Identifier of an existing user group

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Identification of the owning entity which has relation with log. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

ID of the owning entity which has relation with log.See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

object (Log type)

Type of log

logTypeCode
required
string

Code of the log type. Either the code or the logType must be set.

startDate
required
string <date-time>

Start date of log

request
required
string

Request text

response
required
string

Response text

resultCode
string

Code of result

resultMessage
string

Result message, For example error specification.

endDate
required
string <date-time>

End date of log

correlationId
required
string

Type of the owning entity to which this attachment is attached. This value is NOT validated, because of dynamic nature of microservice modules.

messageId
string

ID of message.

description
string

Free text to describe the account. It may contain HTML formatting.

duration
integer <int64>

Duration. If not set, it is calculated as endDate - startDate.

module
string

Module of TSM

required
object

Any additional related data

Array of objects (LogRelatedEntity)

Additional entities this log relates to.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "logType": {
    },
  • "logTypeCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "request": "string",
  • "response": "string",
  • "resultCode": "200, 500, 400",
  • "resultMessage": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "correlationId": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "messageId": "string",
  • "description": "string",
  • "duration": 0,
  • "module": "string",
  • "relatedData": {
    },
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ..."
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "logType": {
    },
  • "logTypeCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "request": "string",
  • "response": "string",
  • "resultCode": "200, 500, 400",
  • "resultMessage": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "correlationId": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "messageId": "string",
  • "description": "string",
  • "duration": 0,
  • "module": "string",
  • "relatedData": {
    },
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ..."
}

Log

Logging service

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Identification of the owning entity which has relation with log. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

ID of the owning entity which has relation with log.See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

object (Log type)

Type of log

logTypeCode
required
string

Code of the log type. Either the code or the logType must be set.

startDate
required
string <date-time>

Start date of log

request
required
string

Request text

response
required
string

Response text

resultCode
string

Code of result

resultMessage
string

Result message, For example error specification.

endDate
required
string <date-time>

End date of log

correlationId
required
string

Type of the owning entity to which this attachment is attached. This value is NOT validated, because of dynamic nature of microservice modules.

messageId
string

ID of message.

description
string

Free text to describe the account. It may contain HTML formatting.

duration
integer <int64>

Duration. If not set, it is calculated as endDate - startDate.

module
string

Module of TSM

required
object

Any additional related data

Array of objects (LogRelatedEntity)

Additional entities this log relates to.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "logType": {
    },
  • "logTypeCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "request": "string",
  • "response": "string",
  • "resultCode": "200, 500, 400",
  • "resultMessage": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "correlationId": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "messageId": "string",
  • "description": "string",
  • "duration": 0,
  • "module": "string",
  • "relatedData": {
    },
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ..."
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "logType": {
    },
  • "logTypeCode": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "request": "string",
  • "response": "string",
  • "resultCode": "200, 500, 400",
  • "resultMessage": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "correlationId": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "messageId": "string",
  • "description": "string",
  • "duration": 0,
  • "module": "string",
  • "relatedData": {
    },
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ..."
}

Returns a log by owner

Returns existing log by owner type and owner ID

Authorizations:
(JWTBasic)
path Parameters
ownerId
required
string
Example: Order, Ticket UUID ...

Owner ID

ownerType
required
string
Example: Ticket, Order ...

Owner type

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds all logs by filtering

Returns all log list.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete logs

Logging service

Authorizations:
(JWTBasic)
path Parameters
code
required
string
olderThan
required
string <date-time>
ownerType
required
string
ownerId
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

FormatterTemplate

Formatter template public API

Returns a row by primary key

Returns existing row by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
code
required
string
name
string
inputType
required
string
Enum: "FILE" "HTML" "SCRIPT"
documentType
string
Enum: "PDF" "EMAIL" "SOURCE"
documentSize
string
Enum: "AUTO" "PORTRAIT" "LANDSCAPE" "A4" "B5" "LETTER"
content
string
previewData
object
formId
string <uuid>
dataTags
Array of strings
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

FormatterTemplatePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

FormatterTemplatePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
code
required
string
name
string
inputType
required
string
Enum: "FILE" "HTML" "SCRIPT"
documentType
string
Enum: "PDF" "EMAIL" "SOURCE"
documentSize
string
Enum: "AUTO" "PORTRAIT" "LANDSCAPE" "A4" "B5" "LETTER"
content
string
previewData
object
formId
string <uuid>
dataTags
Array of strings
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

FormatterTemplatePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (FormatterTemplatePublic)
object (FormatterTemplatePublic)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

FormatterTemplatePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

FormatterTemplatePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (FormatterTemplatePublic)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

FormatterTemplatePublicApi.getContentPreview

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
data
required
object
content
required
string

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

FormatterTemplatePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

FormatterTemplatePublicApi.getByTemplateByCode

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterTemplatePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

FormatterTemplatePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterTemplatePublicApi.getAllFilterable Deprecated

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

FormatterTemplatePublicApi.getAllFilterableList Deprecated

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterTemplatePublicApi.getDataTags

Authorizations:
(JWTBasic)
query Parameters
search
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • "string"
]

FormatterTemplatePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

FormatterTemplatePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "inputType": "FILE",
  • "documentType": "PDF",
  • "documentSize": "AUTO",
  • "content": "string",
  • "previewData": { },
  • "formId": "126460ed-49b2-4c69-849a-bd8904ec5d8f",
  • "dataTags": [
    ],
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Formatter

TSM Formatter public API

Generate a document by it's template and return rendered document content (e.g. html or pdf)

Find customer by key.

Authorizations:
(JWTBasic)
path Parameters
documentTemplateCode
required
string

Code of a FormatterDocumentTemplate or FormatterTemplate.

format
required
string

Target format as a mime type such as 'pdf', 'doc', 'docx', 'xls' and 'xlsx'. Under the hood LibreOffice is used for conversion from HTML to the target format (with the exception of PDF, which is handled directly). All formats supported by LibreOffice are available.

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
"string"

Generate multiple documents

Generate multiple documents by it's template and return document data.

Authorizations:
(JWTBasic)
path Parameters
format
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
documentId
required
string
documentTemplateCode
required
string
required
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Generate a document name by it's template and return it

Authorizations:
(JWTBasic)
path Parameters
templateCode
required
string

Code of a FormatterTemplate.

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
"string"

Notification

Notification public API

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

configTypeId
required
string <uuid>

Config Type UUID

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

content
string

Text of notification. It is used when no formatterDocumentTemplateId is defined.

formatterDocumentTemplateId
string <uuid>

Unique identifier of notification document template.

deliveryTimeCode
string

Code of related delivery time entity.

deliveryType
string
Enum: "SMS" "EMAIL" "LETTER" "APPLICATION" "USER_COMMENT"

Delivery type. As defined in DeliveryItemType enum.

from
string <= 255 characters

Sender of notification.

to
string <= 255 characters

Recipient of notification.

icon
string <= 255 characters

Graphic element displayed next to the type of notification

subject
string <= 255 characters

Notification subject

status
string
Enum: "ACTIVE" "INACTIVE"

Notification template status. As defined in NotificationTemplateStatus enum.

expiration
integer <int32>

Limit (in days) until which it is possible to respond to a notification (for example, until when it is possible to respond to a button / URL in a notification).

dataTags
Array of strings

Additional data tags (aka labels).

object

Map of notification template configuration generated by form with code from NotificationEvent.configFormCode. Value must be a valid JSON string.

notificationRuleCode
string

Code of related notification rule.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

NotificationTemplatePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

NotificationTemplatePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

configTypeId
required
string <uuid>

Config Type UUID

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

content
string

Text of notification. It is used when no formatterDocumentTemplateId is defined.

formatterDocumentTemplateId
string <uuid>

Unique identifier of notification document template.

deliveryTimeCode
string

Code of related delivery time entity.

deliveryType
string
Enum: "SMS" "EMAIL" "LETTER" "APPLICATION" "USER_COMMENT"

Delivery type. As defined in DeliveryItemType enum.

from
string <= 255 characters

Sender of notification.

to
string <= 255 characters

Recipient of notification.

icon
string <= 255 characters

Graphic element displayed next to the type of notification

subject
string <= 255 characters

Notification subject

status
string
Enum: "ACTIVE" "INACTIVE"

Notification template status. As defined in NotificationTemplateStatus enum.

expiration
integer <int32>

Limit (in days) until which it is possible to respond to a notification (for example, until when it is possible to respond to a button / URL in a notification).

dataTags
Array of strings

Additional data tags (aka labels).

object

Map of notification template configuration generated by form with code from NotificationEvent.configFormCode. Value must be a valid JSON string.

notificationRuleCode
string

Code of related notification rule.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

NotificationTemplatePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (NotificationTemplate)
object (NotificationTemplate)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (NotificationTemplate)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.processNotificationTemplates

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
idOrCode
required
string
required
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

NotificationTemplatePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Returns a Notification Template

Returns an existing Notification by UUID or Code

Authorizations:
(JWTBasic)
path Parameters
identifier
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

NotificationTemplatePublicApi.getAllFilterableWithoutIgnored

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

NotificationTemplatePublicApi.getAllFilterableListWithoutIgnored

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.getAllFilterableListIgnored

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.getAllFilterableIgnored

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

NotificationTemplatePublicApi.getTypes

Authorizations:
(JWTBasic)
query Parameters
search
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

NotificationTemplatePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search notification templates Deprecated

Search by notification template filter - filtering, sorting, paging. Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

Search notification templates Deprecated

Search by notification template filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

NotificationTemplatePublicApi.getDataTags

Authorizations:
(JWTBasic)
query Parameters
search
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • "string"
]

NotificationTemplatePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

NotificationTemplatePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "configTypeId": "969bc034-3421-4a56-9586-cbd576a42d8d",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "content": "string",
  • "formatterDocumentTemplateId": "3181afe0-a7aa-416f-9ae9-3c668555b209",
  • "deliveryTimeCode": "string",
  • "deliveryType": "SMS",
  • "from": "string",
  • "to": "string",
  • "icon": "string",
  • "subject": "string",
  • "status": "ACTIVE",
  • "expiration": 0,
  • "dataTags": [
    ],
  • "config": {
    },
  • "notificationRuleCode": "string",
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attachment type

Attachment type public API

Returns a row by primary key

Returns existing row by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

form
string
icon
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

AttachmentTypePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

AttachmentTypePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

form
string
icon
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

AttachmentTypePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (AttachmentType)
object (AttachmentType)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentTypePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentTypePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (AttachmentType)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentTypePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

AttachmentTypePublicApi.getTypes

Authorizations:
(JWTBasic)
query Parameters
search
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentTypePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

AttachmentTypePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search attachment typeslisting profiles Deprecated

Search by attachment type filter - filtering, sorting, paging. Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

Search attachment types Deprecated

Search by attachment type filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentTypePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

AttachmentTypePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attachment Public API

API for creating and retrieving attachments. Attachments are used for storing documents, images, etc. for any entity in the system identified by ownerId and ownerType. Attachments can be distinguished by their type (e.g. 'Invoice', 'Agreement', 'Device photo', etc.) and may contain additional metadata with the structure defined by the attachment type.

AttachmentPublicApi.getById

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Update a value and refresh elastic

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

An identifier of an existing attachment

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Attachment unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this attachment is attached. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this attachment is attached. See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

name
string

Name of the binary attachment including type suffix.

description
string

The description of the binary attachment.

mimeType
string
data
string

Binary data in base64 format. Included only if this field is expanded in the query. Use this attribute only for small attachments. There are dedicated APIs to handle large binary content.

thumbnail
string

Binary data in base64 format. Included only if this field is expanded in the query. Use this attribute only for small attachments. There are dedicated APIs to handle large binary content.

Array of objects (RelatedEntity)

Additional entities this attachment relates to.

formData
object

Additional metadata to the attachment. The value MUST be valid JSON according to 'Attachment Type' form definition.

attachmentType
string

Attachment type. This value MUST be one of attachment type code from 'Attachment Type' registry.

bucket
string

Attachment bucket. When attachments are stored on filesystem, the location can be calculated as ${tsm.dms.files.dir}/${bucket}/${attachment.id}

private
boolean

Private or public comments (e.g. visible for the client).

lifecycle
required
string
Enum: "LIVE" "ARCHIVED"

Attachment lifecycle.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Deletes an attachment by ID

Deletes an existing attachment by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

AttachmentPublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema:
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Creates an attachment

Creates an attachment.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Attachment unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this attachment is attached. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this attachment is attached. See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

name
string

Name of the binary attachment including type suffix.

description
string

The description of the binary attachment.

mimeType
string
data
string

Binary data in base64 format. Included only if this field is expanded in the query. Use this attribute only for small attachments. There are dedicated APIs to handle large binary content.

thumbnail
string

Binary data in base64 format. Included only if this field is expanded in the query. Use this attribute only for small attachments. There are dedicated APIs to handle large binary content.

Array of objects (RelatedEntity)

Additional entities this attachment relates to.

formData
object

Additional metadata to the attachment. The value MUST be valid JSON according to 'Attachment Type' form definition.

attachmentType
string

Attachment type. This value MUST be one of attachment type code from 'Attachment Type' registry.

bucket
string

Attachment bucket. When attachments are stored on filesystem, the location can be calculated as ${tsm.dms.files.dir}/${bucket}/${attachment.id}

private
boolean

Private or public comments (e.g. visible for the client).

lifecycle
required
string
Enum: "LIVE" "ARCHIVED"

Attachment lifecycle.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Returns an attachment content

Returns an existing attachment content by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
"string"

Updates an attachment content

Updates an attachment content.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

An identifier of an existing attachment

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Create multiple attachments

Create multiple attachments.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
id
string <uuid>

Attachment unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this attachment is attached. This value is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this attachment is attached. See ownerType for more information. This value is NOT validated, because of dynamic nature of microservice modules.

name
string

Name of the binary attachment including type suffix.

description
string

The description of the binary attachment.

mimeType
string
data
string

Binary data in base64 format. Included only if this field is expanded in the query. Use this attribute only for small attachments. There are dedicated APIs to handle large binary content.

thumbnail
string

Binary data in base64 format. Included only if this field is expanded in the query. Use this attribute only for small attachments. There are dedicated APIs to handle large binary content.

Array of objects (RelatedEntity)

Additional entities this attachment relates to.

formData
object

Additional metadata to the attachment. The value MUST be valid JSON according to 'Attachment Type' form definition.

attachmentType
string

Attachment type. This value MUST be one of attachment type code from 'Attachment Type' registry.

bucket
string

Attachment bucket. When attachments are stored on filesystem, the location can be calculated as ${tsm.dms.files.dir}/${bucket}/${attachment.id}

private
boolean

Private or public comments (e.g. visible for the client).

lifecycle
required
string
Enum: "LIVE" "ARCHIVED"

Attachment lifecycle.

object (Audit information)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentPublicApi.getAttachmentsByOwningEntities

Authorizations:
(JWTBasic)
path Parameters
entityType
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Returns an attachment thumbnail

Returns an existing attachment thumbnail by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
"string"

Returns an attachment

Returns an existing attachment by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

Finds all attachments by an owning or related entity

Returns all attachments.

Authorizations:
(JWTBasic)
path Parameters
entityType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this attachment is related to.

entityId
required
string

An identification of the owning entity which the attachment is related to

query Parameters
includeRelated
boolean

Returns the documents where the master entity is only as a related entity (not the direct owner).

documentTypeFilter
string

A filter for document types of this type.

expand
Array of strings
Items Enum: "Content" "Thumbnail"

Expands attachment fields (e.g. should the document content be attached?)

onlyWithThumbnail
boolean
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentPublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

AttachmentPublicApi.getListByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of strings <uuid> [ items <uuid > ]
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentPublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

AttachmentPublicApi.getAllFilterable Deprecated

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

AttachmentPublicApi.getAllFilterableList Deprecated

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an attachment

Returns an existing attachment by UUID optionally with attachment content.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
query Parameters
expand
Array of strings
Items Enum: "Content" "Thumbnail"

Expands attachment fields (e.g. should the document content be attached?

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "name": "My document.pdf",
  • "description": "string",
  • "mimeType": "string",
  • "data": "string",
  • "thumbnail": "string",
  • "relatedEntities": "Customer, Ticket, Order, EntityInstance, ...",
  • "size": 0,
  • "sizeUnit": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "attachmentType": "string",
  • "bucket": "string",
  • "private": true,
  • "lifecycle": "LIVE",
  • "auditInfo": {
    }
}

AttachmentPublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

Log Type

Log type public API

Get LogType

Get log type by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log type unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

appFrom
string

From application

appTo
string

To application

requestFormCode
string

Form code of request

responseFormCode
string

Form code od response

relDataFormCode
string

RelDataFormCode

language
string

Language

protocol
string

Protocol

formCode
string

Form code

config
object

Config of log

object (Audit information)
description
string
validityFrom
string <date-time>
validityTo
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

LogTypePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Get LogType

Get log type by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log type unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

appFrom
string

From application

appTo
string

To application

requestFormCode
string

Form code of request

responseFormCode
string

Form code od response

relDataFormCode
string

RelDataFormCode

language
string

Language

protocol
string

Protocol

formCode
string

Form code

config
object

Config of log

object (Audit information)
description
string
validityFrom
string <date-time>
validityTo
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

LogTypePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

LogTypePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (Log type)

Type of log

object (Log type)

Type of log

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (Log type)

Type of log

object (Log type)

Type of log

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (Log type)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (Log type)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

LogTypePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

LogTypePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log type unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

appFrom
string

From application

appTo
string

To application

requestFormCode
string

Form code of request

responseFormCode
string

Form code od response

relDataFormCode
string

RelDataFormCode

language
string

Language

protocol
string

Protocol

formCode
string

Form code

config
object

Config of log

object (Audit information)
description
string
validityFrom
string <date-time>
validityTo
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

LogTypePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log type unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

appFrom
string

From application

appTo
string

To application

requestFormCode
string

Form code of request

responseFormCode
string

Form code od response

relDataFormCode
string

RelDataFormCode

language
string

Language

protocol
string

Protocol

formCode
string

Form code

config
object

Config of log

object (Audit information)
description
string
validityFrom
string <date-time>
validityTo
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

LogTypePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

LogTypePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.getAllFilterableList Deprecated

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.getAllFilterableList Deprecated

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

LogTypePublicApi.getAllFilterable Deprecated

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

LogTypePublicApi.getAllFilterable Deprecated

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

LogTypePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

LogTypePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

Get LogType Deprecated

Get log type by code

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Get LogType Deprecated

Get log type by code

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "appFrom": "string",
  • "appTo": "string",
  • "requestFormCode": "string",
  • "responseFormCode": "string",
  • "relDataFormCode": "string",
  • "language": "string",
  • "protocol": "string",
  • "formCode": "string",
  • "config": { },
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Get All LogType Deprecated

Get all log types

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All LogType Deprecated

Get all log types

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Worklog Public API

API for creating and retrieving worklogs. Worklogs are used for storing time spent for any entity in the system identified by ownerId and ownerType. Worklogs can be distinguished by their type (e.g. 'Work', 'Repair', etc.) and may contain additional metadata with the structure defined by the worklog type.

Returns a worklog

Returns an existing worklog by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "workerId": "27a13901-5ff4-4d4a-a305-9dd200eae3c5",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "worklogTypeCode": "string",
  • "taskEntityRefId": "string",
  • "auditInfo": {
    }
}

Updates a worklog

Updates a worklog.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

An identifier of an existing worklog

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Worklog unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this worklog is attached. This description is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this worklog is attached. See ownerType for more information. This description is NOT validated, because of dynamic nature of microservice modules.

workerId
string <uuid>

Specify creatin user. Default value for creation is the authenticated user.

description
string

Text of the worklog in a subset of HTML format. Examples of valid HTML can be created using the Editor component in tSM Form Designer in preview mode.

startDate
string <date-time>

Specify worklog start date.

endDate
string <date-time>

Specify worklog end date.

required
object

Custom data.

worklogTypeCode
string

Custom form data as defined by the worklog type.

taskEntityRefId
string

Id of task

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "workerId": "27a13901-5ff4-4d4a-a305-9dd200eae3c5",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "worklogTypeCode": "string",
  • "taskEntityRefId": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "workerId": "27a13901-5ff4-4d4a-a305-9dd200eae3c5",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "worklogTypeCode": "string",
  • "taskEntityRefId": "string",
  • "auditInfo": {
    }
}

Deletes a worklog by ID

Deletes an existing worklog by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Creates a worklog

Creates a worklog.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Worklog unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this worklog is attached. This description is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this worklog is attached. See ownerType for more information. This description is NOT validated, because of dynamic nature of microservice modules.

workerId
string <uuid>

Specify creatin user. Default value for creation is the authenticated user.

description
string

Text of the worklog in a subset of HTML format. Examples of valid HTML can be created using the Editor component in tSM Form Designer in preview mode.

startDate
string <date-time>

Specify worklog start date.

endDate
string <date-time>

Specify worklog end date.

required
object

Custom data.

worklogTypeCode
string

Custom form data as defined by the worklog type.

taskEntityRefId
string

Id of task

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "workerId": "27a13901-5ff4-4d4a-a305-9dd200eae3c5",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "worklogTypeCode": "string",
  • "taskEntityRefId": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "workerId": "27a13901-5ff4-4d4a-a305-9dd200eae3c5",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "worklogTypeCode": "string",
  • "taskEntityRefId": "string",
  • "auditInfo": {
    }
}

WorklogPublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

Identifier of an existing worklog

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "workerId": "27a13901-5ff4-4d4a-a305-9dd200eae3c5",
  • "description": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "worklogTypeCode": "string",
  • "taskEntityRefId": "string",
  • "auditInfo": {
    }
}

Finds all worklogs by owning entity

Returns all worklogs.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Ticket

A type of the owning entity which this worklog is related to such as Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

ownerId
required
string

An identification of the owning entity which the worklog is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns time spent for all worklogs for one owner in seconds.

Returns time spent for all worklogs for one owner in seconds.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this worklog is related to.

ownerId
required
string

An identification of the owning entity which the worklog is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

WorklogPublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
ownerIds
required
Array of strings
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Finds all worklogs by filtering

Returns all worklogs list.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sharing Type

Sharing type public API

Get SharingType

Get log type by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log type unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

object (Audit information)
description
string
validityFrom
string <date-time>
validityTo
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

SharingTypePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

SharingTypePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Log type unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

object (Audit information)
description
string
validityFrom
string <date-time>
validityTo
string <date-time>
object

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SharingTypePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

SharingTypePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SharingTypePublicApi.getAllFilterable Deprecated

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

SharingTypePublicApi.getAllFilterableList Deprecated

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SharingTypePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

Get SharingType Deprecated

Get log type by code

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "auditInfo": {
    },
  • "description": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "localizationData": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

ValueConvertorsApi

Tsm value convertors API

Convert keys to values according to the converter and parameters

Authorizations:
(JWTBasic)
path Parameters
convertorCode
required
string

Identifier of an existing value convertor

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
keys
required
Array of objects
params
object
object

Responses

Request samples

Content type
application/json
{
  • "keys": [
    ],
  • "params": { },
  • "tqlParams": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

ElasticIndexerPublicApi

Elastic indexer API

Aktualizace mapovani

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
entity
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Vrátí Kafku do stavu ze snapshotu (zřejmě pouze přenastaví offset pro konkrétního konzumera)

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
entity
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
timestamp
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "timestamp": 0
}

Response samples

Content type
application/json
{ }

Aktualizace mapovani

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
entity
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
string <uuid>

Responses

Request samples

Content type
application/json
[
  • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Response samples

Content type
application/json
{ }

Požadované cílové mapování

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
entity
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Aktuální mapování

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
entity
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Zjistí, zda je index mapování aktuální (diff mezi mapping a targetMapping)

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
entity
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "isSame": true,
  • "currentMapping": {
    },
  • "targetMapping": {
    }
}

CommentType

Comment type public API

Returns a row by primary key

Returns existing row by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

form
string

A form for representing structured comment.

icon
string <= 255 characters

Graphic element displayed next to comment instance.

privilege
string
textDocumentTemplate
string

Code of template which is used for text format of comment content.

htmlDocumentTemplate
string

Code of template which is used for html format of comment content.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

CommentTypePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

CommentTypePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Row unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

code
required
string [ 1 .. 255 ] characters

Code of this value. It is used whenever the value is referenced from computer program or API. It MUST be unique and SHOULD contain only ASCII characters without spaces (best to use valid programminglanguage identifier).

name
required
string [ 1 .. 255 ] characters

Name of this value, this is displayed to the user.

validityFrom
string <date-time>

Begin of the validity of the value.

validityTo
string <date-time>

End of the validity of the value.

description
string

Description of the value, it may be used as a tooltip.

object

Localization data of the record attributes

form
string

A form for representing structured comment.

icon
string <= 255 characters

Graphic element displayed next to comment instance.

privilege
string
textDocumentTemplate
string

Code of template which is used for text format of comment content.

htmlDocumentTemplate
string

Code of template which is used for html format of comment content.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

CommentTypePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (CommentType)
object (CommentType)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

CommentTypePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

CommentTypePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (CommentType)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

CommentTypePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

CommentTypePublicApi.getTypes

Authorizations:
(JWTBasic)
query Parameters
search
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CommentTypePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

CommentTypePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search comment types Deprecated

Search by comment type filter - filtering, sorting, paging. Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

Search comment types Deprecated

Search by comment type filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CommentTypePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

CommentTypePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validityFrom": "2019-08-24T14:15:22Z",
  • "validityTo": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "localizationData": {
    },
  • "form": "string",
  • "icon": "string",
  • "privilege": "string",
  • "textDocumentTemplate": "string",
  • "htmlDocumentTemplate": "string",
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Script evaluation

Evaluate a tSM script.

Evaluate a tSM script.

Authorizations:
(JWTBasic)
path Parameters
scriptCode
required
string

Code of an existing script (use tSM Config Form to administer scripts).

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
property name*
additional property
object

Responses

Request samples

Content type
application/json
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
application/json
{ }

ElasticIndexPublicApi

Elastic reindex API

Aktualizace dat v rámci existujícího indexu painless skriptem 

       Typicke pouziti pri zmene mapovani chars z basic na typed a prekopirovani hodnoty z chars do charsTyped
        if (ctx._source?.charsTyped?.xxx != null) ctx._source.charsTyped.xxx = ctx._source?.chars?.xxx
Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
waitForCompletion
required
boolean

Sync/async, pro async vrací jobId

object (IndexScript)

Custom script ve formátu reindex-api elastic

Responses

Request samples

Content type
application/json
{
  • "waitForCompletion": true,
  • "script": {
    }
}

Response samples

Content type
application/json
{ }

Nový index, přesun dat, přepnutí aliasu

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
waitForCompletion
required
boolean

Sync/async, pro async vrací jobId

deleteSourceIndex
required
boolean

Zda se má po přepnutí aliasu rovnou zdrojový index smazat

switchAlias
required
boolean

Zda se má změnit název aliasu

object (RemoteSource)

Jako zdroj bere index z celé URL (slouží např. k přesunu z jiného clusteru)

object (IndexScript)

Custom script ve formátu reindex-api elastic

Responses

Request samples

Content type
application/json
{
  • "waitForCompletion": true,
  • "deleteSourceIndex": true,
  • "switchAlias": true,
  • "remote": {
    },
  • "script": {
    }
}

Response samples

Content type
application/json
{ }

Překlopení aliasu po dokončení asynchronního database refreshe.

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Nový index, znovu naplnění ze zdrojových dat, přepnutí aliasu. Vždy asynchronní.

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
entities
required
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Aktualizace dat ze zdrojové databáze, ale v rámci existujícího indexu.

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
entities
required
Array of strings
waitForCompletion
required
boolean

Responses

Request samples

Content type
application/json
{
  • "entities": [
    ],
  • "waitForCompletion": true
}

Response samples

Content type
application/json
{ }

Překlopení aliasu po dokončení asynchronního database refreshe.

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "acknowledge": true,
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Přehled o tom, jaké joby běží a v jakém jsou stavu

Authorizations:
(JWTBasic)
path Parameters
indexCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{ }

TQL result convertor

TQL Convertor public API

TqlResultConvertorPublicApi.convertToExcel

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
required
Array of objects (TQLColumnDescriptor)
rows
required
Array of objects[ items ]
size
required
integer <int32>
total
integer <int64>
cursor
string
status
required
integer <int32>
object (TQLError)
took
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "columns": [
    ],
  • "rows": [
    ],
  • "size": 0,
  • "total": 0,
  • "cursor": "string",
  • "status": 0,
  • "error": {
    },
  • "took": 0
}

Response samples

Content type
application/json
"string"

AttachmentRelatedEntity

AttachmentRelatedEntity public API

AttachmentRelatedEntityPublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of strings <uuid> [ items <uuid > ]
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplate

Formatter document template public API

Returns a row by primary key

Returns existing row by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

Update a value

Update existing value by UUID

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing value

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
code
required
string
name
string
required
object
dataFormatFormId
string <uuid>
previewData
object
object (FormatterTemplatePublic)
dataTags
Array of strings
mnemonicCode
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

Delete

Delete existing entity/value by id or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

FormatterDocumentTemplatePublicApi.patch

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
immediatelyRefresh
boolean
Default: false
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
object (JsonNode)

JobStep property (or several properties) to update

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

FormatterDocumentTemplatePublicApi.saveAndRefresh

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
code
required
string
name
string
required
object
dataFormatFormId
string <uuid>
previewData
object
object (FormatterTemplatePublic)
dataTags
Array of strings
mnemonicCode
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

FormatterDocumentTemplatePublicApi.saveDiff

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
Array
diffType
required
string
Enum: "DIFF_TYPE_NEW" "DIFF_TYPE_CHANGE" "DIFF_TYPE_REMOVE"
object (FormatterDocumentTemplatePublic)
object (FormatterDocumentTemplatePublic)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplatePublicApi.diff

Authorizations:
(JWTBasic)
query Parameters
save
boolean

Save the diff immediately

compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
file
required
string <binary>

File binary content

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplatePublicApi.diffOnly

Authorizations:
(JWTBasic)
query Parameters
compareField
string
Default: "id"

Field for entry matching

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
name
string
whenExported
string <date-time>
exportedBy
string
required
Array of objects (FormatterDocumentTemplatePublic)
required
Array of objects (Filter)
entityType
string
listingType
string
listingProfile
string
compareField
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplatePublicApi.backup

Authorizations:
(JWTBasic)
query Parameters
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
entityType
required
string
compareField
string
listingType
string
listingProfile
string
Array of objects (Filter)

Responses

Request samples

Content type
application/json
{
  • "entityType": "string",
  • "compareField": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "filtering": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "whenExported": "2019-08-24T14:15:22Z",
  • "exportedBy": "string",
  • "data": [
    ],
  • "filtering": [
    ],
  • "entityType": "string",
  • "listingType": "string",
  • "listingProfile": "string",
  • "compareField": "string"
}

FormatterDocumentTemplatePublicApi.getByTemplateByCode

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

Search for values and return the result as a list

Search by filter - filtering, sorting Consult the documentation for further information.

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>

Maxmimum records returned. Default value is 1000.

required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplatePublicApi.getAllFilterablePage

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

FormatterDocumentTemplatePublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of objects
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplatePublicApi.getAllFilterable Deprecated

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

FormatterDocumentTemplatePublicApi.getAllFilterableList Deprecated

Authorizations:
(JWTBasic)
query Parameters
size
integer <int32>
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

FormatterDocumentTemplatePublicApi.getDataTags

Authorizations:
(JWTBasic)
query Parameters
search
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • "string"
]

FormatterDocumentTemplatePublicApi.countFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
0
0

FormatterDocumentTemplatePublicApi.getByCode Deprecated

Authorizations:
(JWTBasic)
path Parameters
code
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "data": {
    },
  • "dataFormatFormId": "3c40463c-c7e2-4cd7-ae56-93e7716b9f3f",
  • "previewData": { },
  • "formatterTemplate": {
    },
  • "dataTags": [
    ],
  • "mnemonicCode": "string",
  • "auditInfo": {
    }
}

Get all rows Deprecated

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Comment Public API

API for creating and retrieving comments. Comments are used for storing notes, comments, etc. for any entity in the system identified by ownerId and ownerType. Comments can be distinguished by their type (e.g. 'Customer request', 'Technician visit', etc.) and may contain additional metadata with the structure defined by the comment type.

Returns a comment

Returns an existing comment by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "comment": "string",
  • "private": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "commentTypeCode": "string",
  • "commentTypeName": "string",
  • "auditInfo": {
    }
}

Updates a comment

Updates a comment.

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>

An identifier of an existing comment

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Comment unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this comment is attached. This description is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this comment is attached. See ownerType for more information. This description is NOT validated, because of dynamic nature of microservice modules.

comment
string

Text of the comment in HTML format.

private
boolean

Private comments are generally hidden from the customer (e.g. on a customer portal).

userId
string <uuid>

Specify creatin user. Default value for creation is the authenticated user.

date
string <date-time>

Specify comment creation date. The default description is now().

formData
object

Custom form data as defined by the comment type.

commentTypeCode
string

Code of related comment type.

commentTypeName
string

Name of related comment type.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "comment": "string",
  • "private": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "commentTypeCode": "string",
  • "commentTypeName": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "comment": "string",
  • "private": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "commentTypeCode": "string",
  • "commentTypeName": "string",
  • "auditInfo": {
    }
}

Deletes a comment by ID

Deletes an existing comment by UUID

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

Creates a comment

Creates a comment.

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>

Comment unique identifier / primary key in UUID format. ID may be assigned by the client using UUIDv4 standard, or it is generated by TSM.This ID SHOULD NOT be displayed to the end user.

ownerType
required
string

Type of the owning entity to which this comment is attached. This description is NOT validated, because of dynamic nature of microservice modules.

ownerId
required
string

Identification of the owning entity to which this comment is attached. See ownerType for more information. This description is NOT validated, because of dynamic nature of microservice modules.

comment
string

Text of the comment in HTML format.

private
boolean

Private comments are generally hidden from the customer (e.g. on a customer portal).

userId
string <uuid>

Specify creatin user. Default value for creation is the authenticated user.

date
string <date-time>

Specify comment creation date. The default description is now().

formData
object

Custom form data as defined by the comment type.

commentTypeCode
string

Code of related comment type.

commentTypeName
string

Name of related comment type.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "comment": "string",
  • "private": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "commentTypeCode": "string",
  • "commentTypeName": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ownerType": "Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry",
  • "ownerId": "string",
  • "comment": "string",
  • "private": true,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "date": "2019-08-24T14:15:22Z",
  • "formData": { },
  • "commentTypeCode": "string",
  • "commentTypeName": "string",
  • "auditInfo": {
    }
}

Finds all comments by owning entity

Returns all comments.

Authorizations:
(JWTBasic)
path Parameters
ownerType
required
string
Example: Customer, Ticket, EntityInstanceConfiguration, EntityInstance, etc. from EntityType registry

A type of the owning entity which this comment is related to.

ownerId
required
string

An identification of the owning entity which the comment is related to

header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CommentPublicApi.getByIds

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of strings <uuid> [ items <uuid > ]
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CommentPublicApi.getCommentAsPlainText

Authorizations:
(JWTBasic)
path Parameters
commentId
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
"string"

CommentPublicApi.getCommentAsHtml

Authorizations:
(JWTBasic)
path Parameters
commentId
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
"string"

Finds all comments by filtering

Returns all comments list.

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

tql-api

TQLApi.searchPageJson

Authorizations:
(JWTBasic)
query Parameters
tql
required
string
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

TQLApi.searchPageJson

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
query
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "params": {
    }
}

Response samples

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

TQLApi.searchJson

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
query
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
"string"

Vygeneruje excel na základě tql dotazu

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
query
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
"string"

TQLApi.explain

Authorizations:
(JWTBasic)
query Parameters
object
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
query
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
"string"

TQLApi.search

Authorizations:
(JWTBasic)
query Parameters
tql
required
string
object
convertEmpty
boolean
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
No sample

TQLApi.searchByPath

Authorizations:
(JWTBasic)
query Parameters
convertEmpty
boolean
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
query
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "params": {
    }
}

Response samples

Content type
No sample

recently-used-entity-public-api

RecentlyUsedEntityPublicApi.updateOrCreateRecentlyUsedEntity

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
id
string <uuid>
userId
required
string <uuid>
created
required
string <date-time>
name
string
entityId
string
entityType
required
string
data
object
icon
string
url
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "created": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "entityId": "string",
  • "entityType": "string",
  • "data": { },
  • "icon": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

RecentlyUsedEntityPublicApi.getRecentlyUsedEntitiesByUserId

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
query Parameters
maxRows
integer <int32>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

RecentlyUsedEntityPublicApi.getRecentlyUsedEntitiesByUserIdAndEntityType

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
entityType
required
string
query Parameters
maxRows
integer <int32>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

RecentlyUsedEntityPublicApi.getAllFilterable

Authorizations:
(JWTBasic)
query Parameters
required
object (Filtering)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

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

RecentlyUsedEntityPublicApi.deleteRecentlyUsedEntityById

Authorizations:
(JWTBasic)
path Parameters
id
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

RecentlyUsedEntityPublicApi.deleteAllRecentlyUsedEntitiesByUserId

Authorizations:
(JWTBasic)
path Parameters
userId
required
string <uuid>
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Responses

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}

email-public-api

EmailPublicApi.sendEventEmailNotification

Authorizations:
(JWTBasic)
header Parameters
X-Request-Id
string

X-Request-Id is a random request-id to uniquely identify each request sent to tSM. This ID is available as the X-Request-Id header in API Response object.

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to a particular transaction or event chain. For every request, you should use X-Request-Id, for request transaction, you should use X-Correlation-ID.

Request Body schema: application/json
required
from
string

Sender custom email

fromName
string

Sender custom email person name

to
required
string

Email recipment

subject
required
string

Email subject

body
required
string

Email body

object

Email map of Base64 attachments. AttachmentName -> AttachmentBase64Content

Responses

Request samples

Content type
application/json
{
  • "from": "string",
  • "fromName": "string",
  • "to": "string",
  • "subject": "string",
  • "body": "string",
  • "attachments": {
    }
}

Response samples

Content type
application/json
{
  • "status": "BAD_REQUEST",
  • "timestamp": "2022-11-11T06:55:27.334Z",
  • "message": "Wrong format for UUID field. ID value '5131315' is not a valid UUID string.",
  • "traceId": "1c81b8e6a7c672df",
  • "errors": [
    ]
}