paths:
/mobile/checksassignment:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryChecksAssignmentSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/canvas/{canvas_id}:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not modified
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCanvasSchema'
'403':
description: Request not allowed
/mobile/chats:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: check_id
in: path
description: ID of check
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryChatMessageSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ChatMessageSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/checks/{check_id}:
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCheckSchema'
required: true
- name: check_id
in: path
description: ID of check
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/checksets/{checkset_id}/checks:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/checksbyfailed:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/checksstatus:
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryChecksStatusSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/checksetcomments/{comment_id}:
delete:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseChecksetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/checksetcomments:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseChecksetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/documentdownload/{document_id}:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
/mobile/livestatus:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not Modified
'200':
description: new etag
/mobile/participants/{participant_id}:
delete:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: participant_id
in: path
description: participant_id
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Company Deleted
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestParticipantSchema'
required: true
- name: participant_id
in: path
description: participant_id
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/participants:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestParticipantSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/participant_email/{participant_id}:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: participant_id
in: path
description: participant_id
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Company Deleted
/mobile/synccache:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QuerySyncCacheSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: raw data
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/test:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/testcomments/{comment_id}:
delete:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/testcomments:
post:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/tests/{test_id}:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/teststatusoverview:
get:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not modified
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/user:
put:
parameters:
- description: Short URL
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestParticipantSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/mobile/validate:
get:
parameters:
- name: short_url
in: query
description: the short_url token
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserSchema'
/agendas/{agenda_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: agenda_id
in: path
description: ID of agenda
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: agenda_id
in: path
description: ID of agenda
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseAgendaSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryAgendaSchema'
required: true
- name: agenda_id
in: path
description: ID of agenda
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseAgendaSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/agendas/{agenda_id}/move/{direction}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: agenda_id
in: path
description: ID of agenda
type: integer
required: true
- name: direction
in: path
description: up or down
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseAgendaSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/agendas:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseAgendaSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryAgendaSchema'
required: true
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseAgendaSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/documents/{document_id}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCanvasSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/auto_organize:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: "Success \u2014 returns updated markers"
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'400':
description: Canvas not found
'403':
description: Not enough rights
/canvas/{canvas_id}/calibrate:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: "Success \u2014 returns updated canvas"
'400':
description: Canvas not found or invalid input
'403':
description: Not enough rights
/canvas/{canvas_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCanvasSchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCanvasSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/markers:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Success
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/canvaszonecolor/{canvas_id}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCanvasSchema'
'403':
description: Request not allowed
/certificates/{certificate_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: certificate_id
in: path
description: ID of certificate
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: certificate_id
in: path
description: ID of certificate
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
'403':
description: Request not allowed
'404':
description: Item not found
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCertificateSchema'
required: true
- name: certificate_id
in: path
description: ID of certificate
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
'403':
description: Request not allowed
'404':
description: Item not found
/certificates/{certificate_id}/download:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
/projects/{project_id}/certificates:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCertificateSchema'
required: true
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCertificateSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: Name already exists
/checks/{check_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCheckSchema'
required: true
- name: check_id
in: path
description: ID of check
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/checksassignment/{participant_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/checksassignment:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryChecksAssignmentSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/checksets/{checkset_id}/checks:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: checkset_id
in: path
description: ID of checkset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/ignoredepartment:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/failedchecks:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/checks:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/ignoretester:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/ignoreifzero:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/checksstatus:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryChecksStatusSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCheckSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/checksetcomments/{comment_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseChecksetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/checksetcomments:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseChecksetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/projects/{project_id}/checksets:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseChecksetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/comments_history:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentsHistorySchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: include_logos
in: query
description: legacy shape with inline base64 logos, for clients that cannot
authenticate
requests against /companies//logo
type: boolean
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not modified
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCompanySchema'
'403':
description: Request not allowed
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCompanySchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCompanySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies/{company_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Company Deleted
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCompanySchema'
'403':
description: Request not allowed
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCompanySchema_Edit'
required: true
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCompanySchema'
'403':
description: Request not allowed
/companiesbytextid/{company_textid}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_textid
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not modified
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCompanySchema'
'403':
description: Request not allowed
/companies/{company_id}/logo:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not modified
'200':
description: Logo image
'404':
description: Company or logo not found
/companies/{company_id}/project_transfer:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCompanyProjectTransferSchema'
required: true
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCompanySchema'
'403':
description: Request not allowed
/tests/{test_id}/defectlistexcel:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Matrix Exported.
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/documents/{document_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Document Deleted
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
/documentcrop/{document_id}:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryDocumentCropSchema'
required: true
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
/documentdownload/{document_id}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'304':
description: Not modified
'200':
description: Success
'403':
description: Request not allowed
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
/document_rasterize_preview:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: file
in: formData
description: PDF file to rasterize
type: file
- name: resolution
in: formData
description: requested raster resolution in DPI
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: "Success \u2014 { url, width, height } with width/height in\
\ PDF points"
'500':
description: Rasterization failed
/projects/{project_id}/documents:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseDocumentSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/documents:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseCanvasSchema'
'403':
description: Request not allowed
/elements/{element_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: element_id
in: path
description: ID of element
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: element_id
in: path
description: ID of element
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementSchema'
required: true
- name: element_id
in: path
description: ID of element
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies/{company_textid}/projects/{project_textid}/elements/lookup_by_qr/{qr_hash}:
get: {}
/elements/{element_id}/copy:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: element_id
in: path
description: ID of element
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
/elements/{element_id}/history:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: element_id
in: path
description: ID of element
type: integer
required: true
- in: query
name: column_name
type: string
description: The column name to get, empty gets all columns
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementmarkers/{marker_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: ElementMarker Deleted
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'403':
description: Request not allowed
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementMarkerSchema'
required: true
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/element_copy_from_other:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementMarkerCopySchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementmarkerrename/{marker_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementMarkerSchema'
required: true
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/elements:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementMarkerSchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementpresets/{elementpreset_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: elementpreset_id
in: path
description: ID of elementpreset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: ElementPreset deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: elementpreset_id
in: path
description: ID of elementpreset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementPresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementPresetSchema'
required: true
- name: elementpreset_id
in: path
description: ID of elementpreset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementPresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementpresets:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementPresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementPresetSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementPresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elements/{element_id}/zero:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: element_id
in: path
description: ID of element
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementzonerelations/{value_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementZoneRelationSchema'
required: true
- name: value_id
in: path
description: ID of value
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementZoneRelationSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementzonerelations/{value_id}/history:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: value_id
in: path
description: ID of value
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elements/{element_id}/zones/{zone_id}:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementZoneRelationSchema'
required: true
- name: element_id
in: path
description: ID of element
type: integer
required: true
- name: zone_id
in: path
description: ID of zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementZoneRelationSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementzonecategoryrelations/{value_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementZonecategoryRelationSchema'
required: true
- name: value_id
in: path
description: ID of value
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementZonecategoryRelationSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementzonecategoryrelations/{value_id}/history:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: value_id
in: path
description: ID of value
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elements/{element_id}/zonecategories/{zonecategory_id}:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementZonecategoryRelationSchema'
required: true
- name: element_id
in: path
description: ID of element
type: integer
required: true
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementZonecategoryRelationSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/elementcategories:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementcategorySchema'
required: true
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/reorder/elementcategories:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: data
in: body
description: a list of ids of element categories
schema:
type: array
items:
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementcategories/{elementcategory_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: elementcategory_id
in: path
description: ID of elementcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: elementcategory_id
in: path
description: ID of elementcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementcategorySchema'
required: true
- name: elementcategory_id
in: path
description: ID of elementcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementcategories/{elementcategory_id}/history:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: elementcategory_id
in: path
description: ID of elementcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/elementcategories/{elementcategory_id}/elements:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: elementcategory_id
in: path
description: ID of elementcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryElementSchema'
required: true
- name: elementcategory_id
in: path
description: ID of elementcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/recategory/{category_id}:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: category_id
in: path
description: ID of category
type: integer
required: true
- name: data
in: body
description: a list of ids of elements
schema:
type: array
items:
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/reorder/elements:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: data
in: body
description: a list of ids of elements
schema:
type: array
items:
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseElementSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/fpc/matrices/{matrix_id}/documents/{document_id}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
- name: document_id
in: path
description: ID of document
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success with document and canvas data
'400':
description: Item not found
'403':
description: Request not allowed
/fpc/matrices/{matrix_id}/documents/{document_id}/image:
get: {}
/companies/{company_textid}/projects/{project_textid}/fpc/offline:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_textid
in: path
description: textID of company
type: string
required: true
- name: project_textid
in: path
description: textID of project
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
'403':
description: Request not allowed
'404':
description: Item not found
/freepolygonmarkers/{marker_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: ZoneMarker Deleted
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryFreePolygonMarkerSchema'
required: true
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/freepolygons:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseFreePolygonMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryFreePolygonMarkerSchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseFreePolygonMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/projects/{project_id}/matrices:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryMatrixSchema'
required: true
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Matrix deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryMatrixSchema_Edit'
required: true
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies/{company_textid}/projects/{project_textid}/matrices/{matrix_textid}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_textid
in: path
description: textID of company
type: string
required: true
- name: project_textid
in: path
description: textID of project
type: string
required: true
- name: matrix_textid
in: path
description: textID of matrix
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{current_id}/compare/{other_id}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: current_id
in: path
description: ID of the matrix to compare
type: integer
required: true
- name: other_id
in: path
description: ID of the other matrix to compare
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/excel:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Matrix Exported.
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Import successful
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrixexceltemplate:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Matrix Exported.
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/fpc-export-data:
get: {}
/matrices/{matrix_id}/freeze:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of the matrix to freeze
type: integer
required: true
- name: description
in: body
description: the description of frozen matrix
schema:
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies/{company_textid}/projects/{project_textid}/matrixtables/{matrix_textid}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_textid
in: path
description: textID of company
type: string
required: true
- name: project_textid
in: path
description: textID of project
type: string
required: true
- name: matrix_textid
in: path
description: textID of matrix
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/unfreeze:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of the matrix to copy
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrixcategories:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryMatrixcategorySchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrixcategories/{matrixcategory_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrixcategory_id
in: path
description: ID of matrixcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryMatrixcategorySchema'
required: true
- name: matrixcategory_id
in: path
description: ID of matrixcategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseMatrixcategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/testparticipant_email/{participant_id}:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: participant_id
in: path
description: participant_id
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Company Deleted
/testparticipants_email/{test_id}:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Company Deleted
/photos/{photo_guid}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: photo_guid
in: path
description: ID of the document (photo)
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success (returns image/jpeg)
'403':
description: Not allowed
'404':
description: Not found
/photos/signed_urls:
post: {}
/presets/{preset_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: preset_id
in: path
description: ID of preset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Preset deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: preset_id
in: path
description: ID of preset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponsePresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryPresetSchema'
required: true
- name: preset_id
in: path
description: ID of preset
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponsePresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/presets:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponsePresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryPresetSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponsePresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/presets/reset:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponsePresetSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/projects/{project_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: Project deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryProjectSchema_Edit'
required: true
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies/{company_textid}/projects/{project_textid}:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_textid
in: path
description: textID of company
type: string
required: true
- name: project_textid
in: path
description: textID of project
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/projects/{project_id}/copy:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryProjectSchema'
required: true
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/companies/{company_textid}/projects/{project_textid}/fpcmatrices/full:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_textid
in: path
description: textID of company
type: string
required: true
- name: project_textid
in: path
description: textID of project
type: string
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectWithFPCFullSchema'
'403':
description: Request not allowed
'404':
description: Item not found
/companies/{company_id}/projects:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryProjectSchema'
required: true
- name: company_id
in: path
description: ID of company
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/publicprojects/{project_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryPublicProjectSchema_Edit'
required: true
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/publicprojects:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseProjectSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/systeminfo:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseSystemSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QuerySystemSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseSystemSchema'
/tests/{test_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestSchema'
required: true
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/agendas/excel:
get: {}
/testcomments/{comment_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
- name: comment_id
in: path
description: ID of comment
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/testcomments:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryCommentSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/copy:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestSchema'
required: true
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/freeze:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/testparticipants/{testparticipant_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: testparticipant_id
in: path
description: ID of testparticipant
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestParticipantSchema'
required: true
- name: testparticipant_id
in: path
description: ID of testparticipant
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/testparticipants:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestParticipantSchema'
required: true
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/testparticipants/excel:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/reorder/testparticipants:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: data
in: body
description: a list of ids of test partici
schema:
type: array
items:
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestParticipantSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/tests/{test_id}/unfreeze:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: test_id
in: path
description: ID of test
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/projects/{project_id}/tests:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTestSchema'
required: true
- name: project_id
in: path
description: ID of project
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/tests:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/textmarkers/{marker_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: TextMarker Deleted
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTextMarkerSchema'
'403':
description: Request not allowed
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTextMarkerSchema'
required: true
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTextMarkerSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/texts:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTextMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryTextMarkerSchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTextMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/upcomingtests:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: start
in: query
description: start timestamp (unix seconds)
type: integer
required: true
- name: end
in: query
description: end timestamp (unix seconds)
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseTestSchema'
'400':
description: Bad Request
'403':
description: Request not allowed
/urls/{url_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: url_id
in: path
description: ID of Url
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/urls:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryUrlSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUrlSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/users/{user_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: user_id
in: path
description: ID of user
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: user_id
in: path
description: ID of user
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/ResponseUserSchema'
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryUserSchema_Edit'
required: true
- name: user_id
in: path
description: ID of user
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserSchema'
'404':
description: Item not found
'409':
description: Username already exists / Email already exists
/login:
get: {}
/logout:
get:
parameters:
- name: auth
in: query
description: the auth token
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserSchema'
/userprojectrelations/{relation_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: relation_id
in: path
description: ID of relation
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryUserProjectRelationSchema'
required: true
- name: relation_id
in: path
description: ID of relation
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserProjectRelationSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/userprojectrelations:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryAddUserToProjectSchema'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserProjectRelationSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/users/{user_id}/resetMFA:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: user_id
in: path
description: ID of user
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserSchema'
'404':
description: Item not found
'409':
description: Username already exists / Email already exists
/reset_password:
post: {}
/validate:
get:
parameters:
- name: auth
in: query
description: the auth token
type: string
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserSchema'
/users:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/ResponseUserSchema'
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryUserSchema_Signup'
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseUserSchema'
'404':
description: Item not found
'409':
description: Username already exists / Email already exists
/zones/{zone_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zone_id
in: path
description: ID of zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zone_id
in: path
description: ID of zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZoneSchema'
required: true
- name: zone_id
in: path
description: ID of zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zones/{zone_id}/copy:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zone_id
in: path
description: ID of zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
/zones/{zone_id}/history:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zone_id
in: path
description: ID of zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zonemarkers/{marker_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'204':
description: ZoneMarker Deleted
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZoneMarkerSchema'
required: true
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
/zonemarkerrename/{marker_id}:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZoneMarkerSchema'
required: true
- name: marker_id
in: path
description: ID of marker
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
/canvas/{canvas_id}/zones:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZoneMarkerSchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/canvas/{canvas_id}/zone_copy_from_other:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZoneMarkerCopySchema'
required: true
- name: canvas_id
in: path
description: ID of canvas
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneMarkerSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zones/{zone_id}/zero:
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zone_id
in: path
description: ID of Zone
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/matrices/{matrix_id}/zonecategories:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZonecategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZonecategorySchema'
required: true
- name: matrix_id
in: path
description: ID of matrix
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZonecategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/reorder/zonecategories:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: data
in: body
description: a list of ids of zone categories
schema:
type: array
items:
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZonecategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zonecategories/{zonecategory_id}:
delete:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Deleted
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZonecategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
put:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZonecategorySchema'
required: true
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZonecategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zonecategories/{zonecategory_id}/copy:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZonecategorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zonecategories/{zonecategory_id}/history:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseHistorySchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/zonecategories/{zonecategory_id}/zones:
get:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: payload
description: Request Body
in: body
schema:
$ref: '#/definitions/QueryZoneSchema'
required: true
- name: zonecategory_id
in: path
description: ID of zonecategory
type: integer
required: true
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'400':
description: "Ung\xFCltiger Wert f\xFCr das Feld {0} ({1})"
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
/reorder/zones:
post:
parameters:
- description: API Key
in: query
name: auth
required: true
type: string
- name: data
in: body
description: a list of ids of zones
schema:
type: array
items:
type: integer
responses:
'401':
description: Anmeldung erforderlich / Authentifizierungstoken ist abgelaufen.
Bitte loggen Sie sich erneut ein.
'200':
description: Success
schema:
$ref: '#/definitions/ResponseZoneSchema'
'403':
description: Request not allowed
'404':
description: Item not found
'409':
description: ID already exists
info:
title: Brandfallsteuerungsmatrix API
version: 5.2.4
swagger: '2.0'
definitions:
QueryAddUserToProjectSchema:
type: object
properties:
user_email:
type: string
format: email
project_id:
type: integer
role:
type: string
enum:
- 'Null'
- Tester
- Editor
- ProjectAdmin
- CompanyAdmin
- SystemAdmin
modules:
type: array
items:
type: string
x-nullable: true
expiry_date:
type: integer
x-nullable: true
additionalProperties: false
QueryAgendaSchema:
type: object
properties:
start:
type: integer
end:
type: integer
description:
type: string
instruction:
type: string
x-nullable: true
fixed_start:
type: boolean
x-nullable: true
can_prepare_simple:
type: boolean
can_prepare_complex:
type: boolean
can_in_progress:
type: boolean
can_reset:
type: boolean
prepare_activated:
type: integer
x-nullable: true
progress_activated:
type: integer
x-nullable: true
reset_activated:
type: integer
x-nullable: true
group_name_spacer:
type: string
checksets:
type: array
items:
type: integer
additionalProperties: false
QueryBaseSchema:
type: object
properties: {}
additionalProperties: false
QueryCanvasSchema:
type: object
properties:
width:
type: integer
height:
type: integer
fontSize:
type: integer
strokeWidth:
type: integer
anchorSize:
type: integer
opacity:
type: number
strokeColor:
type: string
fontColor:
type: string
updateDocument:
type: boolean
updateElement:
type: boolean
updateZone:
type: boolean
updateText:
type: boolean
updateFreePolygon:
type: boolean
legend_data:
type: string
additionalProperties: false
QueryCertificateSchema:
type: object
properties:
name:
type: string
description:
type: string
x-nullable: true
expiration_date:
type: string
format: date-time
x-nullable: true
approval_number:
type: string
x-nullable: true
manufacturer:
type: string
x-nullable: true
product_name:
type: string
x-nullable: true
data:
type: string
additionalProperties: false
QueryChatMessageSchema:
type: object
properties:
message:
type: string
additionalProperties: false
QueryCheckSchema:
type: object
properties:
before_test_result:
type: string
enum:
- 'Null'
- Active
- Inactive
result:
type: string
enum:
- 'Null'
- Active
- Inactive
comment_before:
type: string
maxLength: 200
comment_test:
type: string
maxLength: 200
comment_after:
type: string
maxLength: 200
is_ready:
type: boolean
is_complete:
type: boolean
is_reset:
type: boolean
additionalProperties: false
QueryChecksAssignmentSchema:
type: object
properties:
checks:
type: array
items:
type: integer
assigned:
type: boolean
participant_id:
type: integer
checkset_id:
type: integer
broadcast:
type: boolean
additionalProperties: false
QueryChecksStatusSchema:
type: object
properties:
checks:
type: array
items:
type: integer
prop:
type: string
status:
type: boolean
additionalProperties: false
QueryCommentSchema:
type: object
properties:
test_id:
type: integer
x-nullable: true
checkset_id:
type: integer
x-nullable: true
tester:
type: string
x-nullable: true
comment:
type: string
x-nullable: true
additionalProperties: false
QueryCommentsHistorySchema:
type: object
properties:
elementIDs:
type: array
items:
type: integer
categoryvalueIDs:
type: array
items:
type: integer
zonevalueIDs:
type: array
items:
type: integer
additionalProperties: false
QueryCompanyProjectTransferSchema:
type: object
properties:
project_id:
type: integer
transfer:
type: boolean
required:
- project_id
- transfer
additionalProperties: false
QueryCompanySchema:
type: object
properties:
textid:
type: string
name:
type: string
company_id:
type: integer
x-nullable: true
logo:
type: string
x-nullable: true
max_user:
type: integer
x-nullable: true
required:
- name
- textid
additionalProperties: false
QueryCompanySchema_Edit:
type: object
properties:
name:
type: string
company_id:
type: integer
x-nullable: true
logo:
type: string
x-nullable: true
max_user:
type: integer
x-nullable: true
additionalProperties: false
QueryDocumentCropSchema:
type: object
properties:
lowerLeftX:
type: integer
lowerLeftY:
type: integer
topRightX:
type: integer
topRightY:
type: integer
additionalProperties: false
QueryDocumentSchema:
type: object
properties:
name:
type: string
type:
type: string
enum:
- PlanDrawing
- FreeDocument
department:
type: string
storey:
type: string
version:
type: string
description:
type: string
fontSize:
type: integer
strokeWidth:
type: integer
anchorSize:
type: integer
refPointA:
type: string
refPointB:
type: string
update:
type: boolean
expiration_date:
type: string
format: date-time
x-nullable: true
required:
- name
additionalProperties: false
QueryElementMarkerCopySchema:
type: object
properties:
canvas_id:
type: integer
element_id:
type: integer
additionalProperties: false
QueryElementMarkerSchema:
type: object
properties:
element_id:
type: integer
fillColor:
type: string
fontColor:
type: string
strokeColor:
type: string
fontSize:
type: integer
strokeWidth:
type: integer
anchorSize:
type: integer
opacity:
type: number
data:
type: string
name:
type: string
testorder:
type: integer
additionalProperties: false
QueryElementPresetSchema:
type: object
properties:
elementtype:
type: string
x-nullable: true
initialstate:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
actiondescription:
type: string
powerfailureactive:
type: string
enum:
- 'Null'
- Active
- Inactive
powerfailurestate:
type: string
enum:
- 'Null'
- Zero
- Matrix
- 'On'
- 'Off'
- Open
- Closed
- X
tester:
type: string
x-nullable: true
value_mask:
type: integer
x-nullable: true
is_fpc_element:
type: boolean
x-nullable: true
category_id:
type: integer
x-nullable: true
additionalProperties: false
Photo:
type: object
properties:
guid:
type: string
description:
type: string
date:
type: string
creator:
type: string
data:
type: string
x-nullable: true
required:
- description
- guid
additionalProperties: false
QueryElementSchema:
type: object
properties:
before:
type: integer
after:
type: integer
has_spacer:
type: boolean
value_mask:
type: integer
elementtype:
type: string
elementtype_comment:
type: string
elementname:
type: string
elementname_comment:
type: string
description:
type: string
description_comment:
type: string
msrl:
type: string
msrl_comment:
type: string
firealarmsystemmodule:
type: string
firealarmsystemmodule_comment:
type: string
department:
type: string
department_comment:
type: string
storey:
type: string
storey_comment:
type: string
location:
type: string
location_comment:
type: string
initialstate:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
initialstate_comment:
type: string
actiondescription:
type: string
actiondescription_comment:
type: string
powerfailureactive:
type: string
enum:
- 'Null'
- Active
- Inactive
powerfailureactive_comment:
type: string
powerfailurestate:
type: string
enum:
- 'Null'
- Zero
- Matrix
- 'On'
- 'Off'
- Open
- Closed
- X
powerfailurestate_comment:
type: string
tester:
type: string
tester_comment:
type: string
testorder:
type: integer
x-nullable: true
testorder_comment:
type: string
order:
type: integer
qr_code_id:
type: string
qr_code_raw:
type: string
elementnumber:
type: string
elementnumber_comment:
type: string
length:
type: string
length_comment:
type: string
width:
type: string
width_comment:
type: string
height:
type: string
height_comment:
type: string
status:
type: string
enum:
- 'Null'
- Intact
- Defect
- WorkInProgress
status_comment:
type: string
status_description:
type: string
status_description_comment:
type: string
next_maintenance_date:
type: string
format: date-time
x-nullable: true
next_maintenance_date_comment:
type: string
certificate_ids:
type: array
items:
type: integer
photos:
type: array
items:
$ref: '#/definitions/Photo'
element_id:
type: integer
additionalProperties: false
QueryElementZoneRelationSchema:
type: object
properties:
value:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
value_comment:
type: string
additionalProperties: false
QueryElementZonecategoryRelationSchema:
type: object
properties:
timing:
type: string
enum:
- 'Null'
- Direct
- Delayed
timing_comment:
type: string
additionalProperties: false
QueryElementcategorySchema:
type: object
properties:
name:
type: string
name_comment:
type: string
color:
type: string
before:
type: integer
after:
type: integer
additionalProperties: false
QueryFreePolygonMarkerSchema:
type: object
properties:
name:
type: string
fillColor:
type: string
fontColor:
type: string
strokeColor:
type: string
fontSize:
type: integer
strokeWidth:
type: integer
opacity:
type: number
data:
type: string
additionalProperties: false
QueryMatrixSchema:
type: object
properties:
is_fpc_matrix:
type: boolean
textid:
type: string
name:
type: string
category_id:
type: integer
revision_number:
type: integer
revision_description:
type: string
required:
- name
- textid
additionalProperties: false
QueryMatrixSchema_Edit:
type: object
properties:
name:
type: string
archive:
type: boolean
x-nullable: true
revision_number:
type: integer
revision_description:
type: string
additionalProperties: false
QueryMatrixcategorySchema:
type: object
properties:
name:
type: string
additionalProperties: false
QueryPresetSchema:
type: object
properties:
column_name:
type: string
x-nullable: true
color:
type: string
x-nullable: true
value:
type: string
x-nullable: true
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
is_fpc_category:
type: boolean
x-nullable: true
category_id:
type: integer
x-nullable: true
additionalProperties: false
QueryProjectSchema:
type: object
properties:
textid:
type: string
name:
type: string
group:
type: string
x-nullable: true
address:
type: string
x-nullable: true
postcode:
type: string
x-nullable: true
city:
type: string
x-nullable: true
country:
type: string
x-nullable: true
remarks:
type: string
x-nullable: true
foreign_id:
type: string
x-nullable: true
transfer_to_companyID:
type: integer
x-nullable: true
company_id:
type: integer
x-nullable: true
is_template:
type: boolean
x-nullable: true
required:
- name
- textid
additionalProperties: false
QueryProjectSchema_Edit:
type: object
properties:
name:
type: string
x-nullable: true
group:
type: string
x-nullable: true
address:
type: string
x-nullable: true
postcode:
type: string
x-nullable: true
city:
type: string
x-nullable: true
country:
type: string
x-nullable: true
remarks:
type: string
x-nullable: true
foreign_id:
type: string
x-nullable: true
transfer_to_companyID:
type: integer
x-nullable: true
is_template:
type: boolean
x-nullable: true
additionalProperties: false
QueryPublicProjectSchema_Edit:
type: object
properties:
is_public:
type: boolean
x-nullable: true
additionalProperties: false
QuerySyncCacheSchema:
type: object
properties:
cache:
x-nullable: true
additionalProperties: false
QuerySystemSchema:
type: object
properties:
message:
type: string
nullable: true
messageActive:
type: boolean
additionalProperties: false
QueryTestParticipantSchema:
type: object
properties:
first_name:
type: string
x-nullable: true
last_name:
type: string
x-nullable: true
company_name:
type: string
x-nullable: true
department:
type: string
x-nullable: true
phone:
type: string
x-nullable: true
email:
type: string
format: email
x-nullable: true
tester:
type: string
x-nullable: true
role:
type: string
enum:
- Observer
- Tester
- GroupLeader
- TestLeader
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
additionalProperties: false
QueryTestSchema:
type: object
properties:
name:
type: string
summary:
type: string
x-nullable: true
editor:
type: string
x-nullable: true
matrix_ids:
type: array
items:
type: integer
checkset_ids:
type: array
items:
type: integer
current_agenda_id:
type: integer
current_agenda_phase:
type: string
enum:
- 'Null'
- PrepareSimple
- PrepareComplex
- InProgress
- Reset
agenda_completed:
type: boolean
blind:
type: boolean
x-nullable: true
add_tryout_checkset_id:
type: integer
x-nullable: true
remove_tryout_checkset_id:
type: integer
x-nullable: true
additionalProperties: false
QueryTextMarkerSchema:
type: object
properties:
text:
type: string
fillColor:
type: string
fontColor:
type: string
strokeColor:
type: string
fontSize:
type: integer
strokeWidth:
type: integer
opacity:
type: number
data:
type: string
for_element:
type: boolean
for_zone:
type: boolean
additionalProperties: false
QueryUrlSchema:
type: object
properties:
participant_id:
type: integer
additionalProperties: false
QueryUserProjectRelationSchema:
type: object
properties:
user_id:
type: integer
project_id:
type: integer
role:
type: string
enum:
- 'Null'
- Tester
- Editor
- ProjectAdmin
- CompanyAdmin
- SystemAdmin
modules:
type: array
items:
type: string
x-nullable: true
expiry_date:
type: integer
x-nullable: true
additionalProperties: false
QueryUserSchema:
type: object
properties:
email:
type: string
format: email
first_name:
type: string
last_name:
type: string
modules:
type: array
items:
type: string
x-nullable: true
is_blocked:
type: boolean
additionalProperties: false
QueryUserSchema_Authenticate:
type: object
properties:
password:
type: string
email:
type: string
format: email
required:
- email
- password
additionalProperties: false
QueryUserSchema_Edit:
type: object
properties:
password:
type: string
first_name:
type: string
last_name:
type: string
role:
type: string
enum:
- 'Null'
- Tester
- Editor
- ProjectAdmin
- CompanyAdmin
- SystemAdmin
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
company_id:
type: integer
x-nullable: true
is_blocked:
type: boolean
expiry_date:
type: integer
x-nullable: true
show_history:
type: boolean
show_statusbar:
type: boolean
favorite_object_ids:
type: string
x-nullable: true
modules:
type: array
items:
type: string
x-nullable: true
additionalProperties: false
QueryUserSchema_Reset:
type: object
properties:
email:
type: string
format: email
password:
type: string
x-nullable: true
required:
- email
additionalProperties: false
QueryUserSchema_Signup:
type: object
properties:
email:
type: string
format: email
first_name:
type: string
last_name:
type: string
role:
type: string
enum:
- 'Null'
- Tester
- Editor
- ProjectAdmin
- CompanyAdmin
- SystemAdmin
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
company_id:
type: integer
x-nullable: true
expiry_date:
type: integer
x-nullable: true
is_blocked:
type: boolean
show_history:
type: boolean
show_statusbar:
type: boolean
modules:
type: array
items:
type: string
x-nullable: true
additionalProperties: false
QueryZoneMarkerCopySchema:
type: object
properties:
canvas_id:
type: integer
name:
type: string
additionalProperties: false
QueryZoneMarkerSchema:
type: object
properties:
name:
type: string
fillColor:
type: string
fontColor:
type: string
strokeColor:
type: string
fontSize:
type: integer
strokeWidth:
type: integer
opacity:
type: number
data:
type: string
additionalProperties: false
QueryZoneSchema:
type: object
properties:
name:
type: string
name_comment:
type: string
before:
type: integer
after:
type: integer
additionalProperties: false
QueryZonecategorySchema:
type: object
properties:
name:
type: string
name_comment:
type: string
color:
type: string
before:
type: integer
after:
type: integer
additionalProperties: false
ResponseAgendaSchema:
type: object
properties:
checksets:
readOnly: true
test_status:
readOnly: true
id:
type: integer
start:
type: string
format: date-time
x-nullable: true
end:
type: string
format: date-time
x-nullable: true
description:
type: string
x-nullable: true
instruction:
type: string
x-nullable: true
fixed_start:
type: boolean
x-nullable: true
can_prepare_simple:
type: boolean
x-nullable: true
can_prepare_complex:
type: boolean
x-nullable: true
can_in_progress:
type: boolean
x-nullable: true
can_reset:
type: boolean
x-nullable: true
prepare_activated:
type: integer
x-nullable: true
progress_activated:
type: integer
x-nullable: true
reset_activated:
type: integer
x-nullable: true
group_name_spacer:
type: string
maxLength: 160
x-nullable: true
test_id:
type: integer
required:
- test_id
additionalProperties: false
ZoneMarker:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
maxLength: 10000000
x-nullable: true
canvas_id:
type: integer
required:
- canvas_id
additionalProperties: false
ElementMarker:
type: object
properties:
id:
type: integer
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
anchorSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
x-nullable: true
canvas_id:
type: integer
element_id:
type: integer
required:
- canvas_id
- element_id
additionalProperties: false
TextMarker:
type: object
properties:
id:
type: integer
text:
type: string
x-nullable: true
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
x-nullable: true
for_element:
type: boolean
x-nullable: true
for_zone:
type: boolean
x-nullable: true
canvas_id:
type: integer
required:
- canvas_id
additionalProperties: false
FreePolygonMarker:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
maxLength: 10000000
x-nullable: true
canvas_id:
type: integer
required:
- canvas_id
additionalProperties: false
ResponseCanvasSchema:
type: object
properties:
zoneMarkers:
type: array
items:
$ref: '#/definitions/ZoneMarker'
elementMarkers:
type: array
items:
$ref: '#/definitions/ElementMarker'
textMarkers:
type: array
items:
$ref: '#/definitions/TextMarker'
freePolygonMarkers:
type: array
items:
$ref: '#/definitions/FreePolygonMarker'
zoneNames:
readOnly: true
matrix_name:
readOnly: true
matrix_version:
readOnly: true
editable:
readOnly: true
id:
type: integer
matrix_id:
type: integer
document_id:
type: integer
legend_data:
x-nullable: true
required:
- document_id
- matrix_id
additionalProperties: false
ResponseCanvasSlimSchema:
type: object
properties:
id:
type: integer
matrix_id:
type: integer
document_id:
type: integer
legend_data:
x-nullable: true
required:
- document_id
- matrix_id
additionalProperties: false
Creator:
type: object
properties:
email:
type: string
maxLength: 160
first_name:
type: string
maxLength: 160
x-nullable: true
id:
type: integer
last_name:
type: string
maxLength: 160
x-nullable: true
is_deleted:
type: boolean
x-nullable: true
required:
- email
additionalProperties: false
ResponseCertificateSchema:
type: object
properties:
creator:
$ref: '#/definitions/Creator'
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
description:
type: string
x-nullable: true
expiration_date:
type: string
format: date-time
x-nullable: true
approval_number:
type: string
maxLength: 160
x-nullable: true
manufacturer:
type: string
maxLength: 160
x-nullable: true
product_name:
type: string
maxLength: 160
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
required:
- creator_id
- project_id
additionalProperties: false
ResponseCheckSchema:
type: object
properties:
before_test_result:
type: string
enum:
- 'Null'
- Active
- Inactive
result:
type: string
enum:
- 'Null'
- Active
- Inactive
id:
type: integer
date:
type: string
format: date-time
x-nullable: true
comment_before:
type: string
x-nullable: true
comment_test:
type: string
x-nullable: true
comment_after:
type: string
x-nullable: true
is_ready:
type: boolean
x-nullable: true
is_complete:
type: boolean
x-nullable: true
is_reset:
type: boolean
x-nullable: true
assigned:
type: boolean
x-nullable: true
element_id:
type: integer
checkset_id:
type: integer
test_id:
type: integer
participant_id:
type: integer
x-nullable: true
required:
- checkset_id
- element_id
- test_id
additionalProperties: false
ResponseChecksetCommentSchema:
type: object
properties:
creator:
readOnly: true
tester:
type: string
maxLength: 160
x-nullable: true
test_id:
type: integer
checkset_id:
type: integer
user_id:
type: integer
x-nullable: true
participant_id:
type: integer
x-nullable: true
id:
type: integer
date:
type: string
format: date-time
x-nullable: true
comment:
type: string
x-nullable: true
required:
- checkset_id
- test_id
additionalProperties: false
Zone:
type: object
properties:
category_name:
readOnly: true
category_color:
readOnly: true
category_order:
readOnly: true
scenarios:
readOnly: true
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
order:
type: integer
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
name_comment:
type: string
x-nullable: true
category_id:
type: integer
required:
- category_id
additionalProperties: false
ResponseChecksetSchema:
type: object
properties:
comments:
type: array
items:
$ref: '#/definitions/ResponseChecksetCommentSchema'
matrix_name:
readOnly: true
zone:
$ref: '#/definitions/Zone'
id:
type: integer
ssv:
type: boolean
x-nullable: true
scenario_number:
type: integer
x-nullable: true
zone_id:
type: integer
matrix_id:
type: integer
x-nullable: true
required:
- zone_id
additionalProperties: false
ResponseCommenterSchema:
type: object
properties:
id:
type: integer
email:
type: string
format: email
first_name:
type: string
last_name:
type: string
additionalProperties: false
ResponseCompanySchema:
type: object
properties:
projects:
readOnly: true
transfer_in_projects:
readOnly: true
logo:
readOnly: true
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
company_id:
type: integer
x-nullable: true
max_user:
type: integer
x-nullable: true
creator_id:
type: integer
required:
- creator_id
additionalProperties: false
ResponseCompanySlimSchema:
type: object
properties:
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
company_id:
type: integer
x-nullable: true
max_user:
type: integer
x-nullable: true
additionalProperties: false
ResponseCompanySlimWithLogoSchema:
type: object
properties:
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
company_id:
type: integer
x-nullable: true
max_user:
type: integer
x-nullable: true
logo:
type: string
x-nullable: true
additionalProperties: false
ResponseCreatorSchema:
type: object
properties:
email:
type: string
maxLength: 160
first_name:
type: string
maxLength: 160
x-nullable: true
id:
type: integer
last_name:
type: string
maxLength: 160
x-nullable: true
is_deleted:
type: boolean
x-nullable: true
required:
- email
additionalProperties: false
ResponseDocumentSchema:
type: object
properties:
type:
type: string
enum:
- PlanDrawing
- FreeDocument
creator:
$ref: '#/definitions/ResponseCreatorSchema'
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
guid:
type: string
maxLength: 160
x-nullable: true
ref_id:
type: string
maxLength: 160
x-nullable: true
date:
type: string
format: date-time
x-nullable: true
width:
type: integer
x-nullable: true
height:
type: integer
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
anchorSize:
type: integer
x-nullable: true
refPointA:
type: string
maxLength: 160
x-nullable: true
refPointB:
type: string
maxLength: 160
x-nullable: true
frameData:
type: string
maxLength: 10000000
x-nullable: true
department:
type: string
maxLength: 160
x-nullable: true
storey:
type: string
maxLength: 160
x-nullable: true
version:
type: string
maxLength: 160
x-nullable: true
description:
type: string
x-nullable: true
expiration_date:
type: string
format: date-time
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
required:
- creator_id
- project_id
additionalProperties: false
ResponseElementMarkerSchema:
type: object
properties:
id:
type: integer
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
anchorSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
x-nullable: true
canvas_id:
type: integer
element_id:
type: integer
required:
- canvas_id
- element_id
additionalProperties: false
ResponseElementPresetSchema:
type: object
properties:
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
initialstate:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
powerfailurestate:
type: string
enum:
- 'Null'
- Zero
- Matrix
- 'On'
- 'Off'
- Open
- Closed
- X
powerfailureactive:
type: string
enum:
- 'Null'
- Active
- Inactive
id:
type: integer
elementtype:
type: string
maxLength: 160
x-nullable: true
actiondescription:
type: string
maxLength: 500
x-nullable: true
tester:
type: string
maxLength: 160
x-nullable: true
value_mask:
type: integer
x-nullable: true
is_fpc_element:
type: boolean
x-nullable: true
category_id:
type: integer
x-nullable: true
additionalProperties: false
ElementZoneRelation:
type: object
properties:
value:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
id:
type: integer
value_comment:
type: string
x-nullable: true
element_id:
type: integer
x-nullable: true
zone_id:
type: integer
x-nullable: true
additionalProperties: false
ElementZonecategoryRelation:
type: object
properties:
timing:
type: string
enum:
- 'Null'
- Direct
- Delayed
id:
type: integer
timing_comment:
type: string
x-nullable: true
element_id:
type: integer
x-nullable: true
zonecategory_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseElementSchema:
type: object
properties:
initialstate:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
powerfailureactive:
type: string
enum:
- 'Null'
- Active
- Inactive
powerfailurestate:
type: string
enum:
- 'Null'
- Zero
- Matrix
- 'On'
- 'Off'
- Open
- Closed
- X
status:
type: string
enum:
- 'Null'
- Intact
- Defect
- WorkInProgress
zone_values:
type: array
items:
$ref: '#/definitions/ElementZoneRelation'
zonecategory_values:
type: array
items:
$ref: '#/definitions/ElementZonecategoryRelation'
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
version:
type: integer
x-nullable: true
order:
type: integer
x-nullable: true
has_spacer:
type: boolean
x-nullable: true
value_mask:
type: integer
x-nullable: true
elementtype:
type: string
maxLength: 160
x-nullable: true
elementtype_comment:
type: string
x-nullable: true
elementname:
type: string
maxLength: 160
x-nullable: true
elementname_comment:
type: string
x-nullable: true
description:
type: string
maxLength: 500
x-nullable: true
description_comment:
type: string
x-nullable: true
msrl:
type: string
maxLength: 160
x-nullable: true
msrl_comment:
type: string
x-nullable: true
firealarmsystemmodule:
type: string
maxLength: 160
x-nullable: true
firealarmsystemmodule_comment:
type: string
x-nullable: true
department:
type: string
maxLength: 160
x-nullable: true
department_comment:
type: string
x-nullable: true
storey:
type: string
maxLength: 160
x-nullable: true
storey_comment:
type: string
x-nullable: true
location:
type: string
maxLength: 160
x-nullable: true
location_comment:
type: string
x-nullable: true
initialstate_comment:
type: string
x-nullable: true
actiondescription:
type: string
maxLength: 500
x-nullable: true
actiondescription_comment:
type: string
x-nullable: true
powerfailureactive_comment:
type: string
x-nullable: true
powerfailurestate_comment:
type: string
x-nullable: true
tester:
type: string
maxLength: 160
x-nullable: true
tester_comment:
type: string
x-nullable: true
testorder:
type: integer
x-nullable: true
testorder_comment:
type: string
x-nullable: true
category_id:
type: integer
x-nullable: true
qr_code_id:
type: string
maxLength: 36
x-nullable: true
qr_code_raw:
type: string
x-nullable: true
elementnumber:
type: string
maxLength: 160
x-nullable: true
elementnumber_comment:
type: string
x-nullable: true
length:
type: string
maxLength: 160
x-nullable: true
length_comment:
type: string
x-nullable: true
width:
type: string
maxLength: 160
x-nullable: true
width_comment:
type: string
x-nullable: true
height:
type: string
maxLength: 160
x-nullable: true
height_comment:
type: string
x-nullable: true
status_comment:
type: string
x-nullable: true
status_description:
type: string
x-nullable: true
status_description_comment:
type: string
x-nullable: true
next_maintenance_date:
type: string
format: date-time
x-nullable: true
next_maintenance_date_comment:
type: string
x-nullable: true
certificate_ids:
x-nullable: true
photos:
x-nullable: true
element_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseElementZoneRelationSchema:
type: object
properties:
value:
type: string
enum:
- 'Null'
- Zero
- 'On'
- 'Off'
- Open
- Closed
- X
id:
type: integer
value_comment:
type: string
x-nullable: true
element_id:
type: integer
x-nullable: true
zone_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseElementZonecategoryRelationSchema:
type: object
properties:
timing:
type: string
enum:
- 'Null'
- Direct
- Delayed
id:
type: integer
timing_comment:
type: string
x-nullable: true
element_id:
type: integer
x-nullable: true
zonecategory_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseElementcategorySchema:
type: object
properties:
elements:
type: array
items:
$ref: '#/definitions/ResponseElementSchema'
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
order:
type: integer
x-nullable: true
color:
type: string
maxLength: 20
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
name_comment:
type: string
x-nullable: true
matrix_id:
type: integer
required:
- matrix_id
additionalProperties: false
ResponseExternalUserSchema:
type: object
properties:
company_name:
readOnly: true
parentcompany_id:
readOnly: true
id:
type: integer
email:
type: string
maxLength: 160
first_name:
type: string
maxLength: 160
x-nullable: true
last_name:
type: string
maxLength: 160
x-nullable: true
is_blocked:
type: boolean
x-nullable: true
is_deleted:
type: boolean
x-nullable: true
expiry_date:
type: string
format: date-time
x-nullable: true
favorite_object_ids:
type: string
x-nullable: true
modules:
type: string
x-nullable: true
company_id:
type: integer
x-nullable: true
required:
- email
additionalProperties: false
ResponseFreePolygonMarkerSchema:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
maxLength: 10000000
x-nullable: true
canvas_id:
type: integer
required:
- canvas_id
additionalProperties: false
ResponseMatrixSchema:
type: object
properties:
creator:
$ref: '#/definitions/ResponseCreatorSchema'
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
frozen_date:
type: string
format: date-time
x-nullable: true
archive_date:
type: string
format: date-time
x-nullable: true
revision_number:
type: integer
x-nullable: true
revision_description:
type: string
x-nullable: true
is_fpc_matrix:
type: boolean
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
matrix_id:
type: integer
x-nullable: true
category_id:
type: integer
x-nullable: true
required:
- creator_id
- project_id
additionalProperties: false
Zonecategory:
type: object
properties:
zones:
type: array
items:
$ref: '#/definitions/Zone'
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
order:
type: integer
x-nullable: true
color:
type: string
maxLength: 20
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
name_comment:
type: string
x-nullable: true
matrix_id:
type: integer
required:
- matrix_id
additionalProperties: false
ResponseMatrixSchema_Table:
type: object
properties:
elementcategories:
type: array
items:
$ref: '#/definitions/ResponseElementcategorySchema'
zonecategories:
type: array
items:
$ref: '#/definitions/Zonecategory'
creator:
$ref: '#/definitions/ResponseCreatorSchema'
canvas_infos:
readOnly: true
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
frozen_date:
type: string
format: date-time
x-nullable: true
archive_date:
type: string
format: date-time
x-nullable: true
revision_number:
type: integer
x-nullable: true
revision_description:
type: string
x-nullable: true
is_fpc_matrix:
type: boolean
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
matrix_id:
type: integer
x-nullable: true
category_id:
type: integer
x-nullable: true
required:
- creator_id
- project_id
additionalProperties: false
ResponseMatrixcategorySchema:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
additionalProperties: false
ResponsePresetSchema:
type: object
properties:
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
id:
type: integer
column_name:
type: string
maxLength: 160
x-nullable: true
color:
type: string
maxLength: 160
x-nullable: true
value:
type: string
maxLength: 160
x-nullable: true
is_fpc_category:
type: boolean
x-nullable: true
category_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseProjectExternalUserSchema:
type: object
properties:
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
group:
type: string
maxLength: 160
x-nullable: true
address:
type: string
maxLength: 160
x-nullable: true
postcode:
type: string
maxLength: 160
x-nullable: true
city:
type: string
maxLength: 160
x-nullable: true
country:
type: string
maxLength: 160
x-nullable: true
remarks:
type: string
maxLength: 260
x-nullable: true
foreign_id:
type: string
maxLength: 160
x-nullable: true
transfer_to_companyID:
type: integer
x-nullable: true
is_public:
type: boolean
x-nullable: true
is_template:
type: boolean
x-nullable: true
company_id:
type: integer
creator_id:
type: integer
required:
- company_id
- creator_id
additionalProperties: false
TestSlim:
type: object
properties:
creator:
$ref: '#/definitions/ResponseCreatorSchema'
current_agenda_phase:
type: string
enum:
- 'Null'
- PrepareSimple
- PrepareComplex
- InProgress
- Reset
checksets:
readOnly: true
tryout_checkset_ids:
readOnly: true
testmatrixrelations:
readOnly: true
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
date:
type: string
format: date-time
x-nullable: true
frozen_date:
type: string
format: date-time
x-nullable: true
summary:
type: string
x-nullable: true
editor:
type: string
maxLength: 160
x-nullable: true
current_agenda_id:
type: integer
x-nullable: true
agenda_completed:
type: boolean
x-nullable: true
agenda_etag:
type: string
maxLength: 160
x-nullable: true
check_etag:
type: string
maxLength: 160
x-nullable: true
chat_etag:
type: string
maxLength: 160
x-nullable: true
blind:
type: boolean
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
required:
- creator_id
- project_id
additionalProperties: false
ResponseProjectSchema:
type: object
properties:
matrices:
readOnly: true
tests:
type: array
items:
$ref: '#/definitions/TestSlim'
documents:
type: array
items:
$ref: '#/definitions/ResponseDocumentSchema'
company_name:
readOnly: true
company_textid:
readOnly: true
parent_company_id:
readOnly: true
canvases:
readOnly: true
external_users:
readOnly: true
storey_departments:
readOnly: true
certificates:
type: array
items:
$ref: '#/definitions/ResponseCertificateSchema'
my_modules:
readOnly: true
id:
type: integer
textid:
type: string
maxLength: 160
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
group:
type: string
maxLength: 160
x-nullable: true
address:
type: string
maxLength: 160
x-nullable: true
postcode:
type: string
maxLength: 160
x-nullable: true
city:
type: string
maxLength: 160
x-nullable: true
country:
type: string
maxLength: 160
x-nullable: true
remarks:
type: string
maxLength: 260
x-nullable: true
foreign_id:
type: string
maxLength: 160
x-nullable: true
transfer_to_companyID:
type: integer
x-nullable: true
is_public:
type: boolean
x-nullable: true
is_template:
type: boolean
x-nullable: true
company_id:
type: integer
creator_id:
type: integer
required:
- company_id
- creator_id
additionalProperties: false
ResponseSystemSchema:
type: object
properties:
id:
type: integer
message:
type: string
x-nullable: true
messageActive:
type: boolean
x-nullable: true
additionalProperties: false
ResponseTestCommentSchema:
type: object
properties:
creator:
readOnly: true
test_id:
type: integer
user_id:
type: integer
x-nullable: true
participant_id:
type: integer
x-nullable: true
id:
type: integer
date:
type: string
format: date-time
x-nullable: true
comment:
type: string
x-nullable: true
required:
- test_id
additionalProperties: false
ResponseTestMatrixRelationSchema:
type: object
properties:
id:
type: integer
matrix_number:
type: integer
x-nullable: true
test_id:
type: integer
x-nullable: true
matrix_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseTestParticipantSchema:
type: object
properties:
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
role:
type: string
enum:
- Observer
- Tester
- GroupLeader
- TestLeader
role_level:
readOnly: true
id:
type: integer
first_name:
type: string
maxLength: 160
x-nullable: true
last_name:
type: string
maxLength: 160
x-nullable: true
company_name:
type: string
maxLength: 160
x-nullable: true
department:
type: string
maxLength: 160
x-nullable: true
phone:
type: string
maxLength: 160
x-nullable: true
email:
type: string
maxLength: 160
x-nullable: true
tester:
type: string
maxLength: 160
x-nullable: true
order:
type: integer
x-nullable: true
test_id:
type: integer
project_id:
type: integer
x-nullable: true
required:
- test_id
additionalProperties: false
ResponseTestSchema:
type: object
properties:
creator:
$ref: '#/definitions/ResponseCreatorSchema'
current_agenda_phase:
type: string
enum:
- 'Null'
- PrepareSimple
- PrepareComplex
- InProgress
- Reset
comments:
type: array
items:
$ref: '#/definitions/ResponseTestCommentSchema'
agendas:
type: array
items:
$ref: '#/definitions/ResponseAgendaSchema'
checksets:
readOnly: true
tryout_checkset_ids:
readOnly: true
testmatrixrelations:
readOnly: true
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
date:
type: string
format: date-time
x-nullable: true
frozen_date:
type: string
format: date-time
x-nullable: true
summary:
type: string
x-nullable: true
editor:
type: string
maxLength: 160
x-nullable: true
current_agenda_id:
type: integer
x-nullable: true
agenda_completed:
type: boolean
x-nullable: true
agenda_etag:
type: string
maxLength: 160
x-nullable: true
check_etag:
type: string
maxLength: 160
x-nullable: true
chat_etag:
type: string
maxLength: 160
x-nullable: true
blind:
type: boolean
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
required:
- creator_id
- project_id
additionalProperties: false
ResponseTestSlimSchema:
type: object
properties:
creator:
$ref: '#/definitions/ResponseCreatorSchema'
current_agenda_phase:
type: string
enum:
- 'Null'
- PrepareSimple
- PrepareComplex
- InProgress
- Reset
checksets:
readOnly: true
tryout_checkset_ids:
readOnly: true
testmatrixrelations:
readOnly: true
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
date:
type: string
format: date-time
x-nullable: true
frozen_date:
type: string
format: date-time
x-nullable: true
summary:
type: string
x-nullable: true
editor:
type: string
maxLength: 160
x-nullable: true
current_agenda_id:
type: integer
x-nullable: true
agenda_completed:
type: boolean
x-nullable: true
agenda_etag:
type: string
maxLength: 160
x-nullable: true
check_etag:
type: string
maxLength: 160
x-nullable: true
chat_etag:
type: string
maxLength: 160
x-nullable: true
blind:
type: boolean
x-nullable: true
project_id:
type: integer
creator_id:
type: integer
required:
- creator_id
- project_id
additionalProperties: false
ResponseTextMarkerSchema:
type: object
properties:
id:
type: integer
text:
type: string
x-nullable: true
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
x-nullable: true
for_element:
type: boolean
x-nullable: true
for_zone:
type: boolean
x-nullable: true
canvas_id:
type: integer
required:
- canvas_id
additionalProperties: false
ResponseUrlSchema:
type: object
properties:
id:
type: integer
short_url:
type: string
maxLength: 10
x-nullable: true
participant_id:
type: integer
x-nullable: true
additionalProperties: false
ResponseUserProjectRelationSchema:
type: object
properties:
role:
type: string
enum:
- 'Null'
- Tester
- Editor
- ProjectAdmin
- CompanyAdmin
- SystemAdmin
user:
$ref: '#/definitions/ResponseExternalUserSchema'
project:
$ref: '#/definitions/ResponseProjectExternalUserSchema'
modules:
readOnly: true
expired:
readOnly: true
id:
type: integer
expiry_date:
type: string
format: date-time
x-nullable: true
additionalProperties: false
ResponseUserSchema:
type: object
properties:
role:
type: string
enum:
- 'Null'
- Tester
- Editor
- ProjectAdmin
- CompanyAdmin
- SystemAdmin
language:
type: string
enum:
- 'Null'
- English
- German
- French
- Italian
external_projects:
readOnly: true
company_name:
readOnly: true
company_textid:
readOnly: true
parentcompany_id:
readOnly: true
expired:
readOnly: true
is_sso:
readOnly: true
modules:
readOnly: true
effective_modules:
readOnly: true
id:
type: integer
email:
type: string
maxLength: 160
first_name:
type: string
maxLength: 160
x-nullable: true
last_name:
type: string
maxLength: 160
x-nullable: true
is_blocked:
type: boolean
x-nullable: true
is_deleted:
type: boolean
x-nullable: true
expiry_date:
type: string
format: date-time
x-nullable: true
show_history:
type: boolean
x-nullable: true
show_statusbar:
type: boolean
x-nullable: true
favorite_object_ids:
type: string
x-nullable: true
company_id:
type: integer
x-nullable: true
required:
- email
additionalProperties: false
ResponseZoneMarkerSchema:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 160
x-nullable: true
fillColor:
type: string
maxLength: 160
x-nullable: true
fontColor:
type: string
maxLength: 160
x-nullable: true
fontSize:
type: integer
x-nullable: true
strokeColor:
type: string
maxLength: 160
x-nullable: true
strokeWidth:
type: integer
x-nullable: true
opacity:
type: number
x-nullable: true
data:
type: string
maxLength: 10000000
x-nullable: true
canvas_id:
type: integer
required:
- canvas_id
additionalProperties: false
ResponseZoneSchema:
type: object
properties:
category_name:
readOnly: true
category_color:
readOnly: true
category_order:
readOnly: true
scenarios:
readOnly: true
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
order:
type: integer
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
name_comment:
type: string
x-nullable: true
category_id:
type: integer
required:
- category_id
additionalProperties: false
ResponseZonecategorySchema:
type: object
properties:
zones:
type: array
items:
$ref: '#/definitions/ResponseZoneSchema'
id:
type: integer
guid:
type: string
maxLength: 36
x-nullable: true
order:
type: integer
x-nullable: true
color:
type: string
maxLength: 20
x-nullable: true
name:
type: string
maxLength: 160
x-nullable: true
name_comment:
type: string
x-nullable: true
matrix_id:
type: integer
required:
- matrix_id
additionalProperties: false