logo
Documentation Powered by Redocly

Journal API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

The journal service implements all journal functions for GroupAlarm

Authentication

API_Token

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

Personal-Access-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

categories

Returns a list of categories for the given organization.

When given limit and offset parameters, output is limited to those values.

query Parameters
organization_id
required
integer
limit
integer [ 1 .. 50 ]
Default: 10

limits paginated output to passed amount

offset
integer >= 0
Default: 0

defines the offset for pagination

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateCategory

Creates a new category

Request Body schema: application/json
description
string
id
integer <int64>
name
required
string
organizationId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationId": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationId": 0
}

GetCategory

Returns requested category

path Parameters
categoryID
required
integer

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationId": 0
}

UpdateCategory

Updates an existing category

path Parameters
categoryID
required
integer
Request Body schema: application/json
description
string
id
integer <int64>
name
required
string
organizationId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationId": 0
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "organizationId": 0
}

DeleteCategory

Deletes an existing category

path Parameters
categoryID
required
integer

Responses

journals

GetJournal

Returns the requested journal including all entries with pagination

query Parameters
organization_id
integer

use this parameter to query the journal of the given organization

event_id
integer

use this parameter to query the journal of the given event

limit
integer [ 1 .. 50 ]
Default: 10

limits paginated output to passed amount

offset
integer >= 0
Default: 0

defines the offset for pagination

all
boolean
Default: false

returns all entries, ignoring limit and offset parameters

Responses

Response samples

Content type
application/json
{
  • "closed": true,
  • "entryList": {
    },
  • "eventId": 0,
  • "id": 0,
  • "locked": {
    },
  • "organizationId": 0
}

LockJournal

Locks an existing journal

path Parameters
journalID
required
integer

Responses

UnlockJournal

Unlocks an existing journal

path Parameters
journalID
required
integer

Responses

entries

CreateEntry

Creates a new entry in an existing journal

path Parameters
journalID
required
integer
Request Body schema: application/json
attachment
string
categoryId
required
integer <int64>
customTime
any
journalId
required
integer <int64>
location
string
text
required
string

Responses

Request samples

Content type
application/json
{
  • "attachment": "string",
  • "categoryId": 0,
  • "customTime": null,
  • "journalId": 0,
  • "location": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "attachment": "string",
  • "category": {
    },
  • "created": {
    },
  • "deleted": {
    },
  • "id": 0,
  • "journalId": 0,
  • "location": "string",
  • "serialNumber": 0,
  • "text": "string"
}

DeleteEntry

Deletes an existing journal entry

path Parameters
journalID
required
integer
entryID
required
integer

Responses