API docs by Redocly

DPMS RESTful API (v1.0.21)

Download OpenAPI specification:Download

E-mail: info@dpms-online.de URL: https://www.dpms-online.de

Our RESTful API lets you interact with the DPMS using JSON over HTTPS.

We're continually working hard on making more features available through the API.

Single-user Authorization-Token

You can obtain a single user <token> inside the profile area of the user.

API Endpoint

The API is accessed via https://app.dpms-online.de/api/ and speaks JSON over HTTPS.

For white label or server versions, the login URL of the instance must be used accordingly: https://example.com/api/

API Version

You need to specifiy the version you are using after the URL before the endpoint:

https://app.dpms-online.de/api/v1/me

The current major version is v1.

General

  • HTTPS only: All requests are done over HTTPS.
  • UTF-8 encoding: All strings are sent and received in UTF-8.
  • JSON in, JSON out: Data is sent and received as JSON (although some endpoints return CSV or PDF documents).
  • ISO Date format: Dates and DateTimes are in ISO 8601 format:
    • Date: 2021-07-18
    • DateTime: 2021-03-13T12:26:40+01:00

HTTP Methods

We're trying to keep our URLs as RESTful as possible. This means that every resource endpoint may support one or more of the following HTTP methods:

  • GET Retrieves information about a resource.
  • POST Creates a resource.
  • PUT Fully updates a resource.
  • PATCH Partially updates a resource; only include the properties to be updated.
  • DELETE Deletes a resource.

Errors

The API uses standard HTTP status codes to indicate that a request has gone wrong.

Additionally, the body of the response always contains a error (JSON) describing the issue in more detail.

400 Bad Request

HTTP Status 400 is returned when:

You send invalid JSON, that does not conform to the schema for the endpoint. "Content-type" header should be passed with "application/json" value. Business rules prevent the operation you are attempting.

403 Forbidden

HTTP Status 403 is returned when:

  • You did not provide an access token in the HTTP header Authorization: Bearer <token>
  • The token you are supplying has been revoked or is invalid. In this case stop calling the API with that token
  • the user hat no access to a specific resource

404 Not Found

429 Rate limit exceeded

You will get this error when you make many request too fast against the API.

500 Internal Server Error

All endpoints can also return HTTP Status 500 (Internal server error) if there is a problem on the server.

contract

Operations to handle contracts.

get list of contract templates for the company

get list of contract templates for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of contracts for the company

get list of contracts for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get contract for the given id

get contract for the given id

Authorizations:
bearerAuth
path Parameters
contractId
required
integer <int64> >= 1

The ID of the contract

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "templateId": 1,
  • "title": "Auftragsverarbeitungsvertrag",
  • "validUntil": "2021-03-13T12:26:40+01:00",
  • "isOrderProcessingContract": true,
  • "emailReceiver": "test@example.com",
  • "emailSubject": "Betreff",
  • "emailSalutation": "Hallo %vorname% %nachname%,",
  • "emailBody": "Testraße 1337\n47608 Geldern\n",
  • "signatureReceiver": "Mustermann GmbH",
  • "signatureAddress": "Teststraße 1337\n47608 Geldern\n",
  • "signaturePosition": "Geschäftsführer",
  • "signatureFirstname": "Peter",
  • "signatureLastname": "Mustermann",
  • "contractId": 1,
  • "shareLink": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "emailTime": "2021-03-13T12:26:40+01:00",
  • "signatureTime": "2021-03-13T12:26:40+01:00"
}

updates contract

updates contract

Authorizations:
bearerAuth
path Parameters
contractId
required
integer <int64> >= 1

The ID of the contract

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
emailReceiver
string
emailSubject
string
emailSalutation
string
emailBody
string
title
string
validUntil
string
signatureReceiver
string
signatureAddress
string
signaturePosition
string
signatureFirstname
string
signatureLastname
string

Responses

Request samples

Content type
application/json
{
  • "emailReceiver": "test@example.com",
  • "emailSubject": "Betreff",
  • "emailSalutation": "Hallo %vorname% %nachname%,",
  • "emailBody": "Testraße 1337\n47608 Geldern\n",
  • "title": "Auftragsverarbeitungsvertrag",
  • "validUntil": "2021-03-13T12:26:40+01:00",
  • "signatureReceiver": "Mustermann GmbH",
  • "signatureAddress": "Teststraße 1337\n47608 Geldern\n",
  • "signaturePosition": "Geschäftsführer",
  • "signatureFirstname": "Peter",
  • "signatureLastname": "Mustermann"
}

Response samples

Content type
application/json
{
  • "templateId": 1,
  • "title": "Auftragsverarbeitungsvertrag",
  • "validUntil": "2021-03-13T12:26:40+01:00",
  • "isOrderProcessingContract": true,
  • "emailReceiver": "test@example.com",
  • "emailSubject": "Betreff",
  • "emailSalutation": "Hallo %vorname% %nachname%,",
  • "emailBody": "Testraße 1337\n47608 Geldern\n",
  • "signatureReceiver": "Mustermann GmbH",
  • "signatureAddress": "Teststraße 1337\n47608 Geldern\n",
  • "signaturePosition": "Geschäftsführer",
  • "signatureFirstname": "Peter",
  • "signatureLastname": "Mustermann",
  • "contractId": 1,
  • "shareLink": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "emailTime": "2021-03-13T12:26:40+01:00",
  • "signatureTime": "2021-03-13T12:26:40+01:00"
}

deletes contract

deletes contract

Authorizations:
bearerAuth
path Parameters
contractId
required
integer <int64> >= 1

The ID of the contract

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

get binary PDF file

get binary PDF file

Authorizations:
bearerAuth
path Parameters
contractId
required
integer <int64> >= 1

The ID of the contract

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

send the contract by email to the receiver

send the contract by email to the receiver

Authorizations:
bearerAuth
path Parameters
contractId
required
integer <int64> >= 1

The ID of the contract

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
emailReceiver
string
emailSubject
string
emailSalutation
string
emailBody
string

Responses

Request samples

Content type
application/json
{
  • "emailReceiver": "test@example.com",
  • "emailSubject": "Betreff",
  • "emailSalutation": "Hallo %vorname% %nachname%,",
  • "emailBody": "Testraße 1337\n47608 Geldern\n"
}

Response samples

Content type
application/json
{
  • "templateId": 1,
  • "title": "Auftragsverarbeitungsvertrag",
  • "validUntil": "2021-03-13T12:26:40+01:00",
  • "isOrderProcessingContract": true,
  • "emailReceiver": "test@example.com",
  • "emailSubject": "Betreff",
  • "emailSalutation": "Hallo %vorname% %nachname%,",
  • "emailBody": "Testraße 1337\n47608 Geldern\n",
  • "signatureReceiver": "Mustermann GmbH",
  • "signatureAddress": "Teststraße 1337\n47608 Geldern\n",
  • "signaturePosition": "Geschäftsführer",
  • "signatureFirstname": "Peter",
  • "signatureLastname": "Mustermann",
  • "contractId": 1,
  • "shareLink": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "emailTime": "2021-03-13T12:26:40+01:00",
  • "signatureTime": "2021-03-13T12:26:40+01:00"
}

consultant

Operations for consultants.

get list of available categories

get list of available categories

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of available groups

get list of available groups

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of available rubrics

get list of available rubrics

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of existing clients

get list of existing clients

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create new client

creates new client, company and adds users to it

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Request Body schema: application/json
name
required
string
categoryId
integer
groupId
integer
rubricId
integer
email
string
customerNumber
string
aliasName
string
infoText
string
disableAutoUpdate
boolean
disableMessageCenter
boolean
disableWeeklyUpdate
boolean
disableTaskInfo
boolean
disableCompanyEmailLayout
boolean
disableMessagesForConsultantUser
boolean
useConsultantLayoutForTrainingPage
boolean
useConsultantLogoForTrainingCerts
boolean
restrictNewUserPermissions
boolean
newUserDefaultLevelId
integer

find available levels via GET /levels

enableWatermark
boolean
Array of objects (BaseUserCompanyItem)

Responses

Request samples

Content type
application/json
{
  • "name": "ACME Company",
  • "categoryId": 1,
  • "groupId": 1,
  • "rubricId": 1,
  • "email": "test@test.de",
  • "customerNumber": "4228",
  • "aliasName": "Mandanten Organisation",
  • "infoText": "Beschreibung eines Beispiel Mandanten",
  • "disableAutoUpdate": false,
  • "disableMessageCenter": false,
  • "disableWeeklyUpdate": false,
  • "disableTaskInfo": false,
  • "disableCompanyEmailLayout": false,
  • "disableMessagesForConsultantUser": false,
  • "useConsultantLayoutForTrainingPage": false,
  • "useConsultantLogoForTrainingCerts": false,
  • "restrictNewUserPermissions": false,
  • "newUserDefaultLevelId": 6,
  • "enableWatermark": false,
  • "users": [
    ]
}

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "ACME Company",
  • "categoryId": 1,
  • "groupId": 1,
  • "rubricId": 1,
  • "email": "test@test.de",
  • "customerNumber": "4228",
  • "aliasName": "Mandanten Organisation",
  • "infoText": "Beschreibung eines Beispiel Mandanten",
  • "disableAutoUpdate": false,
  • "disableMessageCenter": false,
  • "disableWeeklyUpdate": false,
  • "disableTaskInfo": false,
  • "disableCompanyEmailLayout": false,
  • "disableMessagesForConsultantUser": false,
  • "useConsultantLayoutForTrainingPage": false,
  • "useConsultantLogoForTrainingCerts": false,
  • "restrictNewUserPermissions": false,
  • "newUserDefaultLevelId": 6,
  • "enableWatermark": false
}

get one existing client

get one existing client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "ACME Company",
  • "categoryId": 1,
  • "groupId": 1,
  • "rubricId": 1,
  • "email": "test@test.de",
  • "customerNumber": "4228",
  • "aliasName": "Mandanten Organisation",
  • "infoText": "Beschreibung eines Beispiel Mandanten",
  • "disableAutoUpdate": false,
  • "disableMessageCenter": false,
  • "disableWeeklyUpdate": false,
  • "disableTaskInfo": false,
  • "disableCompanyEmailLayout": false,
  • "disableMessagesForConsultantUser": false,
  • "useConsultantLayoutForTrainingPage": false,
  • "useConsultantLogoForTrainingCerts": false,
  • "restrictNewUserPermissions": false,
  • "newUserDefaultLevelId": 6,
  • "enableWatermark": false
}

