Skip to main content
API docs by Redocly

TSM User Management API (2.0)

Download OpenAPI specification:Download

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

API for Telco Service Management - User Management

User group type

User group 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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "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

userGroupSpecId
string <uuid>
required
object
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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "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": [
    ]
}

UserGroupTypePublicApi.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)

User group 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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "auditInfo": {
    }
}

UserGroupTypePublicApi.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

userGroupSpecId
string <uuid>
required
object
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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "auditInfo": {
    }
}

UserGroupTypePublicApi.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 (UserGroupType)
object (UserGroupType)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

UserGroupTypePublicApi.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
[
  • {
    }
]

UserGroupTypePublicApi.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 (UserGroupType)
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
[
  • {
    }
]

UserGroupTypePublicApi.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
[
  • {
    }
]

UserGroupTypePublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

UserGroupTypePublicApi.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 user group types Deprecated

Search by user group 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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Search user group types Deprecated

Search by user group 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
[
  • {
    }
]

UserGroupTypePublicApi.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

UserGroupTypePublicApi.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": {
    },
  • "userGroupSpecId": "65ef8526-0243-4b49-9f19-11eaab60d75b",
  • "registry": {
    },
  • "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
[
  • {
    }
]

Access rule

Access rule 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",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "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
name
required
string
object (TimePeriod)
entityName
string
expression
string
accessRule
string
Enum: "READ" "READ_WRITE"
fullAccess
required
boolean
description
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "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": [
    ]
}

AccessRulePublicApi.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)

User group 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",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "string",
  • "auditInfo": {
    }
}

AccessRulePublicApi.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
name
required
string
object (TimePeriod)
entityName
string
expression
string
accessRule
string
Enum: "READ" "READ_WRITE"
fullAccess
required
boolean
description
string
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "string",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "string",
  • "auditInfo": {
    }
}

AccessRulePublicApi.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 (AccessRule)
object (AccessRule)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

AccessRulePublicApi.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
[
  • {
    }
]

AccessRulePublicApi.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 (AccessRule)
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
[
  • {
    }
]

AccessRulePublicApi.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
[
  • {
    }
]

AccessRulePublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

AccessRulePublicApi.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
[
  • {
    }
]

AccessRulePublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

AccessRulePublicApi.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
[
  • {
    }
]

AccessRulePublicApi.getAccessRulesExpressionWrite

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.

Responses

Response samples

Content type
application/json
[
  • "string"
]

AccessRulePublicApi.getAccessRulesExpressionRead

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.

Responses

Response samples

Content type
application/json
[
  • "string"
]

AccessRulePublicApi.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

AccessRulePublicApi.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",
  • "validFor": {
    },
  • "entityName": "string",
  • "expression": "string",
  • "accessRule": "READ",
  • "fullAccess": true,
  • "description": "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
[
  • {
    }
]

Admin

Admin public API

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": [
    ]
}

RoleAccessRule

RoleAccessRule public API

RoleAccessRulePublicApi.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
[
  • {
    }
]

UserRole

UserRoleP public API

UserRolePublicApi.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
[
  • {
    }
]

UserUserGroup

UserUserGroup public API

UserUserGroupPublicApi.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
[
  • {
    }
]

User group

User group public API

Returns a user group

Returns existing user group 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",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Update existing user group

Updates all properties of an existing user group.

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> (UUID)

User 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 (Code)

User group unique identifier.

type
required
string (Type)

User group type unique identifier.

name
required
string (Name)

User group description.

description
string (DEscription)

Description for role.

ldapMemberOf
string (Ldap member)

If User group is in LDAP, then location in LDAP.

parentUserGroupId
string <uuid> (Parent user group ID)

Identifier of parent user group.

validFrom
string <date-time> (Valid from)

User group valid date from.

validTo
string <date-time> (Valid to)

User group valid date to.

dataTags
Array of strings (Data tags)

Additional data tags (aka labels).

email
string (Email)

User group email.

phoneNumber
string (Phone number)

User group phone number.

required
UserGroupType-PruzkumObchodnihoPripadu (object) or UserGroupType-Test (object) or UserGroupType-OR (object) (UserGroupChars)

Map of entity characteristics indexed by characteristics code.

associatedUserRoleId
string <uuid> (Associated role)

If a user has this group, they automatically receive the selected role upon logging in.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Delete a user group

Delete existing User group 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": [
    ]
}

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",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "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> (UUID)

