Entry

Name	Type	Description
`id`	int	Unique ID of the entry. If the ID is negative, a temporary identification number was created for the attribute types `no_db` and `exec_response`
`attribute`	Attribute	Attrbute belonging to the entry
`date_time`	dateTime	Date and time for the entry in the client time zone
`date_time_execution`	dateTime, RO	Date and time of the execution. This time will be determined by the given `execution_offset` of the token
`parameter`	string	Deprecated: The parameter. Use `parameters` insted
`parameter_preset`	string	Deprecated: The name of a predefined parameter to which the attribute belongs too. This does override the field `parameter`. Use `parameters.value` instead with the presets name
`creator`	int, RO	ID of the token which created the entry
`creation_time`	dateTime, RO	Creation time of the entry
`parameters`	Parameter[]	An array with all parameter values for the entry

Parameter

Parameter contains the value of a specific command line argument when looking at an entry from an execution view. See AttributeParameter for more details.

A parameter has the following properties.

Name	Type	Description
`parameter_id`	int	Parameter reference of the attribute. When this field is missing for all `parameters[]`, the ID is obtained by matching the parameters position with the index of the provided array
`value`	string	Value of the parameter or the name of a predefined parameter preset
`preset`	string	Name of the paremter preset to use. This does override the `value` property if set

(Offset-) Pattern

Besides the specification of the date_time according to the ISO-8601 (without TZ) format, a offset_pattern and offset can also be used when creating, updating or deleting an entry. The "syntax" and the rules of these patterns should be explained in the following.

Offset

Within the offset field an "offset" to the real time can be specified. This value has to be positiv, an Integer number and should be followed by a time unit like s, m, h or d. When no unit was given, seconds are used.
You can also specify now.

The following additional field can be set in the request parameters to adjust the behaviour of the offset.

Name	Type	Description
`full_minutes`	bool, optional	Set the seconds to zero in the time when using an offset [Default: false]
`keep_date_on_overflow`	bool, optional	The date will be keept present when the offset of the time "flows over" the day → the date will be kept [Default: false]

Offset Pattern

Within the field offset_pattern a given pattern containing an offset will be replaced with the correspondending date and time. The offset can either be:

positiv → +20
negative → /20

The offset can be present on all fields (e.g. year, day, hour, ...). The unit of the coresspondending field will be used.

2021-01-01T+20:00:00
+0-+1-+0T/5:00:+20

The offset_pattern can also be a calendar week with two digits (DE and EN):

Example	Description
`Mo+2T20:00:00`	The offset from the view of the current week is applied (+0 = this week, +1 = next week). If no offset (Mo) is given, the next available weekday will be applied. If the required weekday is today, it's today.
`2021-Mo2T20:00:00`	The given calendar week matches the real calendar week of the year. When +0 is given, the week which is present on the 01.01 is applied → can eventually identical to +1. When no offset is given, the first appearing weekday in the year will be applied.
`2021-01-Mo2T20:00:00`	This behaviour is identical how the year, but only on a monthly basis

When deleting entries, the offset pattern can also include wildcards like .* or (1|2) to filter entries based on a regex: 202.-01-0(1|2)T.*

Warning

You will always need the seperators of the time or date before using wildcard.
2021-01-01T+0.* is therefore not valid, because it doesn't contain a : before the wildcards are used → 2021-01-01T+0:.*

Get all entries (`GET /entry`)

Details

Returns all the entries of a user.

Info

You can also call this endpoint via PROPFIND /entry and pass the request parameters in the body.

Request parameters

Name	Type	Description
`ids[]`	int[], optional	Only entries with the given IDs will be returned
`attribute[]`	int[], optional	Only entries with the given attributes will be returned
`parameter`	string, optional	Deprecated: Filter for the parameter. `<#~NotNULL~Any~#>` means that the parameter can have any value. The same behaviour can be archived if this field is not specified. When null is given, the parameter has also to be null. Use `parameters` instead
`parameter_preset`	string, optional	Deprecated: Filter after a parameter preset. Use `prameters` instead
`parameters`	string[], optional	Filter for the parameter value or after the name of a parameter preset. The parameter ID is determined by its position in the provided Array. `<#~NotNULL~Any~#>` means that the parameter can have any value. The same behaviour can be archived if this field / the parameter is not specified
`creator`	int, optional	Filter after the ID of the token which created the entry. `-1` means that the creator can have any value. The same behaviour can be archived if this field is not specified. When null is given, the creator should be unknown (created by username and login)
`pattern`	string, optional	The date can be filtered by an (Offset-) pattern containing wild cards
`earlier_than`	dateTime, optional	The date of the entry has to be earlier than the given value. An (Offset-) pattern can be specified
`later_than`	dateTime, optional	The date of the entry has to be later than the given value. An (Offset-) pattern can be specified
`old_dates`	bool, optional	Weather old dates (less than now) should be returned. This is by default `false`. Take note, that this value does not override the attribute flag `execute_always`
`ignore_execute_always`	bool, optional	`execute_always` will be ignored for all the attributes
`ignore_execute_always_attribute[]`	int[], optional	For the given attributes the property `execute_always` will be ignored
`max_entries`	int, optional	The maximum number of entries to return. The default value is `600`. More than 2000 entries cannot be returned
`fields[]`	mixed, optional	Fields to include in the response
`fields[attribute][]`	mixed, optional	Fields for the attribute to include in the response. See properties for available fields
`executed[]`	int[], optional	Marks the entries as executed before returning the result. The result of this action is obmitted
`order_by_execution_date`	bool, optional	Instead of ordering the entries by the field `date_time`, the entries get sorted by the `date_time_execution`
`ignore_execution_date`	int, optional	This flag controlls which date field should be used to filter the date: 0 = `date_time > now() \|\| date_time_execution > now()` - 1 = `date_time > now()` - 2 = `date_time_execution > now()`