delete an existing client

delete an existing client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to delete.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Request Body schema: application/json
verify
required
string

The name of the client you want to delete. Has to match the existing name of the given ID.

Responses

Request samples

Content type
application/json
{
  • "verify": "Mandant GmbH"
}

Response samples

Content type
application/json
{
  • "success": true
}

journal

Operations for consultant journals.

get a list of journal entries

get a list of all journal entries for a client. The list can be filtered to only include journals before and after specified dates.

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

journalFrom
string <date>
Example: journalFrom=2020-04-16

Only show journals after this date

journalTo
string <date>
Example: journalTo=2024-04-16

Only show journals before this date

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a journal entry

creates a journal entry for a client. If the userId isn't given the api user is used.

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Request Body schema: application/json
userId
integer
date
string
desc
string
note
string
additionalText
string
duration
integer

time taken in minutes

showInReport
boolean

Responses

Request samples

Content type
application/json
{
  • "userId": 2,
  • "date": "2024-03-07T00:00:00+01:00",
  • "desc": "Beschreibung des Eintrags",
  • "note": "Notiz zum Eintrag",
  • "additionalText": "Ergänzende Informationen",
  • "duration": 30,
  • "showInReport": true
}

Response samples

Content type
application/json
{
  • "userId": 2,
  • "date": "2024-03-07T00:00:00+01:00",
  • "desc": "Beschreibung des Eintrags",
  • "note": "Notiz zum Eintrag",
  • "additionalText": "Ergänzende Informationen",
  • "duration": 30,
  • "showInReport": true,
  • "journalId": 68,
  • "clientId": 216,
  • "created": "2024-04-22T14:20:56+02:00",
  • "lastChange": "2024-04-22T14:20:56+02:00"
}

get one journal entry

get one journal entry for a client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client

journalId
required
integer <int64> >= 1

The ID of the journal entry

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
{
  • "userId": 2,
  • "date": "2024-03-07T00:00:00+01:00",
  • "desc": "Beschreibung des Eintrags",
  • "note": "Notiz zum Eintrag",
  • "additionalText": "Ergänzende Informationen",
  • "duration": 30,
  • "showInReport": true,
  • "journalId": 68,
  • "clientId": 216,
  • "created": "2024-04-22T14:20:56+02:00",
  • "lastChange": "2024-04-22T14:20:56+02:00"
}

update a journal entry

update a journal entry. If the userId isn't given the api user is used.

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client

journalId
required
integer <int64> >= 1

The ID of the journal entry

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Request Body schema: application/json
userId
integer
date
string
desc
string
note
string
additionalText
string
duration
integer

time taken in minutes

showInReport
boolean

Responses

Request samples

Content type
application/json
{
  • "userId": 2,
  • "date": "2024-03-07T00:00:00+01:00",
  • "desc": "Beschreibung des Eintrags",
  • "note": "Notiz zum Eintrag",
  • "additionalText": "Ergänzende Informationen",
  • "duration": 30,
  • "showInReport": true
}

Response samples

Content type
application/json
{
  • "userId": 2,
  • "date": "2024-03-07T00:00:00+01:00",
  • "desc": "Beschreibung des Eintrags",
  • "note": "Notiz zum Eintrag",
  • "additionalText": "Ergänzende Informationen",
  • "duration": 30,
  • "showInReport": true,
  • "journalId": 68,
  • "clientId": 216,
  • "created": "2024-04-22T14:20:56+02:00",
  • "lastChange": "2024-04-22T14:20:56+02:00"
}

delete a journal entry

delete a journal entry

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client

journalId
required
integer <int64> >= 1

The ID of the journal entry

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

toa

Operations for consultants to handle TOAs.

get a list of TOA categories

get a list of TOA categories

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a list of default TOAs

get a list of default TOAs

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new default TOA

creates new default TOA

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Request Body schema: application/json
categoryId
required
integer

must be defined in the system, can be found in GET /toa/categories

name
required
string
desc
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": 2,
  • "name": "Notfallkonzept",
  • "desc": "Notfallkonzept"
}

Response samples

Content type
application/json
{
  • "toaId": 1,
  • "categoryId": 2,
  • "name": "Notfallkonzept",
  • "desc": "Notfallkonzept"
}

get a default TOA

get a default TOA

Authorizations:
bearerAuth
path Parameters
toaId
required
integer <int64> >= 1

The ID of the default TOA

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update a default TOA

update a default TOA

Authorizations:
bearerAuth
path Parameters
toaId
required
integer <int64> >= 1

The ID of the default TOA

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Request Body schema: application/json
categoryId
required
integer

must be defined in the system, can be found in GET /toa/categories

name
required
string
desc
string

Responses

Request samples

Content type
application/json
{
  • "categoryId": 2,
  • "name": "Notfallkonzept",
  • "desc": "Notfallkonzept"
}

Response samples

Content type
application/json
{
  • "toaId": 1,
  • "categoryId": 2,
  • "name": "Notfallkonzept",
  • "desc": "Notfallkonzept"
}

delete a default TOA

delete a default TOA

Authorizations:
bearerAuth
path Parameters
toaId
required
integer <int64> >= 1

The ID of the default TOA

query Parameters
companyId
required
integer <int64> >= 1

The ID of the consultant company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

get a list of company TOAs

get a list of company TOAs

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a company TOA

get a company TOA

Authorizations:
bearerAuth
path Parameters
toaId
required
integer <int64> >= 1

The ID of the default TOA

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "toaId": 1,
  • "companyId": 2,
  • "status": "active",
  • "name": "Notfallkonzept",
  • "description": "Notfallkonzept",
  • "remark": "Notfallkonzept"
}

update a company TOA

update a company TOA

Authorizations:
bearerAuth
path Parameters
toaId
required
integer <int64> >= 1

The ID of the default TOA

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
status
required
string
Enum: "active" "draft" "inactive"
name
string

if emtpy the name value of the default TOA will be used

description
string

if emtpy the desc value of the default TOA will be used

remark
string

Responses

Request samples

Content type
application/json
{
  • "status": "active",
  • "name": "Notfallkonzept",
  • "description": "Notfallkonzept",
  • "remark": "Notfallkonzept"
}

Response samples

Content type
application/json
{
  • "toaId": 1,
  • "companyId": 2,
  • "status": "active",
  • "name": "Notfallkonzept",
  • "description": "Notfallkonzept",
  • "remark": "Notfallkonzept"
}

client

Operations to handle clients.

get list of clients for the company

get list of clients for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new client

creates new client

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
name
required
string
clientStatus
string

must be definied in the system, can be found in GET /client/defaults

desc
string
country
string
address
string
email
string
homepage
string
reference
string
phone
string
fax
string
orderProcessingContractSigned
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true
}

Response samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true,
  • "clientId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "indexes": [
    ],
  • "contracts": [
    ]
}

get list of client defaults

get list of client defaults for status

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
{
  • "types": [
    ],
  • "status": [
    ],
  • "affectedGroups": [
    ]
}

get client for the given id

get client for the given id

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true,
  • "clientId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "indexes": [
    ],
  • "contracts": [
    ]
}

updates client

updates new client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
name
required
string
clientStatus
string

must be definied in the system, can be found in GET /client/defaults

desc
string
country
string
address
string
email
string
homepage
string
reference
string
phone
string
fax
string
orderProcessingContractSigned
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true
}

Response samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true,
  • "clientId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "indexes": [
    ],
  • "contracts": [
    ]
}

deletes client

deletes client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

adds index to client

adds index to client.

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
indexId
required
integer

Has to exist as an index for the company. Find indexes via GET /index

Responses

Request samples

Content type
application/json
{
  • "indexId": 9830
}

Response samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true,
  • "clientId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "indexes": [
    ],
  • "contracts": [
    ]
}

removes index from client

removes index from client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client to return.

indexId
required
integer <int64> >= 1

The ID of the index

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

creates new contract for client

creates new contract for client

Authorizations:
bearerAuth
path Parameters
clientId
required
integer <int64> >= 1

The ID of the client

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
templateId
required
integer
title
required
string
validUntil
required
string
isOrderProcessingContract
boolean
Default: false

Nach Abschluss wird Auftragsverarbeitungsvertrag abgeschlossen (Client -> orderProcessingContractSigned) automatisch auf Ja gesetzt.

Responses

Request samples

Content type
application/json
{
  • "templateId": 1,
  • "title": "Auftragsverarbeitungsvertrag",
  • "validUntil": "2021-03-13T12:26:40+01:00",
  • "isOrderProcessingContract": true
}

Response samples

Content type
application/json
{
  • "name": "Kunde XYZ",
  • "clientStatus": "Aktiv",
  • "desc": "Beschreibung des Kundens",
  • "country": "DE",
  • "address": "Testraße 1337\n47608 Geldern\n",
  • "email": "test@example.com",
  • "homepage": "https://www.example.com",
  • "reference": "C.05",
  • "phone": 123456789,
  • "fax": 123456789,
  • "orderProcessingContractSigned": true,
  • "clientId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "indexes": [
    ],
  • "contracts": [
    ]
}

company

Operations to handle companies.

get list of available organisationTypes

get list of available organisationTypes

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of available companies

get list of available companies for the current user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get company object

get company object

Authorizations:
bearerAuth
path Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "ACME Company",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "organisationType": {
    },
  • "phone": 49123456,
  • "fax": 49123456,
  • "email": "test@test.de",
  • "imprintLink": "https://www.test.de/imprint",
  • "isConsultant": 1,
  • "responsiblePersonName": "Peter Mustermann",
  • "responsiblePersonFunktion": "CEO",
  • "responsiblePersonPhone": 49123456,
  • "responsiblePersonEmail": "test@test.de",
  • "dprotectionOfficerCompany": "DP Company",
  • "dprotectionOfficerName": "DP Officer Name",
  • "dprotectionOfficerFunktion": "DP Officer",
  • "dprotectionOfficerAddress": "Teststraße 1337\n47608 Geldern\n",
  • "dprotectionOfficerPhone": "+49123456 47608 Geldern",
  • "dprotectionOfficerEmail": "test@test.de",
  • "users": [
    ],
  • "homepage": "https://www.test.de/"
}

