Reads history using an exclusive Sequence cursor.

GET

/api/workspace/workflow/runtime/instances/{id}/history

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/workflow/runtime/instances/example/history?afterSequence=0&pageSize=50"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/workflow/runtime/instances/example/history?afterSequence=0&pageSize=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/workspace/workflow/runtime/instances/example/history?afterSequence=0&pageSize=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

required

string

Query Parameters

afterSequence

integer format: int64

pageSize

integer format: int32

default: 50

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

application/json

object

Data

object

Events

Array<object>

nullable

object

Sequence

integer format: int64

VisitId

string

nullable

EventType

string

nullable

OccurredAtUtc

string format: date-time

ActorUserId

string

nullable

CorrelationId

string

nullable

ChoiceKey

string

nullable

Reason

string

nullable

ErrorCode

string

nullable

NodeKey

string

nullable

NodeTitle

string

nullable

SourceNodeKey

string

nullable

SourceNodeTitle

string

nullable

ChoiceTitle

string

nullable

ActorDisplayName

string

nullable

OutputKey

string

nullable

TriggerEventId

string

nullable

NextSequence

integer format: int64

nullable

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}