Response

[
  {
    "id": 2941,
    "attribute": {
      "id": 2
    },
    "date_time": "2023-11-30T16:38:59",
    "date_time_execution": "2023-11-30T16:38:59",
    "creator": 351,
    "parameters": [
      {
        "parameter_id": 2,
        "value": "Hi. Wie läufts?",
        "preset": null
      },
      {
        "parameter_id": 128,
        "value": null,
        "preset": "Olaf"
      }
    ],
    "creation_time": "2023-11-30T16:18:59"
  }, // etc
]

Response codes

200 Entries returned
204 when no entry was found
400 Invalid field or field values
401 Authentication failed

Get single entry (`GET /entry/{id}`)

Details

Returns a single entry.

Request parameters

Name	Type	Description
`{id}`	int	The unique ID of the entry
`fields[]`	mixed[], optional	Fields to include in the response
`fields[attribute][]`	mixed, optional	Fields to include in the response. See properties for available fields

Response

{
  "id": 2941,
  "attribute": {
    "id": 2
  },
  "date_time": "2023-11-30T16:38:59",
  "date_time_execution": "2023-11-30T16:38:59",
  "creator": 351,
  "parameters": [
    {
      "parameter_id": 2,
      "value": "Hi. Wie läufts?",
      "preset": null
    },
    {
      "parameter_id": 128,
      "value": null,
      "preset": "Olaf"
    }
  ],
  "creation_time": "2023-11-30T16:18:59"
}

Response codes

200 Entry returned
400 Invalid ID or fields supplied
401 Authentication failed
404 The entry was not found

Create single entry (`POST /entry`)

Details

Creates an entry.

Request body

See properties for values. In addition to these, the following field can be present:

Name	Type	Description
`timeout`	int, optional	Only applied for `exec_response`: the maximum time to wait in seconds for a responsee (60 seconds on max)

Example:

{
    "attribute": 52,
    "date_time": "2022-01-06T16:00:00",
    "parameters": [
        {
            "parameter_id": 2,
            "value": "Hi. What's up?",
            "preset": null
        }
    ]
}

Response body

See action Get single entry for a response body.

Example for the attribute type exec_response:

{
    "entry_id": -749637080,
    "response_code": 12,
    "response": "This is really good :)\n",

    "message": {
        "client": "The entry was created successfully"
    }
}

Response codes

201 Entry created
400 Invalid values for fields supplied
401 Authentication failed

For the entries with attribute type exec_response the following additional codes can be sent: * 417 The entry was not executed from a client (timeout reached) * 418 No user is connected that could execute the entry

Create entries (`POST /entry`)

Details

Creates multiple entries at once → bulk POST.

Request body

Name	Type	Description
`bulk[]`	Entry[]	The list of entries to create with their properties

Response body (multi response)

Following statuses can occur:

created Entry was created
failed The entry could not been created because of some error
exists The entry does already exist

See the below example for a response with multiple response codes.

{
    "overview": {
        "successful": 1,
        "errors": 0,
        "exists": 1
    },
    "response": [
        {
            "status": "exists",
            "code": 409,
            "error": {
                "message": "The given entry does already exist",
                "id": "ENTRY_EXISTS",
            }
        },
        {
            "status": "created",
            "data": {
                "id": 1486,
                "attribute": {
                    "id": 2
                },
                "date_time": "2022-04-13T15:20:00",
                "parameters": [
                    {
                        "parameter_id": 2,
                        "value": "Hi. What's up?",
                        "preset": null
                    }
                ]
            }
        }, // etc
    ],
    "message": {
        "client": "Einige Einträge existierten bereits. Alle anderen wurden erfolgreich erstellt"
    }
}

Response codes

201 Entries created
207 Multiple response codes → see the response body for more information
400 No entry was created
401 Authentication failed

Delete single entry (`DELETE /entry/{id}`)

Details

Deletes a single entry.

Request parameters

Name	Type	Description
`{id}`	int	Unique ID of the entry to delete

Response codes

200 Entry deleted
400 Invalid ID supplied
401 Authentication failed
404 The entry was not found