update company

update a company

Authorizations:
bearerAuth
path Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
name
required
string
address
string
country
string
object (OrganisationTypeItem)
phone
string
fax
string
email
string
imprintLink
string
isConsultant
integer

company is a consulant and can use the /consultant edges

responsiblePersonName
string
responsiblePersonFunktion
string
responsiblePersonPhone
string
responsiblePersonEmail
string
dprotectionOfficerCompany
string
dprotectionOfficerName
string
dprotectionOfficerFunktion
string
dprotectionOfficerAddress
string
dprotectionOfficerPhone
string
dprotectionOfficerEmail
string

Responses

Request samples

Content type
application/json
{
  • "name": "ACME Company",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "organisationType": {
    },
  • "phone": 49123456,
  • "fax": 49123456,
  • "email": "test@test.de",
  • "imprintLink": "https://www.test.de/imprint",
  • "isConsultant": 1,
  • "responsiblePersonName": "Peter Mustermann",
  • "responsiblePersonFunktion": "CEO",
  • "responsiblePersonPhone": 49123456,
  • "responsiblePersonEmail": "test@test.de",
  • "dprotectionOfficerCompany": "DP Company",
  • "dprotectionOfficerName": "DP Officer Name",
  • "dprotectionOfficerFunktion": "DP Officer",
  • "dprotectionOfficerAddress": "Teststraße 1337\n47608 Geldern\n",
  • "dprotectionOfficerPhone": "+49123456 47608 Geldern",
  • "dprotectionOfficerEmail": "test@test.de"
}

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "ACME Company",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "organisationType": {
    },
  • "phone": 49123456,
  • "fax": 49123456,
  • "email": "test@test.de",
  • "imprintLink": "https://www.test.de/imprint",
  • "isConsultant": 1,
  • "responsiblePersonName": "Peter Mustermann",
  • "responsiblePersonFunktion": "CEO",
  • "responsiblePersonPhone": 49123456,
  • "responsiblePersonEmail": "test@test.de",
  • "dprotectionOfficerCompany": "DP Company",
  • "dprotectionOfficerName": "DP Officer Name",
  • "dprotectionOfficerFunktion": "DP Officer",
  • "dprotectionOfficerAddress": "Teststraße 1337\n47608 Geldern\n",
  • "dprotectionOfficerPhone": "+49123456 47608 Geldern",
  • "dprotectionOfficerEmail": "test@test.de",
  • "users": [
    ],
  • "homepage": "https://www.test.de/"
}

partially update company

updates the specified properties of a company

Authorizations:
bearerAuth
path Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
name
string
address
string
country
string
object (OrganisationTypeItem)
phone
string
fax
string
email
string
imprintLink
string
isConsultant
integer

company is a consulant and can use the /consultant edges

responsiblePersonName
string
responsiblePersonFunktion
string
responsiblePersonPhone
string
responsiblePersonEmail
string
dprotectionOfficerCompany
string
dprotectionOfficerName
string
dprotectionOfficerFunktion
string
dprotectionOfficerAddress
string
dprotectionOfficerPhone
string
dprotectionOfficerEmail
string

Responses

Request samples

Content type
application/json
{
  • "name": "ACME Company",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "organisationType": {
    },
  • "phone": 49123456,
  • "fax": 49123456,
  • "email": "test@test.de",
  • "imprintLink": "https://www.test.de/imprint",
  • "isConsultant": 1,
  • "responsiblePersonName": "Peter Mustermann",
  • "responsiblePersonFunktion": "CEO",
  • "responsiblePersonPhone": 49123456,
  • "responsiblePersonEmail": "test@test.de",
  • "dprotectionOfficerCompany": "DP Company",
  • "dprotectionOfficerName": "DP Officer Name",
  • "dprotectionOfficerFunktion": "DP Officer",
  • "dprotectionOfficerAddress": "Teststraße 1337\n47608 Geldern\n",
  • "dprotectionOfficerPhone": "+49123456 47608 Geldern",
  • "dprotectionOfficerEmail": "test@test.de"
}

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "ACME Company",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "organisationType": {
    },
  • "phone": 49123456,
  • "fax": 49123456,
  • "email": "test@test.de",
  • "imprintLink": "https://www.test.de/imprint",
  • "isConsultant": 1,
  • "responsiblePersonName": "Peter Mustermann",
  • "responsiblePersonFunktion": "CEO",
  • "responsiblePersonPhone": 49123456,
  • "responsiblePersonEmail": "test@test.de",
  • "dprotectionOfficerCompany": "DP Company",
  • "dprotectionOfficerName": "DP Officer Name",
  • "dprotectionOfficerFunktion": "DP Officer",
  • "dprotectionOfficerAddress": "Teststraße 1337\n47608 Geldern\n",
  • "dprotectionOfficerPhone": "+49123456 47608 Geldern",
  • "dprotectionOfficerEmail": "test@test.de",
  • "users": [
    ],
  • "homepage": "https://www.test.de/"
}

add user to company

adds a user to the company. Creates the user if it is new

Authorizations:
bearerAuth
Request Body schema: application/json
useSso
boolean
username
required
string
level
required
string
levelId
integer

levelId of the CUSTOM level, optional, only for level = CUSTOM

Responses

Request samples

Content type
application/json
{
  • "useSso": true,
  • "username": "api@example.com",
  • "level": "ADMIN",
  • "levelId": 1
}

Response samples

Content type
application/json
{
  • "companyId": 1,
  • "name": "ACME Company",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "organisationType": {
    },
  • "phone": 49123456,
  • "fax": 49123456,
  • "email": "test@test.de",
  • "imprintLink": "https://www.test.de/imprint",
  • "isConsultant": 1,
  • "responsiblePersonName": "Peter Mustermann",
  • "responsiblePersonFunktion": "CEO",
  • "responsiblePersonPhone": 49123456,
  • "responsiblePersonEmail": "test@test.de",
  • "dprotectionOfficerCompany": "DP Company",
  • "dprotectionOfficerName": "DP Officer Name",
  • "dprotectionOfficerFunktion": "DP Officer",
  • "dprotectionOfficerAddress": "Teststraße 1337\n47608 Geldern\n",
  • "dprotectionOfficerPhone": "+49123456 47608 Geldern",
  • "dprotectionOfficerEmail": "test@test.de",
  • "users": [
    ],
  • "homepage": "https://www.test.de/"
}

set external samlIdent

set external samlIdent for the company

Authorizations:
bearerAuth
Request Body schema: application/json
externalSamlIdent
string

Responses

Request samples

Content type
application/json
{
  • "externalSamlIdent": "5242d2b4edfab"
}

Response samples

Content type
application/json
{
  • "success": true
}

homepage

Operations to handle homepages.

get list of homepages for the company

get list of homepages for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new homepage

creates new homepage

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
hostname
required
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "homepageId": 1,
  • "hostname": "https://www.acme.com",
  • "maxPages": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "crawljob": {
    }
}

get homepage for the given id

get homepage for the given id

Authorizations:
bearerAuth
path Parameters
homepageId
required
integer <int64> >= 1

The ID of the homepage to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "homepageId": 1,
  • "hostname": "https://www.acme.com",
  • "maxPages": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "crawljob": {
    }
}

deletes homepage

deletes homepage

Authorizations:
bearerAuth
path Parameters
homepageId
required
integer <int64> >= 1

The ID of the homepage to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

updates the crawljob

updates the crawljob

Authorizations:
bearerAuth
path Parameters
homepageId
required
integer <int64> >= 1

The ID of the homepage to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
reportReceiver
required
string
reschedulePeriod
required
integer

Interval at which the scan is repeated in months

Responses

Request samples

Content type
application/json
{
  • "reportReceiver": "peter@mustermann.de",
  • "reschedulePeriod": 1
}

Response samples

Content type
application/json
{
  • "homepageId": 1,
  • "hostname": "https://www.acme.com",
  • "maxPages": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "crawljob": {
    }
}

index

Operations to handle indexes.

get list of index defaults

get list of index defaults

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

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

creates new default entry

creates new default entry

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
group
required
string
Enum: "dataCategories" "specialDataCategories" "deletePeriods" "retentionLegalBasis" "dataSubjects" "sources" "types" "indexStatus" "goals" "legalBasis" "receiverIntern" "responsibleReceiverIntern" "responsibleDeletetionDeparment" "deletionControl" "deletionType" "deletionProtocol" "receiverExternal" "impactAssessmentNeeded"
text
required
string
subtext
string

Responses

Request samples

Content type
application/json
{
  • "group": "dataCategories",
  • "text": "example",
  • "subtext": "(ex, ample)"
}

Response samples

Content type
application/json
{
  • "example1": "example1",
  • "example2": {
    }
}

get list of index for the company

get list of indexes for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new index

creates new index

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Web-Hosting"
}

Response samples

Content type
application/json
{
  • "deletionDataCategories": {
    },
  • "deletePeriod": {
    },
  • "retentionLegalBasis": {
    },
  • "deletionInformation": "string",
  • "deletionControl": {
    },
  • "deletionType": {
    },
  • "deletionProtocol": {
    },
  • "responsibleDeletetionDeparment": {
    },
  • "deletionTOM": "string",
  • "deletionSoftwareIds": [
    ],
  • "name": "Web-Hosting",
  • "desc": "Web-Hosting",
  • "type": {
    },
  • "indexStatus": {
    },
  • "dataCategories": {
    },
  • "specialDataCategories": {
    },
  • "dataSubjects": {
    },
  • "source": {
    },
  • "goal": {
    },
  • "goalDesc": "Ausstellung einer schriftlichen Abmahnung zur Zurechtweisung der Mitarbeiter.",
  • "systemDesc": "Abmahnung wird schriftlich in Word geschrieben und im Personalorder in Microsoft OneDrive abgespeichert.",
  • "legalBasis": {
    },
  • "legalInfo": "string",
  • "legitimateInterests": "string",
  • "consequencesForNotProviding": "string",
  • "receiverIntern": {
    },
  • "responsibleReceiverIntern": {
    },
  • "receiverExternal": {
    },
  • "impactAssessmentNeeded": true,
  • "impactAssessmentNeededText": "string",
  • "extraSecurity": "string",
  • "informedAffected": "string",
  • "isProfiling": true,
  • "profilingInformation": "string",
  • "isOrderProcessing": true,
  • "isJointControllership": true,
  • "subcontractors": [
    ],
  • "softwares": [
    ],
  • "devices": [
    ],
  • "additionalDeletions": [
    ],
  • "indexId": 1,
  • "group": "IT-Infrastruktur",
  • "created": "2024-04-10T10:58:00+02:00",
  • "lastChange": "2024-04-10T10:58:00+02:00"
}

