Sign in

v1

latestSwagger 2.0MIT2026-07-1310778293.3 KB
History

List history

Lists the history of a GUID

get/api/v1/history/{id4n}

Path parameters

id4nstring required

GUID to retrieve the history for

Query parameters

includePrivateboolean

Also return private history entries

organizationstring

Show only entries created by one of the given organizations. This parameter can be used multiple times.

typestring[]

Show only entries matching one of the given history item types. This parameter can be used multiple times.

qualifierstring[]

Show only entries matching one of the given history item qualifiers (additional property de.id4i.history.item.qualifier). This parameter can be used multiple times.

fromDatestring date-time

From date time as UTC Date-Time format

toDatestring date-time

To date time as UTC Date-Time format

offsetinteger

Start with the n-th element

limitinteger

The maximum count of returned elements

Response

OK

limitinteger required

The number of returned elements

offsetinteger required

Starting with the n-th element

totalinteger

The total number of elements

Example response

{
  "elements": [
    {
      "organizationId": "org.acme",
      "ownerOrganizationId": "de.bluerain",
      "sequenceId": 9784,
      "timestamp": 1517232722,
      "type": "DISPATCHED",
      "visibility": {
        "public": true,
        "sharedOrganizationIds": [
          "de.acme",
          "com.porsche",
          "de.bluerain"
        ]
      }
    }
  ],
  "limit": 100,
  "total": 200
}