DataCollector

SPA: Creates a new Data Collector.

Creates a new Data Collector.

POST/api/spa/data-collectors

Authorizations

X-AUTH-TOKEN
stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json
required

The new DataCollector resource

{
  "identifier": "string",
  "schedule": 1,
  "type": "string",
  "configuration": [
    "string"
  ],
  "requestMapping": [
    "string"
  ],
  "apiToken": {
    "subClient": {}
  },
  "subClient": {}
}

Response

201application/json

DataCollector resource created

id
integer
identifier
stringrequired
schedule
integer | null
type
stringrequired
configuration
string[]
requestMapping
string[]
apiToken
value | null
lastExecution
string<date-time> | null
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"

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"