get index for the given id

get index for the given id

Authorizations:
bearerAuth
path Parameters
indexId
required
integer <int64> >= 1

The ID of the index to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "deletionDataCategories": {
    },
  • "deletePeriod": {
    },
  • "retentionLegalBasis": {
    },
  • "deletionInformation": "string",
  • "deletionControl": {
    },
  • "deletionType": {
    },
  • "deletionProtocol": {
    },
  • "responsibleDeletetionDeparment": {
    },
  • "deletionTOM": "string",
  • "deletionSoftwareIds": [
    ],
  • "name": "Web-Hosting",
  • "desc": "Web-Hosting",
  • "type": {
    },
  • "indexStatus": {
    },
  • "dataCategories": {
    },
  • "specialDataCategories": {
    },
  • "dataSubjects": {
    },
  • "source": {
    },
  • "goal": {
    },
  • "goalDesc": "Ausstellung einer schriftlichen Abmahnung zur Zurechtweisung der Mitarbeiter.",
  • "systemDesc": "Abmahnung wird schriftlich in Word geschrieben und im Personalorder in Microsoft OneDrive abgespeichert.",
  • "legalBasis": {
    },
  • "legalInfo": "string",
  • "legitimateInterests": "string",
  • "consequencesForNotProviding": "string",
  • "receiverIntern": {
    },
  • "responsibleReceiverIntern": {
    },
  • "receiverExternal": {
    },
  • "impactAssessmentNeeded": true,
  • "impactAssessmentNeededText": "string",
  • "extraSecurity": "string",
  • "informedAffected": "string",
  • "isProfiling": true,
  • "profilingInformation": "string",
  • "isOrderProcessing": true,
  • "isJointControllership": true,
  • "subcontractors": [
    ],
  • "softwares": [
    ],
  • "devices": [
    ],
  • "additionalDeletions": [
    ],
  • "indexId": 1,
  • "group": "IT-Infrastruktur",
  • "created": "2024-04-10T10:58:00+02:00",
  • "lastChange": "2024-04-10T10:58:00+02:00"
}

updates index

updates index

Authorizations:
bearerAuth
path Parameters
indexId
required
integer <int64> >= 1

The ID of the index to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

deletionInformation
string
object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

deletionTOM
string
deletionSoftwareIds
Array of integers
name
required
string
desc
string
object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItem)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

goalDesc
string
systemDesc
string
object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

legalInfo
string
legitimateInterests
string
consequencesForNotProviding
string
object (IndexSimpleDefaultsItem)

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemMaxOne) <= 1 properties

Has to exist as default in the corresponding category.

object (IndexSimpleDefaultsItemWithOther)

Has to exist as default in the corresponding category.

impactAssessmentNeeded
boolean

null if unknown

impactAssessmentNeededText
string
extraSecurity
string
informedAffected
string
isProfiling
boolean
profilingInformation
string
isOrderProcessing
boolean
isJointControllership
boolean
Array of objects (IndexSubcontractorItem)
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "deletionDataCategories": {
    },
  • "deletePeriod": {
    },
  • "retentionLegalBasis": {
    },
  • "deletionInformation": "string",
  • "deletionControl": {
    },
  • "deletionType": {
    },
  • "deletionProtocol": {
    },
  • "responsibleDeletetionDeparment": {
    },
  • "deletionTOM": "string",
  • "deletionSoftwareIds": [
    ],
  • "name": "Web-Hosting",
  • "desc": "Web-Hosting",
  • "type": {
    },
  • "indexStatus": {
    },
  • "dataCategories": {
    },
  • "specialDataCategories": {
    },
  • "dataSubjects": {
    },
  • "source": {
    },
  • "goal": {
    },
  • "goalDesc": "Ausstellung einer schriftlichen Abmahnung zur Zurechtweisung der Mitarbeiter.",
  • "systemDesc": "Abmahnung wird schriftlich in Word geschrieben und im Personalorder in Microsoft OneDrive abgespeichert.",
  • "legalBasis": {
    },
  • "legalInfo": "string",
  • "legitimateInterests": "string",
  • "consequencesForNotProviding": "string",
  • "receiverIntern": {
    },
  • "responsibleReceiverIntern": {
    },
  • "receiverExternal": {
    },
  • "impactAssessmentNeeded": true,
  • "impactAssessmentNeededText": "string",
  • "extraSecurity": "string",
  • "informedAffected": "string",
  • "isProfiling": true,
  • "profilingInformation": "string",
  • "isOrderProcessing": true,
  • "isJointControllership": true,
  • "subcontractors": [
    ],
  • "softwares": [
    ],
  • "devices": [
    ],
  • "additionalDeletions": [
    ]
}

Response samples

Content type
application/json
{
  • "deletionDataCategories": {
    },
  • "deletePeriod": {
    },
  • "retentionLegalBasis": {
    },
  • "deletionInformation": "string",
  • "deletionControl": {
    },
  • "deletionType": {
    },
  • "deletionProtocol": {
    },
  • "responsibleDeletetionDeparment": {
    },
  • "deletionTOM": "string",
  • "deletionSoftwareIds": [
    ],
  • "name": "Web-Hosting",
  • "desc": "Web-Hosting",
  • "type": {
    },
  • "indexStatus": {
    },
  • "dataCategories": {
    },
  • "specialDataCategories": {
    },
  • "dataSubjects": {
    },
  • "source": {
    },
  • "goal": {
    },
  • "goalDesc": "Ausstellung einer schriftlichen Abmahnung zur Zurechtweisung der Mitarbeiter.",
  • "systemDesc": "Abmahnung wird schriftlich in Word geschrieben und im Personalorder in Microsoft OneDrive abgespeichert.",
  • "legalBasis": {
    },
  • "legalInfo": "string",
  • "legitimateInterests": "string",
  • "consequencesForNotProviding": "string",
  • "receiverIntern": {
    },
  • "responsibleReceiverIntern": {
    },
  • "receiverExternal": {
    },
  • "impactAssessmentNeeded": true,
  • "impactAssessmentNeededText": "string",
  • "extraSecurity": "string",
  • "informedAffected": "string",
  • "isProfiling": true,
  • "profilingInformation": "string",
  • "isOrderProcessing": true,
  • "isJointControllership": true,
  • "subcontractors": [
    ],
  • "softwares": [
    ],
  • "devices": [
    ],
  • "additionalDeletions": [
    ],
  • "indexId": 1,
  • "group": "IT-Infrastruktur",
  • "created": "2024-04-10T10:58:00+02:00",
  • "lastChange": "2024-04-10T10:58:00+02:00"
}

deletes index

deletes index

Authorizations:
bearerAuth
path Parameters
indexId
required
integer <int64> >= 1

The ID of the index to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

copy an existing index

creates a new index that is a copy of an existing index

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company for which you want to create a new index

Request Body schema: application/json
indexId
required
integer

indexId of the index you want to copy

Responses

Request samples

Content type
application/json
{
  • "indexId": 9830
}

Response samples

Content type
application/json
{
  • "deletionDataCategories": {
    },
  • "deletePeriod": {
    },
  • "retentionLegalBasis": {
    },
  • "deletionInformation": "string",
  • "deletionControl": {
    },
  • "deletionType": {
    },
  • "deletionProtocol": {
    },
  • "responsibleDeletetionDeparment": {
    },
  • "deletionTOM": "string",
  • "deletionSoftwareIds": [
    ],
  • "name": "Web-Hosting",
  • "desc": "Web-Hosting",
  • "type": {
    },
  • "indexStatus": {
    },
  • "dataCategories": {
    },
  • "specialDataCategories": {
    },
  • "dataSubjects": {
    },
  • "source": {
    },
  • "goal": {
    },
  • "goalDesc": "Ausstellung einer schriftlichen Abmahnung zur Zurechtweisung der Mitarbeiter.",
  • "systemDesc": "Abmahnung wird schriftlich in Word geschrieben und im Personalorder in Microsoft OneDrive abgespeichert.",
  • "legalBasis": {
    },
  • "legalInfo": "string",
  • "legitimateInterests": "string",
  • "consequencesForNotProviding": "string",
  • "receiverIntern": {
    },
  • "responsibleReceiverIntern": {
    },
  • "receiverExternal": {
    },
  • "impactAssessmentNeeded": true,
  • "impactAssessmentNeededText": "string",
  • "extraSecurity": "string",
  • "informedAffected": "string",
  • "isProfiling": true,
  • "profilingInformation": "string",
  • "isOrderProcessing": true,
  • "isJointControllership": true,
  • "subcontractors": [
    ],
  • "softwares": [
    ],
  • "devices": [
    ],
  • "additionalDeletions": [
    ],
  • "indexId": 1,
  • "group": "IT-Infrastruktur",
  • "created": "2024-04-10T10:58:00+02:00",
  • "lastChange": "2024-04-10T10:58:00+02:00"
}

inquiry

Operations to handle inquiries.

get list of inquiries for the company

get list of inquiries for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new inquiry

creates new inquiry

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
status
string

must be definied in the system, can be found in GET /inquiry/defaults

name
string
email
string

musst be valid email

description
string
incomingText
string
identityValidated
boolean
identityValidatedDescription
string
Array of objects (DefaultsItem)

must be definied in the system, can be found in GET /inquiry/defaults

Array of objects (DefaultsItem)

must be definied in the system, can be found in GET /inquiry/defaults

incomingDate
string
closedDate
string

Responses

Request samples

Content type
application/json
{
  • "status": "new",
  • "name": "Peter Mustermann",
  • "email": "peter@mustermann.de",
  • "description": "information text",
  • "incomingText": "information text",
  • "identityValidated": true,
  • "identityValidatedDescription": "information text",
  • "affectedGroups": [
    ],
  • "types": [
    ],
  • "incomingDate": "2021-03-13T12:26:40+01:00",
  • "closedDate": "2021-03-13T12:26:40+01:00"
}

