[ { "id": 123, "dataCollector": { "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "subClientId": 3, "subClientDescription": "Branch Office A" }, "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "state": "done", "blocked": true, "batchAction": { "id": 123, "type": "retry_blocked", "createdAt": "2024-08-23T00:00:00+00:00", "updatedAt": "2024-08-23T00:00:00+00:00", "subClientId": 3, "subClientDescription": "Branch Office A" }, "dataCollectorIdentifier": "string", "dataCollectorId": 123, "batchActionId": 123, "batchActionType": "string", "subClientId": 3, "subClientDescription": "Branch Office A" } ]

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' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "dataCollector": {
      "createdAt": "2024-08-23T00:00:00+00:00",
      "updatedAt": "2024-08-23T00:00:00+00:00",
      "subClientId": 3,
      "subClientDescription": "Branch Office A"
    },
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "state": "done",
    "blocked": true,
    "batchAction": {
      "id": 123,
      "type": "retry_blocked",
      "createdAt": "2024-08-23T00:00:00+00:00",
      "updatedAt": "2024-08-23T00:00:00+00:00",
      "subClientId": 3,
      "subClientDescription": "Branch Office A"
    },
    "dataCollectorIdentifier": "string",
    "dataCollectorId": 123,
    "batchActionId": 123,
    "batchActionType": "string",
    "subClientId": 3,
    "subClientDescription": "Branch Office A"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

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

value | null

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"

state

string

Workflow state

Example: "done"

blocked

boolean

Available options: truefalse

batchAction

value | null

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"