Delete entries (`DELETE /entry`)

Details

Deletes multiple entires at once by ID → bulk DELETE.

You can also call this endpoint via PATCH /entry/delete and pass the request parameters in the body.

Request parameters

Name	Type	Description
`bulk[]`	int[], optional	The list of IDs to delete. When this field is ommited, all entries in your user account will be deleted

Response body (multi response)

Following statuses can occur:

deleted Entry was deleted
error Entry could not been deleted

See the below example for a response with multiple response codes.

{
    "overview": {
        "successful": 1,
        "errors": 1
    },
    "response": [
        {
            "status": "error",
            "code": 404
            "error": {
                "message": "The entry does not exist within you user account",
                "id": "ENTRY_NOT_EXIST"
            }
        },
        {
            "status": "deleted",
            "data": 1234
        }
    ],
    "message": {
        "client": "Not all entries could be deleted"
    }
}

Response codes

200 Entries deleted
207 Multiple response codes → see the response body for more information
400 No entry was deleted
401 Authentication failed

Delete entries by values (`DELETE /entry`)

Details

Deletes no, one or more entries based on the given filter arguments.

Request parameters

See Get all entries for request parameters.

Response body (multi response)

See the below example for a response.

{
    "count": 1,
    "ids": [
        2051
    ],
    "message": {
        "client": "Es wurde 1 Eintrag gelöscht"
    }
}

Response codes

200 no, one or more Entries were deleted
400 Invalid fields or field values
401 Authentication failed

Update single entry (`PUT /entry/{id}`)

Details

Updates an entry.

Request parameters

Name	Type	Description
`{id}`	int	Unique ID of the entry to update

Request body

See properties for values and Delete entry for an example.

Response

See action Get single entry for a response body.

Response codes

200 Entry updated
201 Entry was not updated because nothing was changed
400 Invalid ID supplied
401 Authentication failed
404 The entry was not found

Update entries (`PUT /entry`)

Details

Updates multiple entires at once → bulk PUT.

Request body

Name	Type	Description
`bulk[]`	mixed[]	The list of entries to update with their original ID and the new properties

Response body (multi response)

Following statuses can occur: * equal Entry was not updated because nothing was changed * updated Entry was updated * failed The entry could not been updated

See the below example for a response with multiple response codes:

{
    "overview": {

    },

    "response": [
        {
            "status": "updated",
            "code": 200,
            "data": {
                "id": 2941,
                "attribute": {
                    "id": 2
                },
                "date_time": "2023-11-30T16:55:21",
                "date_time_execution": "2023-11-30T16:55:21",
                "creator": 351,
                "parameters": [
                    {
                        "parameter_id": 2,
                        "value": "Das ist ja was",
                        "preset": null
                    },
                    {
                        "parameter_id": 128,
                        "value": null,
                        "preset": "Linus"
                    }
                ],
                "creation_time": "2023-11-30T16:18:59",
                "parameter": "Das ist ja was",
                "parameter_preset": null
            }
        },
        {
            "status": "equal"
        },
        {
            "status": "error",
            "code": 404
            "error": {
                "message": "The entry does not exist within your user account",
                "id": "ENTRY_NOT_EXIST"
            }
        },  // etc
    ]
}

Response codes

200 Entries deleted
207 Multiple response codes → see the response body for more information
400 No entry was deleted
401 Authentication failed

Patch entry (`PATCH /entry/{id}`)

Details

Patches an entry.

See Update entry for more information. At least one property of the entry has to be specified.

Patch entries (`PATCH /entry`)

Details

Patches multiple entires at once → bulk PATCH.

See Update entry for more information. At least one property of the entry has to be specified.

Entry

Parameter

(Offset-) Pattern

Offset

Offset Pattern

Get all entries (GET /entry)

Request parameters

Response

Response codes

Get single entry (GET /entry/{id})

Request parameters

Response

Response codes

Create single entry (POST /entry)

Request body

Response body

Response codes

Create entries (POST /entry)

Request body

Response body (multi response)

Response codes

Delete single entry (DELETE /entry/{id})

Request parameters

Response codes

Delete entries (DELETE /entry)

Request parameters

Response body (multi response)

Response codes

Delete entries by values (DELETE /entry)

Request parameters

Response body (multi response)

Response codes

Update single entry (PUT /entry/{id})

Request parameters

Request body

Response

Response codes

Update entries (PUT /entry)

Request body

Response body (multi response)

Response codes

Patch entry (PATCH /entry/{id})

Patch entries (PATCH /entry)

Get all entries (`GET /entry`)

Get single entry (`GET /entry/{id}`)

Create single entry (`POST /entry`)

Create entries (`POST /entry`)

Delete single entry (`DELETE /entry/{id}`)

Delete entries (`DELETE /entry`)

Delete entries by values (`DELETE /entry`)

Update single entry (`PUT /entry/{id}`)

Update entries (`PUT /entry`)

Patch entry (`PATCH /entry/{id}`)

Patch entries (`PATCH /entry`)