Response samples

Content type
application/json
{
  • "inquiryId": 1,
  • "inquiryIdent": "6231f57474f3a",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "status": "new",
  • "name": "Peter Mustermann",
  • "email": "peter@mustermann.de",
  • "description": "information text",
  • "incomingText": "information text",
  • "identityValidated": true,
  • "identityValidatedDescription": "information text",
  • "affectedGroups": [
    ],
  • "types": [
    ],
  • "incomingDate": "2021-03-13T12:26:40+01:00",
  • "closedDate": "2021-03-13T12:26:40+01:00"
}

get list of inquiry defaults

get list of inquiry defaults for types, status and affectedGroups

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
{
  • "types": [
    ],
  • "status": [
    ],
  • "affectedGroups": [
    ]
}

get inquiry for the given id

get inquiry for the given id

Authorizations:
bearerAuth
path Parameters
inquiryId
required
integer <int64> >= 1

The ID of the inquiry to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "inquiryId": 1,
  • "inquiryIdent": "6231f57474f3a",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "status": "new",
  • "name": "Peter Mustermann",
  • "email": "peter@mustermann.de",
  • "description": "information text",
  • "incomingText": "information text",
  • "identityValidated": true,
  • "identityValidatedDescription": "information text",
  • "affectedGroups": [
    ],
  • "types": [
    ],
  • "incomingDate": "2021-03-13T12:26:40+01:00",
  • "closedDate": "2021-03-13T12:26:40+01:00"
}

updates inquiry

updates inquiry

Authorizations:
bearerAuth
path Parameters
inquiryId
required
integer <int64> >= 1

The ID of the inquiry to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
status
string

must be definied in the system, can be found in GET /inquiry/defaults

name
string
email
string

musst be valid email

description
string
incomingText
string
identityValidated
boolean
identityValidatedDescription
string
Array of objects (DefaultsItem)

must be definied in the system, can be found in GET /inquiry/defaults

Array of objects (DefaultsItem)

must be definied in the system, can be found in GET /inquiry/defaults

incomingDate
string
closedDate
string

Responses

Request samples

Content type
application/json
{
  • "status": "new",
  • "name": "Peter Mustermann",
  • "email": "peter@mustermann.de",
  • "description": "information text",
  • "incomingText": "information text",
  • "identityValidated": true,
  • "identityValidatedDescription": "information text",
  • "affectedGroups": [
    ],
  • "types": [
    ],
  • "incomingDate": "2021-03-13T12:26:40+01:00",
  • "closedDate": "2021-03-13T12:26:40+01:00"
}

Response samples

Content type
application/json
{
  • "inquiryId": 1,
  • "inquiryIdent": "6231f57474f3a",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "status": "new",
  • "name": "Peter Mustermann",
  • "email": "peter@mustermann.de",
  • "description": "information text",
  • "incomingText": "information text",
  • "identityValidated": true,
  • "identityValidatedDescription": "information text",
  • "affectedGroups": [
    ],
  • "types": [
    ],
  • "incomingDate": "2021-03-13T12:26:40+01:00",
  • "closedDate": "2021-03-13T12:26:40+01:00"
}

deletes inquiry

deletes inquiry

Authorizations:
bearerAuth
path Parameters
inquiryId
required
integer <int64> >= 1

The ID of the inquiry to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

subcontractor

Operations to handle subcontractors.

get list of subcontractors for the company

get list of subcontractores for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new subcontractor

creates new subcontractor

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
reference
string
name
required
string
desc
string
description
string
subcontractorStatus
string

must be defined in the system, can be found in GET /subcontractor/defaults

address
string
country
string

must be defined in the system, can be found in GET /countries

status
string
contractBasis
string
email
string

musst be valid email

homepage
string
phone
string
fax
string
isProcessor
boolean
isJointController
boolean
hasDPA
boolean
hasJCA
boolean
dpaInformation
string
dpaVerifiedDate
string
dpaVerifiedName
string
dpaApprovedDate
string
dpaApprovedName
string
jcaInformation
string
jcaVerifiedDate
string
jcaVerifiedName
string
jcaApprovedDate
string
jcaApprovedName
string

Responses

Request samples

Content type
application/json
{
  • "reference": "A.01",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "description": "internal description",
  • "subcontractorStatus": "Aktiv",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "status": "Explanation of Legality",
  • "contractBasis": "basis of the contract",
  • "email": "test@test.de",
  • "homepage": "https://www.test.de/",
  • "phone": 49123456,
  • "fax": 49123456,
  • "isProcessor": false,
  • "isJointController": false,
  • "hasDPA": false,
  • "hasJCA": false,
  • "dpaInformation": "information text",
  • "dpaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "dpaVerifiedName": "Muster GmbH",
  • "dpaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "dpaApprovedName": "Muster GmbH",
  • "jcaInformation": "information text",
  • "jcaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "jcaVerifiedName": "Muster GmbH",
  • "jcaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "jcaApprovedName": "Muster GmbH"
}

Response samples

Content type
application/json
{
  • "subcontractorId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A.01",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "description": "internal description",
  • "subcontractorStatus": "Aktiv",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "status": "Explanation of Legality",
  • "contractBasis": "basis of the contract",
  • "email": "test@test.de",
  • "homepage": "https://www.test.de/",
  • "phone": 49123456,
  • "fax": 49123456,
  • "isProcessor": false,
  • "isJointController": false,
  • "hasDPA": false,
  • "hasJCA": false,
  • "dpaInformation": "information text",
  • "dpaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "dpaVerifiedName": "Muster GmbH",
  • "dpaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "dpaApprovedName": "Muster GmbH",
  • "jcaInformation": "information text",
  • "jcaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "jcaVerifiedName": "Muster GmbH",
  • "jcaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "jcaApprovedName": "Muster GmbH"
}

get list of subcontractor defaults

get list of subcontractor defaults for subcontractorStatus

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
{
  • "subcontractorStatus": [
    ]
}

get subcontractor for the given id

get subcontractor for the given id

Authorizations:
bearerAuth
path Parameters
subcontractorId
required
integer <int64> >= 1

The ID of the subcontractor to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "subcontractorId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A.01",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "description": "internal description",
  • "subcontractorStatus": "Aktiv",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "status": "Explanation of Legality",
  • "contractBasis": "basis of the contract",
  • "email": "test@test.de",
  • "homepage": "https://www.test.de/",
  • "phone": 49123456,
  • "fax": 49123456,
  • "isProcessor": false,
  • "isJointController": false,
  • "hasDPA": false,
  • "hasJCA": false,
  • "dpaInformation": "information text",
  • "dpaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "dpaVerifiedName": "Muster GmbH",
  • "dpaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "dpaApprovedName": "Muster GmbH",
  • "jcaInformation": "information text",
  • "jcaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "jcaVerifiedName": "Muster GmbH",
  • "jcaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "jcaApprovedName": "Muster GmbH"
}

updates subcontractor

updates subcontractor

Authorizations:
bearerAuth
path Parameters
subcontractorId
required
integer <int64> >= 1

The ID of the subcontractor to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
reference
string
name
required
string
desc
string
description
string
subcontractorStatus
string

must be defined in the system, can be found in GET /subcontractor/defaults

address
string
country
string

must be defined in the system, can be found in GET /countries

status
string
contractBasis
string
email
string

musst be valid email

homepage
string
phone
string
fax
string
isProcessor
boolean
isJointController
boolean
hasDPA
boolean
hasJCA
boolean
dpaInformation
string
dpaVerifiedDate
string
dpaVerifiedName
string
dpaApprovedDate
string
dpaApprovedName
string
jcaInformation
string
jcaVerifiedDate
string
jcaVerifiedName
string
jcaApprovedDate
string
jcaApprovedName
string

Responses

Request samples

Content type
application/json
{
  • "reference": "A.01",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "description": "internal description",
  • "subcontractorStatus": "Aktiv",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "status": "Explanation of Legality",
  • "contractBasis": "basis of the contract",
  • "email": "test@test.de",
  • "homepage": "https://www.test.de/",
  • "phone": 49123456,
  • "fax": 49123456,
  • "isProcessor": false,
  • "isJointController": false,
  • "hasDPA": false,
  • "hasJCA": false,
  • "dpaInformation": "information text",
  • "dpaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "dpaVerifiedName": "Muster GmbH",
  • "dpaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "dpaApprovedName": "Muster GmbH",
  • "jcaInformation": "information text",
  • "jcaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "jcaVerifiedName": "Muster GmbH",
  • "jcaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "jcaApprovedName": "Muster GmbH"
}

Response samples

Content type
application/json
{
  • "subcontractorId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A.01",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "description": "internal description",
  • "subcontractorStatus": "Aktiv",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "status": "Explanation of Legality",
  • "contractBasis": "basis of the contract",
  • "email": "test@test.de",
  • "homepage": "https://www.test.de/",
  • "phone": 49123456,
  • "fax": 49123456,
  • "isProcessor": false,
  • "isJointController": false,
  • "hasDPA": false,
  • "hasJCA": false,
  • "dpaInformation": "information text",
  • "dpaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "dpaVerifiedName": "Muster GmbH",
  • "dpaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "dpaApprovedName": "Muster GmbH",
  • "jcaInformation": "information text",
  • "jcaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "jcaVerifiedName": "Muster GmbH",
  • "jcaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "jcaApprovedName": "Muster GmbH"
}

deletes subcontractor

deletes subcontractor

Authorizations:
bearerAuth
path Parameters
subcontractorId
required
integer <int64> >= 1

The ID of the subcontractor to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

copy an existing subcontractor

creates a new subcontractor that is a copy of an existing subcontractor

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company for which you want to create a new subcontractor

Request Body schema: application/json
subcontractorId
required
integer

subcontractorId of the subcontractor you want to copy

Responses

Request samples

Content type
application/json
{
  • "subcontractorId": 9830
}

Response samples

