DataCollector

SPA: Retrieves a list of data collectors

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

GET/api/spa/data-collectors

SPA: Retrieves a list of data collectors

curl --request GET \
  --url 'https://app.output.rocks/api/spa/data-collectors?page=1&order%5Bid%5D=asc&order%5Bidentifier%5D=asc&order%5Btype%5D=asc&order%5Bschedule%5D=asc&order%5BactiveFrom%5D=asc&order%5Bactive%5D=asc&order%5BlastExecution%5D=asc&order%5BcreatedAt%5D=asc&order%5BupdatedAt%5D=asc' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "identifier": "string",
    "schedule": 1,
    "type": "string",
    "lastExecution": "2024-08-23T00:00:00+00:00",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "active": true,
    "activeFrom": "2024-01-01",
    "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

order[id]

stringdefault:asc

No description provided.

order[identifier]

stringdefault:asc

No description provided.

order[type]

stringdefault:asc

No description provided.

order[schedule]

stringdefault:asc

No description provided.

order[activeFrom]

stringdefault:asc

No description provided.

order[active]

stringdefault:asc

No description provided.

order[lastExecution]

stringdefault:asc

No description provided.

order[createdAt]

stringdefault:asc

No description provided.

order[updatedAt]

stringdefault:asc

No description provided.

identifier

string

No description provided.

type

string

No description provided.

type[]

string[]

No description provided.

string

Global data collector search across id, identifier, type, schedule, status, and dates.

active

boolean

No description provided.

activeFrom[before]

string

No description provided.

activeFrom[strictly_before]

string

No description provided.

activeFrom[after]

string

No description provided.

activeFrom[strictly_after]

string

No description provided.

Response

200application/json

DataCollector collection

integer

identifier

stringrequired

schedule

integer | null

type

stringrequired

lastExecution

string<date-time> | 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"

active

boolean

Active flag. Default: true

Available options: truefalse

Example: true

activeFrom

string<date-time>

Date to activate the entry. Default: today

Example: "2024-01-01"

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"