Download OpenAPI specification:Download
The journal service implements all journal functions for GroupAlarm
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-TOKEN |
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Personal-Access-Token |
Returns created categories
organization_id required | int64 |
all created categories
no or invalid organization_id in request
unauthorized user
unexpected database error
[- {
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationId": 0
}
]
Creates a new category
description required | string |
id | integer <int64> |
name required | string |
organizationId required | integer <int64> |
category created
no or invalid category in request
unauthorized user
unexpected database error
{- "description": "string",
- "id": 0,
- "name": "string",
- "organizationId": 0
}
Returns requested category
categoryID required | int64 |
requested categories
no or invalid categoryID in request
unauthorized user
category not found
unexpected database error
{- "description": "string",
- "id": 0,
- "name": "string",
- "organizationId": 0
}
Updates an existing category
categoryID required | int64 |
description required | string |
id | integer <int64> |
name required | string |
organizationId required | integer <int64> |
category updated
no or invalid category in request
unauthorized user
unexpected database error
{- "description": "string",
- "id": 0,
- "name": "string",
- "organizationId": 0
}
Deletes an existing category
categoryID required | int64 |
category updated
no or invalid category in request
unauthorized user
category already used, can not delete
unexpected database error
Returns the requested journal including all entries with pagination
organization_id | int64 add this parameter to query the journal of the given organization |
event_id | int64 add this parameter to query the journal of the given event |
limit | int64 [ 1 .. 50 ] Default: 10 limits paginated output to passed amount |
offset | int64 >= 0 Default: 0 defines the offset for pagination |
requested journal
no or invalid organization_id / event_id in request
unauthorized user
unexpected database error
{- "closed": true,
- "entryList": {
- "entries": [
- {
- "attachment": "string",
- "category": {
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationId": 0
}, - "created": {
- "time": "2021-03-03T10:35:31Z",
- "timeCustom": "2021-03-03T10:35:31Z",
- "userId": 0
}, - "deleted": {
- "time": "2021-03-03T10:35:31Z",
- "userId": 0
}, - "id": 0,
- "journalId": 0,
- "location": "string",
- "serialNumber": 0,
- "text": "string"
}
], - "totalEntries": 0
}, - "eventId": 0,
- "id": 0,
- "locked": {
- "time": "2021-03-03T10:35:31Z",
- "userId": 0
}, - "organizationId": 0
}
Locks an existing journal
journalID required | int64 |
journal locked
no or invalid journalID in request
unauthorized user
journal already locked or closed
unexpected database error
Unlocks an existing journal
journalID required | int64 |
journal unlocked
no or invalid journalID in request
unauthorized user
journal not locked or locked by other user or closed
unexpected database error
Creates a new entry in an existing journal
journalID required | int64 |
attachment | string |
categoryId required | integer <int64> |
customTime | string <date-time> |
journalId required | integer <int64> |
location | string |
text required | string |
entry created
no or invalid journalID / entry in request
unauthorized user
journal not locked or locked by other user
unexpected database error
{- "attachment": "string",
- "categoryId": 0,
- "customTime": "2021-03-03T10:35:31Z",
- "journalId": 0,
- "location": "string",
- "text": "string"
}
Deletes an existing journal entry
journalID required | int64 |
entryID required | int64 |
entry deleted
no or invalid journalID / entryID in request
unauthorized user
journal not locked or locked by other user
unexpected database error