List a component instance's workflow history

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/custom_components/7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d/CC-1001/history?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.workflows.get_workflow_custom_component_history(
    "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d", "CC-1001", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.workflows.getWorkflowCustomComponentHistory(
    '7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d',
    'CC-1001',
    {limit: 20},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->workflows->getWorkflowCustomComponentHistory(
    '7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d',
    'CC-1001',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.workflows().getWorkflowCustomComponentHistory(
        "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d",
        "CC-1001",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Workflows.GetWorkflowCustomComponentHistoryAsync(
    "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d",
    "CC-1001",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.workflows.getWorkflowCustomComponentHistory(
  '7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d',
  'CC-1001',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Workflows().GetWorkflowCustomComponentHistory(context.Background(), "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d", "CC-1001", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

workflows

custom_components

{component_uuid}

{object_code}

history

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/custom_components/7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d/CC-1001/history?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.workflows.get_workflow_custom_component_history(
    "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d", "CC-1001", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.workflows.getWorkflowCustomComponentHistory(
    '7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d',
    'CC-1001',
    {limit: 20},
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->workflows->getWorkflowCustomComponentHistory(
    '7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d',
    'CC-1001',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.workflows().getWorkflowCustomComponentHistory(
        "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d",
        "CC-1001",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Workflows.GetWorkflowCustomComponentHistoryAsync(
    "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d",
    "CC-1001",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.workflows.getWorkflowCustomComponentHistory(
  '7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d',
  'CC-1001',
  queryParams: {'limit': 20},
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Workflows().GetWorkflowCustomComponentHistory(context.Background(), "7a1b3c5d-9e2f-4a6b-8c0d-1e3f5a7b9c2d", "CC-1001", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Identify the component by its dashed uuid and the instance by its code. Returns a page of history entries under data, with cursor pagination. Other fields filter as filter_<field> for equality or filter_<field>_<operator>, such as filter_created_on_gte.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

component_uuid

string

required

The component's dashed uuid: the hex of its cmp_ id with the dashes put back. The cmp_ id itself returns 404.

object_code

string

required

The component instance's code, not its cco_ id.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

cursor

string

The pagination.next_cursor of the previous page, to read the page after it.

sort

string

A field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

A page of the instance's workflow history.

object

string

Always list.

url

string

The path this page was read from.

data

object[]

The component instance's history entries or milestones.

pagination

object

Show child attributes

Guides

API reference

List a component instance's workflow history

Authorizations

Path Parameters

Query Parameters

Response