Content type
application/json
{
  • "subcontractorId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A.01",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "description": "internal description",
  • "subcontractorStatus": "Aktiv",
  • "address": "Teststraße 1337\n47608 Geldern\n",
  • "country": "DE",
  • "status": "Explanation of Legality",
  • "contractBasis": "basis of the contract",
  • "email": "test@test.de",
  • "homepage": "https://www.test.de/",
  • "phone": 49123456,
  • "fax": 49123456,
  • "isProcessor": false,
  • "isJointController": false,
  • "hasDPA": false,
  • "hasJCA": false,
  • "dpaInformation": "information text",
  • "dpaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "dpaVerifiedName": "Muster GmbH",
  • "dpaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "dpaApprovedName": "Muster GmbH",
  • "jcaInformation": "information text",
  • "jcaVerifiedDate": "2024-04-23T13:57:06+02:00",
  • "jcaVerifiedName": "Muster GmbH",
  • "jcaApprovedDate": "2024-04-23T13:57:06+02:00",
  • "jcaApprovedName": "Muster GmbH"
}

software

Operations to handle software.

get list of softwares for the company

get list of softwares for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new software

creates new software

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
reference
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "reference": "A15",
  • "name": "Muster GmbH"
}

Response samples

Content type
application/json
{
  • "softwareId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A15",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "status": "Aktiv",
  • "type": "On-Premises",
  • "country": "DE",
  • "homepage": "example.com",
  • "aiSystem": 1,
  • "aiSystemDesc": "LLM basierte Übersetzung"
}

get software for the given id

get software for the given id

Authorizations:
bearerAuth
path Parameters
softwareId
required
integer <int64> >= 1

The ID of the software to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "softwareId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A15",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "status": "Aktiv",
  • "type": "On-Premises",
  • "country": "DE",
  • "homepage": "example.com",
  • "aiSystem": 1,
  • "aiSystemDesc": "LLM basierte Übersetzung"
}

updates software

updates software

Authorizations:
bearerAuth
path Parameters
softwareId
required
integer <int64> >= 1

The ID of the software to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
reference
string
name
required
string
desc
string
status
string
type
string
country
string

must be defined in the system, can be found in GET /countries

homepage
string
aiSystem
integer
Enum: 1 0 -1

1: yes, 0: no, -1: unknown

aiSystemDesc
string

Responses

Request samples

Content type
application/json
{
  • "reference": "A15",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "status": "Aktiv",
  • "type": "On-Premises",
  • "country": "DE",
  • "homepage": "example.com",
  • "aiSystem": 1,
  • "aiSystemDesc": "LLM basierte Übersetzung"
}

Response samples

Content type
application/json
{
  • "softwareId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "reference": "A15",
  • "name": "Muster GmbH",
  • "desc": "purpose",
  • "status": "Aktiv",
  • "type": "On-Premises",
  • "country": "DE",
  • "homepage": "example.com",
  • "aiSystem": 1,
  • "aiSystemDesc": "LLM basierte Übersetzung"
}

deletes software

deletes software

Authorizations:
bearerAuth
path Parameters
softwareId
required
integer <int64> >= 1

The ID of the software to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

task

Operations to handle tasks.

get list of tasks for the company

get list of tasks for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new task

creates new task

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company to return.

Request Body schema: application/json
title
required
string
desc
string
link
string
dueDate
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "taskId": 1,
  • "assigned": "test@example.com",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "isDone": true,
  • "title": "Starte etwas Neues",
  • "desc": "Beschreibung",
  • "link": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "dueDate": "2021-03-13T12:26:40+01:00"
}

get task for the given id

get task for the given id

Authorizations:
bearerAuth
path Parameters
taskId
required
integer <int64> >= 1

The ID of the task to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "taskId": 1,
  • "assigned": "test@example.com",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "isDone": true,
  • "title": "Starte etwas Neues",
  • "desc": "Beschreibung",
  • "link": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "dueDate": "2021-03-13T12:26:40+01:00"
}

updates task

updates task

Authorizations:
bearerAuth
path Parameters
taskId
required
integer <int64> >= 1

The ID of the task to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
title
required
string
desc
string
link
string
dueDate
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "taskId": 1,
  • "assigned": "test@example.com",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "isDone": true,
  • "title": "Starte etwas Neues",
  • "desc": "Beschreibung",
  • "link": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "dueDate": "2021-03-13T12:26:40+01:00"
}

deletes task

deletes task

Authorizations:
bearerAuth
path Parameters
taskId
required
integer <int64> >= 1

The ID of the task to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

assigns the task to a user

assigns the task to a user

Authorizations:
bearerAuth
path Parameters
taskId
required
integer <int64> >= 1

The ID of the task to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
username
required
string

Benutzername, muss Benutzer des Unternehmens sein.

notify
required
boolean
Default: false

Soll der Benutzer eine Benachrichtung über die Nachrichtenzentrale erhalten?

Responses

Request samples

Content type
application/json
{
  • "username": "test@example.com",
  • "notify": true
}

Response samples

Content type
application/json
{
  • "taskId": 1,
  • "assigned": "test@example.com",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "isDone": true,
  • "title": "Starte etwas Neues",
  • "desc": "Beschreibung",
  • "link": "https://app.dpms-online.de/contract/60f8780f66b56",
  • "dueDate": "2021-03-13T12:26:40+01:00"
}

get list of priorities for the company

get list of priorities for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

employee

Operations to handle employees.

get list of employees for the company

get list of employees for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a new employee

create a new employee

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
lang
string

language must be enabled in the company

reference
string
name
required
string
firstname
string
salutation
string
description
string
email
string

musst be valid email

phone
string
object

must be definied in the system, can be found in GET /index/defaults

isLiable
boolean
intranetDisabled
boolean
noTrainingNeeded
boolean

the employee will not be suggested for training invitations and missing trainings will not be included in statistics

ndaDate
string
informedDpDate
string
schoolingDpDate
string
schoolingItDate
string
schoolingAiDate
string
schoolingWbDate
string
enterDate
string
exitDate
string
absentFrom
string
absentTill
string
absentReason
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "lang": "DE",
  • "reference": "H44",
  • "name": "Mustermann",
  • "firstname": "Peter",
  • "salutation": "Herr",
  • "description": "Zuständig für Kundenanfragen",
  • "email": "peter@mustermann.de",
  • "phone": "1234-56789",
  • "department": {
    },
  • "isLiable": true,
  • "intranetDisabled": false,
  • "noTrainingNeeded": false,
  • "ndaDate": "2021-03-13T12:26:40+01:00",
  • "informedDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingItDate": "2021-03-13T12:26:40+01:00",
  • "schoolingAiDate": "2021-03-13T12:26:40+01:00",
  • "schoolingWbDate": "2021-03-13T12:26:40+01:00",
  • "enterDate": "2020-05-14T00:00:00+02:00",
  • "exitDate": "2024-05-14T00:00:00+02:00",
  • "absentFrom": "2024-04-01T00:00:00+02:00",
  • "absentTill": "2024-04-15T00:00:00+02:00",
  • "absentReason": "Elternzeit",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "lang": "DE",
  • "reference": "H44",
  • "name": "Mustermann",
  • "firstname": "Peter",
  • "salutation": "Herr",
  • "description": "Zuständig für Kundenanfragen",
  • "email": "peter@mustermann.de",
  • "phone": "1234-56789",
  • "department": {
    },
  • "isLiable": true,
  • "intranetDisabled": false,
  • "noTrainingNeeded": false,
  • "ndaDate": "2021-03-13T12:26:40+01:00",
  • "informedDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingItDate": "2021-03-13T12:26:40+01:00",
  • "schoolingAiDate": "2021-03-13T12:26:40+01:00",
  • "schoolingWbDate": "2021-03-13T12:26:40+01:00",
  • "enterDate": "2020-05-14T00:00:00+02:00",
  • "exitDate": "2024-05-14T00:00:00+02:00",
  • "absentFrom": "2024-04-01T00:00:00+02:00",
  • "absentTill": "2024-04-15T00:00:00+02:00",
  • "absentReason": "Elternzeit",
  • "fields": [
    ],
  • "employeeId": 12,
  • "trainings": [
    ],
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00"
}

get employee for the given id

get employee for the given id

Authorizations:
bearerAuth
path Parameters
employeeId
required
integer <int64> >= 1

The ID of the employee

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "lang": "DE",
  • "reference": "H44",
  • "name": "Mustermann",
  • "firstname": "Peter",
  • "salutation": "Herr",
  • "description": "Zuständig für Kundenanfragen",
  • "email": "peter@mustermann.de",
  • "phone": "1234-56789",
  • "department": {
    },
  • "isLiable": true,
  • "intranetDisabled": false,
  • "noTrainingNeeded": false,
  • "ndaDate": "2021-03-13T12:26:40+01:00",
  • "informedDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingItDate": "2021-03-13T12:26:40+01:00",
  • "schoolingAiDate": "2021-03-13T12:26:40+01:00",
  • "schoolingWbDate": "2021-03-13T12:26:40+01:00",
  • "enterDate": "2020-05-14T00:00:00+02:00",
  • "exitDate": "2024-05-14T00:00:00+02:00",
  • "absentFrom": "2024-04-01T00:00:00+02:00",
  • "absentTill": "2024-04-15T00:00:00+02:00",
  • "absentReason": "Elternzeit",
  • "fields": [
    ],
  • "employeeId": 12,
  • "trainings": [
    ],
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00"
}

update the employee for the given id

update the employee for the given id

Authorizations:
bearerAuth
path Parameters
employeeId
required
integer <int64> >= 1

The ID of the employee

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
lang
string

language must be enabled in the company

reference
string
name
required
string
firstname
string
salutation
string
description
string
email
string

musst be valid email

phone
string
object

must be definied in the system, can be found in GET /index/defaults

isLiable
boolean
intranetDisabled
boolean
noTrainingNeeded
boolean

the employee will not be suggested for training invitations and missing trainings will not be included in statistics