User 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 (Code)

User group unique identifier.

type
required
string (Type)

User group type unique identifier.

name
required
string (Name)

User group description.

description
string (DEscription)

Description for role.

ldapMemberOf
string (Ldap member)

If User group is in LDAP, then location in LDAP.

parentUserGroupId
string <uuid> (Parent user group ID)

Identifier of parent user group.

validFrom
string <date-time> (Valid from)

User group valid date from.

validTo
string <date-time> (Valid to)

User group valid date to.

dataTags
Array of strings (Data tags)

Additional data tags (aka labels).

email
string (Email)

User group email.

phoneNumber
string (Phone number)

User group phone number.

required
UserGroupType-PruzkumObchodnihoPripadu (object) or UserGroupType-Test (object) or UserGroupType-OR (object) (UserGroupChars)

Map of entity characteristics indexed by characteristics code.

associatedUserRoleId
string <uuid> (Associated role)

If a user has this group, they automatically receive the selected role upon logging in.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "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": [
    ]
}

Update properties of an existing user group

Updates properties of an existing user group.

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of an existing user group

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)

User group 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",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Create new user group

Creates a user group with basic properties set.Either set ID with standard UUID generator, or do not send it at all, it will be generated via backend

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> (UUID)

User 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 (Code)

User group unique identifier.

type
required
string (Type)

User group type unique identifier.

name
required
string (Name)

User group description.

description
string (DEscription)

Description for role.

ldapMemberOf
string (Ldap member)

If User group is in LDAP, then location in LDAP.

parentUserGroupId
string <uuid> (Parent user group ID)

Identifier of parent user group.

validFrom
string <date-time> (Valid from)

User group valid date from.

validTo
string <date-time> (Valid to)

User group valid date to.

dataTags
Array of strings (Data tags)

Additional data tags (aka labels).

email
string (Email)

User group email.

phoneNumber
string (Phone number)

User group phone number.

required
UserGroupType-PruzkumObchodnihoPripadu (object) or UserGroupType-Test (object) or UserGroupType-OR (object) (UserGroupChars)

Map of entity characteristics indexed by characteristics code.

associatedUserRoleId
string <uuid> (Associated role)

If a user has this group, they automatically receive the selected role upon logging in.

object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

UserGroupPublicApi.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 (User group)

User group with all parameters set

object (User group)

User group with all parameters set

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

UserGroupPublicApi.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
[
  • {
    }
]

UserGroupPublicApi.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 (User group)
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
[
  • {
    }
]

UserGroupPublicApi.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 list of user groups

Returns existing user groups by given codes

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
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

Returns a map of user groups for each user UUID

Returns map of existing user groups by given user UUIDs

Authorizations:
(JWTBasic)
query Parameters
userIds
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
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Get all user groups by user UUID

Get all user groups by user UUID

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
[
  • {
    }
]

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
[
  • {
    }
]

Find user group by code

Find user group 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",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Find userGroup by value stored in chars

Find userGroup by value stored in chars

Authorizations:
(JWTBasic)
path Parameters
path
required
string
value
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
[
  • {
    }
]

Searches tickets

Searches tickets by a filter allowing filtering, sorting, paging. For more information, please see the documentation.

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
[
  • {
    }
]

UserGroupPublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Searches groups in LDAP

Searches for user groups in LDAP by their membership (ldapMemberOf)

Authorizations:
(JWTBasic)
path Parameters
ldapMemberOf
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
{
  • "name": "string",
  • "code": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "readonlyAccess": true,
  • "version": 0,
  • "whoInserted": "string",
  • "whenInserted": "2019-08-24T14:15:22Z",
  • "whenEdited": "2019-08-24T14:15:22Z",
  • "whoEdited": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "period": {
    },
  • "chars": {
    },
  • "userGroupType": {
    },
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656"
}

UserGroupPublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

UserGroupPublicApi.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
[
  • {
    }
]

UserGroupPublicApi.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"
]

UserGroupPublicApi.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

UserGroupPublicApi.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",
  • "type": "string",
  • "name": "string",
  • "description": "string",
  • "ldapMemberOf": "string",
  • "parentUserGroupId": "7ecd7fe8-bf60-4580-becd-4f971de7ac8b",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "dataTags": [
    ],
  • "email": "string",
  • "phoneNumber": "string",
  • "chars": { },
  • "associatedUserRoleId": "e4098f96-2e72-45ab-88e8-c382814ee656",
  • "auditInfo": {
    }
}

