[ { "id": 123, "dataCollector": "https://example.com/", "renderingRequests": [ "https://example.com/" ], "createdBy": "user1@company.com", "updatedBy": "user1@company.com", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "client": {}, "subClient": {}, "state": "done", "workflowLog": "[2024-01-01 00:00:00] Rendering set to blocked because of paused Template", "blocked": false, "wfData": [ "string" ], "batchAction": "https://example.com/", "dataCollectorIdentifier": "string", "dataCollectorId": 123, "batchActionId": 123, "batchActionType": "string", "subClientId": 3, "subClientDescription": "Branch Office A", "subClientColor": "#083E5D" } ]

DataCollectorProcess

SPA: Retrieves a list of data collector processes

Returns a paginated list of data collector processes for the authenticated user's client.

GET/api/spa/data-collector-processes

SPA: Retrieves a list of data collector processes

curl --request GET \
  --url 'https://app.output.rocks/api/spa/data-collector-processes?page=1&itemsPerPage=20' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "dataCollector": "https://example.com/",
    "renderingRequests": [
      "https://example.com/"
    ],
    "createdBy": "user1@company.com",
    "updatedBy": "user1@company.com",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "client": {},
    "subClient": {},
    "state": "done",
    "workflowLog": "[2024-01-01 00:00:00] Rendering set to blocked because of paused Template",
    "blocked": false,
    "wfData": [
      "string"
    ],
    "batchAction": "https://example.com/",
    "dataCollectorIdentifier": "string",
    "dataCollectorId": 123,
    "batchActionId": 123,
    "batchActionType": "string",
    "subClientId": 3,
    "subClientDescription": "Branch Office A",
    "subClientColor": "#083E5D"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

itemsPerPage

integerdefault:20

The number of items per page

pagination

boolean

Enable or disable pagination

blocked

boolean

No description provided.

integer

No description provided.

id[]

integer[]

No description provided.

Response

200application/json

DataCollectorProcess collection

integer

dataCollector

string<iri-reference> | null

Example: "https://example.com/"

renderingRequests

string<iri-reference>[]

createdBy

string

User, created this entry

Example: "user1@company.com"

updatedBy

string

User, updated this entry

Example: "user1@company.com"

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

client

object

subClient

object

state

string

Workflow state

Example: "done"

workflowLog

string

Workflow logs as a string

Example: "[2024-01-01 00:00:00] Rendering set to blocked because of paused Template"

blocked

boolean

Available options: truefalse

Example: false

wfData

string | null[]

batchAction

string<iri-reference> | null

Example: "https://example.com/"

dataCollectorIdentifier

string

dataCollectorId

integer

batchActionId

integer | null

batchActionType

string | null

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"

subClientColor

string

SubClient display colour. Provided on instances with enabled sub-client module only.

Example: "#083E5D"