ndaDate
string
informedDpDate
string
schoolingDpDate
string
schoolingItDate
string
schoolingAiDate
string
schoolingWbDate
string
enterDate
string
exitDate
string
absentFrom
string
absentTill
string
absentReason
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "lang": "DE",
  • "reference": "H44",
  • "name": "Mustermann",
  • "firstname": "Peter",
  • "salutation": "Herr",
  • "description": "Zuständig für Kundenanfragen",
  • "email": "peter@mustermann.de",
  • "phone": "1234-56789",
  • "department": {
    },
  • "isLiable": true,
  • "intranetDisabled": false,
  • "noTrainingNeeded": false,
  • "ndaDate": "2021-03-13T12:26:40+01:00",
  • "informedDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingItDate": "2021-03-13T12:26:40+01:00",
  • "schoolingAiDate": "2021-03-13T12:26:40+01:00",
  • "schoolingWbDate": "2021-03-13T12:26:40+01:00",
  • "enterDate": "2020-05-14T00:00:00+02:00",
  • "exitDate": "2024-05-14T00:00:00+02:00",
  • "absentFrom": "2024-04-01T00:00:00+02:00",
  • "absentTill": "2024-04-15T00:00:00+02:00",
  • "absentReason": "Elternzeit",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "lang": "DE",
  • "reference": "H44",
  • "name": "Mustermann",
  • "firstname": "Peter",
  • "salutation": "Herr",
  • "description": "Zuständig für Kundenanfragen",
  • "email": "peter@mustermann.de",
  • "phone": "1234-56789",
  • "department": {
    },
  • "isLiable": true,
  • "intranetDisabled": false,
  • "noTrainingNeeded": false,
  • "ndaDate": "2021-03-13T12:26:40+01:00",
  • "informedDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingDpDate": "2021-03-13T12:26:40+01:00",
  • "schoolingItDate": "2021-03-13T12:26:40+01:00",
  • "schoolingAiDate": "2021-03-13T12:26:40+01:00",
  • "schoolingWbDate": "2021-03-13T12:26:40+01:00",
  • "enterDate": "2020-05-14T00:00:00+02:00",
  • "exitDate": "2024-05-14T00:00:00+02:00",
  • "absentFrom": "2024-04-01T00:00:00+02:00",
  • "absentTill": "2024-04-15T00:00:00+02:00",
  • "absentReason": "Elternzeit",
  • "fields": [
    ],
  • "employeeId": 12,
  • "trainings": [
    ],
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00"
}

delete the employee for the given id

delete the employee for the given id

Authorizations:
bearerAuth
path Parameters
employeeId
required
integer <int64> >= 1

The ID of the employee

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

send an intranet invitation

sends an intranet invitation to the employee's email

Authorizations:
bearerAuth
path Parameters
employeeId
required
integer <int64> >= 1

The ID of the employee

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

action

Operations to handle actions of the management systems module.

get list of actions for the company

get list of actions for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates new action

creates new action

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
title
required
string
required
object

available priorities can be found in GET /task/priority

status
required
string
Enum: "new" "open" "review" "done" "waiting" "rejected"
Array of objects
action
string
finding
string
note
string
deadline
string
costs
number
costType
string

has to be defined as a company default

Responses

Request samples

Content type
application/json
{
  • "title": "Sicherheitsschlösser",
  • "priority": {
    },
  • "status": "new",
  • "editors": [
    ],
  • "action": "An allen externen Türen müssen Sicherheitsschlösser montiert werden.",
  • "finding": "Die aktuellen Schlösser bieten unzureichenden Schutz.",
  • "note": "Absprache zum Montage Termin mit Gabi",
  • "deadline": "2025-07-18",
  • "costs": 200,
  • "costType": "EUR"
}

Response samples

Content type
application/json
{
  • "actionId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "priority": {
    },
  • "editors": [
    ],
  • "title": "Sicherheitsschlösser",
  • "status": "new",
  • "action": "An allen externen Türen müssen Sicherheitsschlösser montiert werden.",
  • "finding": "Die aktuellen Schlösser bieten unzureichenden Schutz.",
  • "note": "Absprache zum Montage Termin mit Gabi",
  • "deadline": "2025-07-18",
  • "costs": 200,
  • "costType": "EUR"
}

get action for the given id

get action for the given id

Authorizations:
bearerAuth
path Parameters
actionId
required
integer <int64> >= 1

The ID of the action to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "actionId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "priority": {
    },
  • "editors": [
    ],
  • "title": "Sicherheitsschlösser",
  • "status": "new",
  • "action": "An allen externen Türen müssen Sicherheitsschlösser montiert werden.",
  • "finding": "Die aktuellen Schlösser bieten unzureichenden Schutz.",
  • "note": "Absprache zum Montage Termin mit Gabi",
  • "deadline": "2025-07-18",
  • "costs": 200,
  • "costType": "EUR"
}

updates action

updates action

Authorizations:
bearerAuth
path Parameters
actionId
required
integer <int64> >= 1

The ID of the action to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
title
required
string
required
object

available priorities can be found in GET /task/priority

status
required
string
Enum: "new" "open" "review" "done" "waiting" "rejected"
Array of objects
action
string
finding
string
note
string
deadline
string
costs
number
costType
string

has to be defined as a company default

Responses

Request samples

Content type
application/json
{
  • "title": "Sicherheitsschlösser",
  • "priority": {
    },
  • "status": "new",
  • "editors": [
    ],
  • "action": "An allen externen Türen müssen Sicherheitsschlösser montiert werden.",
  • "finding": "Die aktuellen Schlösser bieten unzureichenden Schutz.",
  • "note": "Absprache zum Montage Termin mit Gabi",
  • "deadline": "2025-07-18",
  • "costs": 200,
  • "costType": "EUR"
}

Response samples

Content type
application/json
{
  • "actionId": 1,
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "created": "2021-03-13T12:26:40+01:00",
  • "priority": {
    },
  • "editors": [
    ],
  • "title": "Sicherheitsschlösser",
  • "status": "new",
  • "action": "An allen externen Türen müssen Sicherheitsschlösser montiert werden.",
  • "finding": "Die aktuellen Schlösser bieten unzureichenden Schutz.",
  • "note": "Absprache zum Montage Termin mit Gabi",
  • "deadline": "2025-07-18",
  • "costs": 200,
  • "costType": "EUR"
}

deletes action

deletes action

Authorizations:
bearerAuth
path Parameters
actionId
required
integer <int64> >= 1

The ID of the action to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

training

Operations to handle employee training.

get a list of certificates with the given certificate code

get a list of certificates with the given certificate code

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

term
required
string
Example: term=TEST07068

The certificate code to search for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a list of trainings

get a list of trainings

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a list of events for the given training

get a list of events for the given training

Authorizations:
bearerAuth
path Parameters
trainingId
required
integer <int64> >= 1

The ID of the training.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a new event for the given training

create a new event for the given training

Authorizations:
bearerAuth
path Parameters
trainingId
required
integer <int64> >= 1

The ID of the training.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
name
required
string
eventIdent
string

an identifier for the event that is unique in the entire system

isPublic
boolean
maxMember
integer

0 = unbegrenzt

allowCertDownload
boolean
bccReceiver
Array of strings
disabledAfterDate
string

Responses

Request samples

Content type
application/json
{
  • "name": "Schulung 2024",
  • "eventIdent": "67af41d9c8b28",
  • "isPublic": false,
  • "maxMember": 5,
  • "allowCertDownload": true,
  • "bccReceiver": [
    ],
  • "disabledAfterDate": "2024-02-11T10:24:30+01:00"
}

Response samples

Content type
application/json
{
  • "name": "Schulung 2024",
  • "eventIdent": "67af41d9c8b28",
  • "isPublic": false,
  • "maxMember": 5,
  • "allowCertDownload": true,
  • "bccReceiver": [
    ],
  • "disabledAfterDate": "2024-02-11T10:24:30+01:00",
  • "eventId": 13,
  • "registrationLink": "https://app.dpms-online.de/go/657f3ae2a267b/register",
  • "sendCertAuto": true,
  • "showInCockpit": false,
  • "enableReinvite": false,
  • "reinviteInterval": 7
}

policy

Operations to handle policies.

get list of policies

get a list of all policies for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a policy

get the requested policy

Authorizations:
bearerAuth
path Parameters
policyId
required
integer <int64> >= 1

The ID of the policy

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "policyId": 1,
  • "title": "Hinweise zum Datenschutz für Nutzer",
  • "lang": "DE",
  • "draftContent": "<h3>Nutzung der Signierungsfunktion</h3> <p>Bei der Nutzung des Dienstes fragen wir Sie möglicherweise nach Ihrem Namen, dem Namen Ihres Unternehmens, Ihrer E-Mail-Adresse und Ihren Telefonnummern.</p>",
  • "publicContent": "<h3>Nutzung der Signierungsfunktion</h3> <p>Bei der Nutzung des Dienstes fragen wir Sie möglicherweise nach Ihrem Namen, dem Namen Ihres Unternehmens, Ihrer E-Mail-Adresse und Ihren Telefonnummern.</p>",
  • "ident": "6829420eef763",
  • "systemName": "dpmsSystemPolicyDe",
  • "isDraft": false,
  • "isPublic": true,
  • "publishDate": "2025-09-01T10:55:00+02:00",
  • "lastChange": "2025-09-01T10:55:00+02:00"
}

get html of a policy

get the html of the the requested policy

Authorizations:
bearerAuth
path Parameters
policyId
required
integer <int64> >= 1

The ID of the policy

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

hideToc
boolean

when true the table of contents will be removed from the html

Responses

department

Operations to handle departments.

get list of departments for the company

get list of departments for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

creates a new department

creates a new department

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
name
required
string
shorthand
string
description
string
contactInfo
string

Responses

Request samples

Content type
application/json
{
  • "name": "IT-Abteilung",
  • "shorthand": "IT",
  • "description": "Informations- und Kommunikationstechnologie",
  • "contactInfo": "Seiteneingang von Gebäude A"
}

Response samples

Content type
application/json
{
  • "departmentIdent": "receiverIntern68c7d5aae93a8",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "name": "IT-Abteilung",
  • "shorthand": "IT",
  • "description": "Informations- und Kommunikationstechnologie",
  • "contactInfo": "Seiteneingang von Gebäude A"
}

get department for the given ident

get department for the given ident

Authorizations:
bearerAuth
path Parameters
departmentIdent
required
string
Example: receiverIntern68c7d5aae93a8

The ident of the department to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "departmentIdent": "receiverIntern68c7d5aae93a8",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "name": "IT-Abteilung",
  • "shorthand": "IT",
  • "description": "Informations- und Kommunikationstechnologie",
  • "contactInfo": "Seiteneingang von Gebäude A"
}

updates department

updates department

Authorizations:
bearerAuth
path Parameters
departmentIdent
required
string
Example: receiverIntern68c7d5aae93a8

The ident of the department to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
name
required
string
shorthand
string
description
string
contactInfo
string

Responses

Request samples