Get all user groups 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
[
  • {
    }
]

Returns a user groups

Returns existing user groups by given UUIDs

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
[
  • {
    }
]

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"
}

User type

User 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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "icon": "string",
  • "config": { },
  • "registry": {
    },
  • "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

type
required
string (Type)
Enum: "INDIVIDUAL" "WORK_GROUP" "ORGANIZATION" "EXTERNAL"

Indicates the type of the resource. This value MUST be one of user type code from 'User type' registry (INDIVIDUAL, WORK_GROUP, ORGANIZATION).

entitySpecId
string <uuid>

Entity specification ID.

config
object
required
object
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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "config": { },
  • "registry": {
    },
  • "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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "icon": "string",
  • "config": { },
  • "registry": {
    },
  • "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": [
    ]
}

UserTypePublicApi.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)

User group 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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "icon": "string",
  • "config": { },
  • "registry": {
    },
  • "auditInfo": {
    }
}

UserTypePublicApi.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

type
required
string (Type)
Enum: "INDIVIDUAL" "WORK_GROUP" "ORGANIZATION" "EXTERNAL"

Indicates the type of the resource. This value MUST be one of user type code from 'User type' registry (INDIVIDUAL, WORK_GROUP, ORGANIZATION).

entitySpecId
string <uuid>

Entity specification ID.

config
object
required
object
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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "config": { },
  • "registry": {
    },
  • "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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "icon": "string",
  • "config": { },
  • "registry": {
    },
  • "auditInfo": {
    }
}

UserTypePublicApi.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 (UserType)
object (UserType)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

UserTypePublicApi.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
[
  • {
    }
]

UserTypePublicApi.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 (UserType)
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
[
  • {
    }
]

UserTypePublicApi.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
[
  • {
    }
]

UserTypePublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

UserTypePublicApi.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 user types Deprecated

Search by user 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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Search user types Deprecated

Search by user 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
[
  • {
    }
]

UserTypePublicApi.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

Returns a row by code Deprecated

Returns existing row by UUID

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": {
    },
  • "type": "INDIVIDUAL",
  • "entitySpecId": "65cb4992-7cbf-4ce6-9e4b-7116d921100e",
  • "icon": "string",
  • "config": { },
  • "registry": {
    },
  • "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
{ }

User group regions

User group regions public API

Find user group region by group code

Find user group region by group code.

Authorizations:
(JWTBasic)
path Parameters
groupId
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
[
  • {
    }
]

Find user group region by group code and region id

Find user group region by group code and region id

Authorizations:
(JWTBasic)
path Parameters
groupId
required
string
regionId
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",
  • "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
  • "userGroup": {
    },
  • "auditInfo": {
    }
}

Find user group region by group code

Find user group region by group code.

Authorizations:
(JWTBasic)
path Parameters
groupCode
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
[
  • {
    }
]

Get all user groups

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
[
  • {
    }
]

User

User public API

Update existing user

Updates all properties of an existing user.

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

Identifier of an existing 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.

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

User 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 (Code)

User unique identifier / business key in readable format.

type
required
string (Type)

Indicates the type of the resource. This value MUST be one of user type code from 'User type' registry (INDIVIDUAL, WORK_GROUP, ORGANIZATION).

givenName
string (Given name)

User given name.

familyName
string (Family name)

User family name.

name
required
string (Name)

Comapany or group name. Is required for register User type WORK_GROUP and ORGANIZATION. For INDIVIDUAL option is parameter ignored.

email
string (Email)

User email.

phoneNumber
string (Phone number)

User phone number.

webSite
string (Web site)

URL of the user’s Web page or blog.

status
required
string (Status)
Enum: "ENABLE" "DISABLE"

User status. This value MUST be one of user status code from 'User status' registry (ENABLE, DISABLE). Default value is 'ENABLE'.

validFrom
string <date-time> (Valid from) yyyy-MM-dd

User valid date from. Required date format yyyy-MM-dd.

validTo
string <date-time> (Valid to) yyyy-MM-dd

User valid date to. Required date format yyyy-MM-dd.

authentication
required
string (Authentication)
Default: "PASSWORD"
Enum: "LDAP" "PKI" "AD" "PASSWORD" "EMPTY"

User authentication. This value MUST be one of authentication code from 'Authentication' registry (LDAP, PKI, AD, EMPTY). Default value is 'AD'.

description
string (Description)

User description.

