Roaring logo
Log in

Data Updater

Update your data to current information, and smoothly add monitoring to keep up-to-date.

Data Updater

[global]
Requires addon

Endpoints

List available services

Get available services which could be used to start current information task

gethttps://api.roaring.io/se/company/current-information/1.0/services

Response schema: application/json

List current information tasks performed by user

Fetch information about all current information tasks performed by user

gethttps://api.roaring.io/se/company/current-information/1.0/tasks

Start current information task with file

Starts current information task for specified services and companies from a file

puthttps://api.roaring.io/se/company/current-information/1.0/startWithFile/{webhookId}

Parameters path

webhookId

required

string
Id of webhook to which to send current information events
Request body schemamultipart/form-dataRequired
companyIds
stringtext file with company id-s each in a new line
services
arraylist of service names

Validate company ids file

Validate the file has good company ids

puthttps://api.roaring.io/se/company/current-information/1.0/validate
Request body schemamultipart/form-dataRequired
file
stringtext file with company id-s each in a new line

Start current information task

Starts current information task for specified companies and services

puthttps://api.roaring.io/se/company/current-information/1.0/start/{webhookId}

Parameters path

webhookId

required

string
Id of webhook to which to send current information events
Request body schemaapplication/jsonRequired
Required fields: companyIds, services
companyIds
arrayArray of company identifiers for which to fetch current information data
services
arrayArray of service names from which fetch current information data

Get status of current information task

Get status of current information task for specified task id

gethttps://api.roaring.io/se/company/current-information/1.0/status/{currentInformationId}

Parameters path

currentInformationId

required

string
Id of current information task

Parameters query

withProtocol
boolean
Whether to include current information task execution protocol, default false

List available webhooks

Get available webhooks which could be used to start current information task

gethttps://api.roaring.io/se/company/current-information/1.0/webhooks