Content type
application/json
{
  • "name": "IT-Abteilung",
  • "shorthand": "IT",
  • "description": "Informations- und Kommunikationstechnologie",
  • "contactInfo": "Seiteneingang von Gebäude A"
}

Response samples

Content type
application/json
{
  • "departmentIdent": "receiverIntern68c7d5aae93a8",
  • "lastChange": "2021-03-13T12:26:40+01:00",
  • "name": "IT-Abteilung",
  • "shorthand": "IT",
  • "description": "Informations- und Kommunikationstechnologie",
  • "contactInfo": "Seiteneingang von Gebäude A"
}

deletes department

deletes department

Authorizations:
bearerAuth
path Parameters
departmentIdent
required
string
Example: receiverIntern68c7d5aae93a8

The ident of the department to return.

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

asset

Operations to handle assets.

get list of available defaults for asset properties

get list of available defaults for asset properties

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of available protection objectives

get list of available protection objectives

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of assets for the company

get list of assets for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a new asset

create a new asset

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
reference
string
title
required
string
desc
string
status
string

has to exist as a default. See assetStatus in GET /asset/defaults

type
string

has to exist as a default. See assetTypes in GET /asset/defaults

departments
Array of strings

each entry has to exist as a default. See receiverIntern in GET /asset/defaults

mta
string
rpo
string
rto
string
dsi
string
Array of objects (ProtectionNeed)
Array of objects
Array of objects (LinkedItem)

Responses

Request samples

Content type
application/json
{
  • "reference": "0001",
  • "title": "Laptops",
  • "desc": "Arbeitslaptops für unsere Mitarbeiter.",
  • "status": "Betrieb",
  • "type": "IT-Systeme und -Geräte",
  • "departments": [
    ],
  • "mta": "1 Tag",
  • "rpo": "letzter Tag der Benutzung",
  • "rto": "2 Stunden",
  • "dsi": "täglich",
  • "protectionNeeds": [
    ],
  • "childAssets": [
    ],
  • "linkedObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "reference": "0001",
  • "title": "Laptops",
  • "desc": "Arbeitslaptops für unsere Mitarbeiter.",
  • "status": "Betrieb",
  • "type": "IT-Systeme und -Geräte",
  • "departments": [
    ],
  • "mta": "1 Tag",
  • "rpo": "letzter Tag der Benutzung",
  • "rto": "2 Stunden",
  • "dsi": "täglich",
  • "protectionNeeds": [
    ],
  • "childAssets": [
    ],
  • "linkedObjects": [
    ],
  • "assetId": 16,
  • "companyLinks": [
    ]
}

get asset for the given id

get asset for the given id

Authorizations:
bearerAuth
path Parameters
assetId
required
integer <int64> >= 1

The ID of the asset

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "reference": "0001",
  • "title": "Laptops",
  • "desc": "Arbeitslaptops für unsere Mitarbeiter.",
  • "status": "Betrieb",
  • "type": "IT-Systeme und -Geräte",
  • "departments": [
    ],
  • "mta": "1 Tag",
  • "rpo": "letzter Tag der Benutzung",
  • "rto": "2 Stunden",
  • "dsi": "täglich",
  • "protectionNeeds": [
    ],
  • "childAssets": [
    ],
  • "linkedObjects": [
    ],
  • "assetId": 16,
  • "companyLinks": [
    ]
}

update the asset for the given id

update the asset for the given id

Authorizations:
bearerAuth
path Parameters
assetId
required
integer <int64> >= 1

The ID of the asset

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
reference
string
title
required
string
desc
string
status
string

has to exist as a default. See assetStatus in GET /asset/defaults

type
string

has to exist as a default. See assetTypes in GET /asset/defaults

departments
Array of strings

each entry has to exist as a default. See receiverIntern in GET /asset/defaults

mta
string
rpo
string
rto
string
dsi
string
Array of objects (ProtectionNeed)
Array of objects
Array of objects (LinkedItem)

Responses

Request samples

Content type
application/json
{
  • "reference": "0001",
  • "title": "Laptops",
  • "desc": "Arbeitslaptops für unsere Mitarbeiter.",
  • "status": "Betrieb",
  • "type": "IT-Systeme und -Geräte",
  • "departments": [
    ],
  • "mta": "1 Tag",
  • "rpo": "letzter Tag der Benutzung",
  • "rto": "2 Stunden",
  • "dsi": "täglich",
  • "protectionNeeds": [
    ],
  • "childAssets": [
    ],
  • "linkedObjects": [
    ]
}

Response samples

Content type
application/json
{
  • "reference": "0001",
  • "title": "Laptops",
  • "desc": "Arbeitslaptops für unsere Mitarbeiter.",
  • "status": "Betrieb",
  • "type": "IT-Systeme und -Geräte",
  • "departments": [
    ],
  • "mta": "1 Tag",
  • "rpo": "letzter Tag der Benutzung",
  • "rto": "2 Stunden",
  • "dsi": "täglich",
  • "protectionNeeds": [
    ],
  • "childAssets": [
    ],
  • "linkedObjects": [
    ],
  • "assetId": 16,
  • "companyLinks": [
    ]
}

delete the asset for the given id

delete the asset for the given id

Authorizations:
bearerAuth
path Parameters
assetId
required
integer <int64> >= 1

The ID of the asset

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

create a new company link

create a new company link or employee

Authorizations:
bearerAuth
path Parameters
assetId
required
integer <int64> >= 1

The ID of the asset

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
typeId
required
integer
employeeId
integer or null

set if the company link is filled by a company employee

roleId
integer or null

set if the company link is filled by a company role

desc
integer
showInReport
boolean

Responses

Request samples

Content type
application/json
{
  • "typeId": 3,
  • "employeeId": 73,
  • "roleId": null,
  • "desc": "Verantwortlich für Datenschutz",
  • "showInReport": true
}

Response samples

Content type
application/json
{
  • "linkId": 95,
  • "typeId": 3,
  • "employeeId": 73,
  • "roleId": null,
  • "desc": "Verantwortlich für Datenschutz",
  • "showInReport": true
}

asset-relation

GET endpoints for objects that can be linked to assets, but are otherwise not in the API.

get list of devices for the company

get list of devices for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get device for the given id

get device for the given id

Authorizations:
bearerAuth
path Parameters
deviceId
required
integer <int64> >= 1

The ID of the device

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of locations for the company

get list of locations for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get location for the given id

get location for the given id

Authorizations:
bearerAuth
path Parameters
locationId
required
integer <int64> >= 1

The ID of the location

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of folders for the company

get list of folders for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get folder for the given id

get folder for the given id

Authorizations:
bearerAuth
path Parameters
folderId
required
integer <int64> >= 1

The ID of the folder

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of files for the company

get list of files for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get file for the given id

get file for the given id

Authorizations:
bearerAuth
path Parameters
fileId
required
integer <int64> >= 1

The ID of the file

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of processes for the company

get list of processes for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get process for the given id

get process for the given id

Authorizations:
bearerAuth
path Parameters
processId
required
integer <int64> >= 1

The ID of the process

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a new company link

create a new company link or employee

Authorizations:
bearerAuth
path Parameters
assetId
required
integer <int64> >= 1

The ID of the asset

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
typeId
required
integer
employeeId
integer or null

set if the company link is filled by a company employee

roleId
integer or null

set if the company link is filled by a company role

desc
integer
showInReport
boolean

Responses

Request samples

Content type
application/json
{
  • "typeId": 3,
  • "employeeId": 73,
  • "roleId": null,
  • "desc": "Verantwortlich für Datenschutz",
  • "showInReport": true
}

Response samples

Content type
application/json
{
  • "linkId": 95,
  • "typeId": 3,
  • "employeeId": 73,
  • "roleId": null,
  • "desc": "Verantwortlich für Datenschutz",
  • "showInReport": true
}

update the link for the given id

update the link for the given id

Authorizations:
bearerAuth
path Parameters
linkId
required
integer <int64> >= 1

The ID of the link

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
desc
integer
showInReport
boolean

Responses

Request samples

Content type
application/json
{
  • "desc": "Verantwortlich für Datenschutz",
  • "showInReport": true
}

Response samples

Content type
application/json
{
  • "linkId": 95,
  • "typeId": 3,
  • "employeeId": 73,
  • "roleId": null,
  • "desc": "Verantwortlich für Datenschutz",
  • "showInReport": true
}

delete the link for the given id

delete the link for the given id

Authorizations:
bearerAuth
path Parameters
linkId
required
integer <int64> >= 1

The ID of the link

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
{
  • "success": true
}

get list of link types for the company

get list of link types for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get the link type for the given id

get the link type for the given id

Authorizations:
bearerAuth
path Parameters
typeId
required
integer <int64> >= 1

The ID of the link type

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of roles for the company

get list of roles for the company

Authorizations:
bearerAuth
query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get role for the given id

get role for the given id

Authorizations:
bearerAuth
path Parameters
roleId
required
integer <int64> >= 1

The ID of the role

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Responses

Response samples

Content type
application/json
[
  • {
    }
]

default

Other operations.

look up server version

look up server version

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "version": "1.0.9",
  • "systemtime": "2021-03-13T12:26:40+01:00"
}

look up user for current session

look up user for current session

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "username": "api@example.com",
  • "systemLang": "DE",
  • "email": "peter@mustermann.de"
}

get list of available countries with countrycode

get list of available countries with countrycode

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of available roles

get list of available roles

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get list of available levels for role = custom

get list of available levels for role = custom

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create a message for a user

create a message for a user

Authorizations:
bearerAuth
path Parameters
userId
required
integer <int64> >= 1

The user to message

query Parameters
companyId
required
integer <int64> >= 1

The ID of the company

Request Body schema: application/json
ident
required
string

An identifier for the message. If the user has an unread message with the same identifier, that message is overwritten and no additional notification is created.

title
required
string
link
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true
}

search for a user

search for a user

Authorizations:
bearerAuth
query Parameters
username
required
string
Example: username=peter@mustermann.de

The username you want to search. The search looks for an exact match.

Responses

Response samples

Content type
application/json
{
  • "userId": 7,
  • "username": "peter@mustermann.de",
  • "samlIdent": "5242d2b4edfab",
  • "lastAuth": "2024-08-14T15:13:38+02:00",
  • "isEnabled": true,
  • "companies": [
    ]
}