groups
Array of strings (Groups)

User groups assigned to the user.

roles
Array of strings (Roles)

User roles assigned to the user.

dataTags
Array of strings (Data tags)

Additional data tags (aka labels).

required
UserType-TSM-UsersType-Individual (object) or UserType-TSM-UsersModule-WFM (object) (UserChars)

Map of entity characteristics indexed by characteristics code.

supervisorId
string <uuid> (Supervisor UUID)

Supervisor or manager of the user (UUID).

Array of objects (Regions)

User regions.

object (NotificationConfig)

Data for notification configuration.

modulesIds
Array of strings <uuid> [ items <uuid > ]
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

Update properties of an existing user

Updates properties of an existing user.

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

Identifier of an existing 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.

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

User group 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",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

Create new user

Creates a user with basic properties set.Either set ID with standard UUID generator, or do not send it at all, it will be generated via backend

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> (UUID)

User 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 (Code)

User unique identifier / business key in readable format.

type
required
string (Type)

Indicates the type of the resource. This value MUST be one of user type code from 'User type' registry (INDIVIDUAL, WORK_GROUP, ORGANIZATION).

givenName
string (Given name)

User given name.

familyName
string (Family name)

User family name.

name
required
string (Name)

Comapany or group name. Is required for register User type WORK_GROUP and ORGANIZATION. For INDIVIDUAL option is parameter ignored.

email
string (Email)

User email.

phoneNumber
string (Phone number)

User phone number.

webSite
string (Web site)

URL of the user’s Web page or blog.

status
required
string (Status)
Enum: "ENABLE" "DISABLE"

User status. This value MUST be one of user status code from 'User status' registry (ENABLE, DISABLE). Default value is 'ENABLE'.

validFrom
string <date-time> (Valid from) yyyy-MM-dd

User valid date from. Required date format yyyy-MM-dd.

validTo
string <date-time> (Valid to) yyyy-MM-dd

User valid date to. Required date format yyyy-MM-dd.

authentication
required
string (Authentication)
Default: "PASSWORD"
Enum: "LDAP" "PKI" "AD" "PASSWORD" "EMPTY"

User authentication. This value MUST be one of authentication code from 'Authentication' registry (LDAP, PKI, AD, EMPTY). Default value is 'AD'.

description
string (Description)

User description.

groups
Array of strings (Groups)

User groups assigned to the user.

roles
Array of strings (Roles)

User roles assigned to the user.

dataTags
Array of strings (Data tags)

Additional data tags (aka labels).

required
UserType-TSM-UsersType-Individual (object) or UserType-TSM-UsersModule-WFM (object) (UserChars)

Map of entity characteristics indexed by characteristics code.

supervisorId
string <uuid> (Supervisor UUID)

Supervisor or manager of the user (UUID).

Array of objects (Regions)

User regions.

object (NotificationConfig)

Data for notification configuration.

modulesIds
Array of strings <uuid> [ items <uuid > ]
object (Audit information)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

Uploads user thumbnail

Upload user thumbnal as base64 encoded image string

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

Identifier of an existing 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.

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

The ID the API uses to uniquely identify the user.

photoData
required
string

Base64 encoding photo imge.

Responses

Request samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "photoData": "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": [
    ]
}

Change a user’s password

Change a user’s password.

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.

Request Body schema: application/json
required
password
required
string

Plain text of a user new password.

Responses

Request samples

Content type
application/json
{
  • "password": "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": [
    ]
}

Returns a user

Returns existing user by UUID or code

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string
query Parameters
expand
Array of strings (UserExtend)
Items Enum: "REGIONS" "ROLES"
Example: expand=REGIONS

Possible extensions of the user 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",
  • "code": "string",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

UserPublicApi.getUserAuthorities

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

Identifier of an existing 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
[
  • "string"
]

Returns a users with given group

Returns a users with given group

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of use 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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a valid users with given group

Returns a valid users with given group

Authorizations:
(JWTBasic)
path Parameters
idOrCode
required
string

Identifier of use 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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a users with given groups

Returns a users with given groups

Authorizations:
(JWTBasic)
path Parameters
ids
required
Array of strings <uuid> [ items <uuid > ]

Identifiers UUID of user groups

header Parameters
X-Request-Id
string

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

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to 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
[
  • {
    }
]

UserPublicApi.getByType

Authorizations:
(JWTBasic)
path Parameters
type
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
[
  • {
    }
]

Search users

Search by user 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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Search users

Search by user 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
[
  • {
    }
]

Returns a users

Returns existing users by chars key

Authorizations:
(JWTBasic)
path Parameters
key
required
string
value
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 users

Returns existing users by chars key and subkey

Authorizations:
(JWTBasic)
path Parameters
key
required
string
subkey
required
string
value
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 users

Returns existing users by chars key and subkey

Authorizations:
(JWTBasic)
path Parameters
key
required
string
subkey
required
string
value
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 user

Returns existing user by code, ignore case

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",
  • "type": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "webSite": "string",
  • "status": "ENABLE",
  • "validFrom": "2019-08-24T14:15:22Z",
  • "validTo": "2019-08-24T14:15:22Z",
  • "authentication": "LDAP",
  • "description": "string",
  • "groups": [
    ],
  • "roles": [
    ],
  • "dataTags": [
    ],
  • "chars": { },
  • "supervisorId": "a2fda596-7b8e-406f-9d80-2cf98d860455",
  • "regions": [
    ],
  • "notificationConfig": {
    },
  • "modulesIds": [
    ],
  • "auditInfo": {
    }
}

UserPublicApi.getAllByIds

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
[
  • {
    }
]

UserPublicApi.addRoleToUser

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

Identifier of an existing user

roleName
required
string

Name of an existing role

header Parameters
X-Request-Id
string

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

X-Correlation-Id
string

X-Correlation-Id , also known as a Transit ID, is a unique identifier value that is attached to requests and messages that allow reference to 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
{
  • "user": {
    },
  • "role": {
    },
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "readonlyAccess": true,
  • "version": 0,
  • "whoInserted": "string",
  • "whenInserted": "2019-08-24T14:15:22Z",
  • "whenEdited": "2019-08-24T14:15:22Z",
  • "whoEdited": "string",
  • "grantOption": true
}

Role

Role 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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "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

dataTags
Array of strings
ldapMemberOf
string

If UserRole is in LDAP then location in LDAP.

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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "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": [
    ]
}

RolePublicApi.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)

User group 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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "string",
  • "auditInfo": {
    }
}

RolePublicApi.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

dataTags
Array of strings
ldapMemberOf
string

If UserRole is in LDAP then location in LDAP.

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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "string",
  • "auditInfo": {
    }
}

RolePublicApi.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 (Role)
object (Role)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

RolePublicApi.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
[
  • {
    }
]

RolePublicApi.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 (Role)
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
[
  • {
    }
]

RolePublicApi.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
[
  • {
    }
]

RolePublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

RolePublicApi.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 roles Deprecated

Search by role 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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

Search roles Deprecated

Search by role 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
[
  • {
    }
]

RolePublicApi.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

RolePublicApi.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": {
    },
  • "dataTags": [
    ],
  • "ldapMemberOf": "string",
  • "auditInfo": {
    }
}

Get all roles by codes

Authorizations:
(JWTBasic)
path Parameters
ids
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
[
  • {
    }
]

Get all roles by codes

Authorizations:
(JWTBasic)
path Parameters
codes
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
[
  • {
    }
]

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
[
  • {
    }
]

RolePriv

RolePriv public API

RolePrivPublicApi.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
[
  • {
    }
]

Privilege

Privilege 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",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

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
name
required
string
description
string
privType
string
Enum: "SYSTEM" "USER"
object (Audit information)
object

Additional general configuration of the Priv entity.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

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": [
    ]
}

PrivPublicApi.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)

User group 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",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

PrivPublicApi.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
name
required
string
description
string
privType
string
Enum: "SYSTEM" "USER"
object (Audit information)
object

Additional general configuration of the Priv entity.

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "code": "string",
  • "name": "string",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

PrivPublicApi.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 (Priv)
object (Priv)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

PrivPublicApi.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
[
  • {
    }
]

PrivPublicApi.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 (Priv)
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
[
  • {
    }
]

PrivPublicApi.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
[
  • {
    }
]

PrivPublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

PrivPublicApi.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
[
  • {
    }
]

PrivPublicApi.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,
  • "sort": {
    },
  • "first": true,
  • "last": true,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "empty": true
}

PrivPublicApi.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
[
  • {
    }
]

PrivPublicApi.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

PrivPublicApi.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",
  • "description": "string",
  • "privType": "SYSTEM",
  • "auditInfo": {
    },
  • "config": {
    }
}

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
[
  • {
    }
]