Data Sources

/extractors

GET Retrieve a list of extractors

{{base_url}}/v1/extractors

Test description

Example Request:

curl --location --request GET "{{base_url}}/v1/extractors" \
--header "Accept: application/json"

HEADERS

Accept

application/json

POST Add a new extractor

{{base_url}}/v1/extractors

Example Request:

curl --location --request POST "{{base_url}}/v1/extractors" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Extractor test - 488\",
\"contents\": \"print Hello\
var key1 = value1\
public var key2 = value2\
public encrypted var key3 = 0\"
}"

HEADERS

Content-Type

application/json

Accept

application/json

BODY (raw)

{
"name": "Extractor test - 277",
"contents": "print Hello\nvar key1 = value1\npublic var key2 = value2\npublic encrypted var key3 = 0"
}

GET Retrieve an extractor

{{base_url}}/v1/extractors/{{extractor_name}}

Example Request:

curl --location --request GET "{{base_url}}/v1/extractors/{{extractor_name}}" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PATCH Update an extractor (contents)

{{base_url}}/v1/extractors/{{extractor_name}}

Example Request:

curl --location --request PATCH "{{base_url}}/v1/extractors/{{extractor_name}}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"contents\": \"print Hello world\
var key1 = value1\
public var key2 = value2\
public encrypted var key3 = 0\"
}"

HEADERS

Content-Type

application/json

Accept

application/json

BODY (raw)
{
"contents": "print Hello world\nvar key1 = value1\npublic var key2 = value2\npublic encrypted var key3 = 0"
}

PATCH Update an extractor (variables)

{{base_url}}/v1/extractors/{{extractor_name}}

Example Request:

curl --location --request PATCH "{{base_url}}/v1/extractors/{{extractor_name}}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"variables\": [
{
\"name\": \"key2\",
\"value\": \"value2\",
\"type\": \"normal\"
},
{
\"name\": \"key3\",
\"value\": \"value3\",
\"type\": \"normal\"
}
]
}"

HEADERS

Content-Type

application/json

Accept

application/json

BODY (raw)

{
"variables": [
{
"name": "key2",
"value": "value2",
"type": "normal"
},
{
"name": "key3",
"value": "value3",
"type": "normal"
}
]
}

POST Run an extractor

{{base_url}}/v1/extractors/{{extractor_name}}/run?arguments

Example Request:

curl --location --request POST "{{base_url}}/v1/extractors/{{extractor_name}}/run?arguments" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PARAMS

arguments

Extractor arguments

BODY (formdata)

PUT Schedule an extractor

{{base_url}}/v1/extractors/{{extractor_name}}/schedule?time=03:00&date_from_offset&date_to_offset&arguments

Example Request:

curl --location --request PUT "{{base_url}}/v1/extractors/{{extractor_name}}/schedule?time=03:00&date_from_offset&date_to_offset&arguments" \
--header "Accept: application/json"
This method will be removed in a future version of the API.

HEADERS

Accept

application/json

PARAMS

times

03:00

Time to schedule the extractor to run each day (in HH:MM format).

date_from_offset

An integer (positive or negative) that will be used to add/subtract from the date the scheduler runs to determine the start of the date range.

date_to_offset

An integer (positive or negative) that will be used to add/subtract from the date the scheduler runs to determine the end of the date range.

arguments

Extractor arguments

BODY (formdata)

DEL Unschedule an extractor

{{base_url}}/v1/extractors/{{extractor_name}}/schedule

Example Request:

curl --location --request DELETE "{{base_url}}/v1/extractors/{{extractor_name}}/schedule" \
--header "Accept: application/json"
This method will be removed in a future version of the API.

HEADERS

Accept

application/json

BODY (formdata)

DEL Delete an extractor

{{base_url}}/v1/extractors/{{extractor_name}}

Example Request:

curl --location --request DELETE "{{base_url}}/v1/extractors/{{extractor_name}}" \
            --header "Accept: application/json" \
            --data "

HEADERS

Accept

application/json


/transformers

GET Retrieve a list of transformers

{{base_url}}/v1/transformers

Test Description

Example Request:

curl --location --request GET "{{base_url}}/v1/transformers" \
--header "Accept: application/json"

HEADERS

Accept

application/json

POST Add a new transformer

{{base_url}}/v1/transformers

Example Request:

curl --location --request POST "{{base_url}}/v1/transformers" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Transformer test 268\",
\"contents\": \"# script here\"
}"

HEADERS

Content-Type

application/json

Accept

application/json

BODY (raw)

{
"name": "Transformer test 797",
"contents": "# script here"
}

GET Retrieve a transformer

{{base_url}}/v1/transformers/{{transformer_name}}

Example Request:

curl --location --request GET "{{base_url}}/v1/transformers/{{transformer_name}}" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PATCH Update a transformer

{{base_url}}/v1/transformers/{{transformer_name}}

Example Request:

curl --location --request PATCH "{{base_url}}/v1/transformers/{{transformer_name}}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"contents\": \"# modified script here\"
}"

HEADERS

Content-Type

application/json

Accept

application/json

BODY (raw)

{
"contents": "# modified script here"
}

POST Run a transformer

{{base_url}}/v1/transformers/{{transformer_name}}/run?date={{date}}&start_date=&end_date=&limit&break_at&preview&snapshot_deset=

Example Request:

curl --location --request POST "{{base_url}}/v1/transformers/{{transformer_name}}/run?date={{date}}&start_date=&end_date=&limit&break_at&preview&snapshot_deset=" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PARAMS

date

{{date}}

Date to run the fransformer for (in YYYY-MM-DD format).

start_date

If the transformer should be run for a range of dates, the start date to run the fransformer for (in YYYY-MM-DD format).

end_date

If the transformer should be run for a range of dates, the end date to run the fransformer for (in YYYY-MM-DD format).

limit

Limit the number of records to preview, defaults to 10.

break_at

When in preview mode, stop executing the transformer before this line.

preview

If set to 1, all statements which modify the system will be skipped and the default dataset will be included with the response.

snapshot_deset

With preview only - name of deset to preview. If not selected, default dset will be used.

BODY

(formdata)

PUT Schedule a transformer

{{base_url}}/v1/transformers/{{transformer_name}}/schedule?time=03:00&date_from_offset&date_to_offset

This method will be removed in a future version of the API.

Example Request:

curl --location --request PUT "{{base_url}}/v1/transformers/{{transformer_name}}/schedule?time=03:00&date_from_offset&date_to_offset" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PARAMS

time

03:00

Time (in Europe/London timezone) to schedule the transformer to run each day (in HH:MM format).

date_from_offset

An integer (positive or negative) that will be used to add/subtract from the date the scheduler runs to determine the start of the date range.

date_to_offset

An integer (positive or negative) that will be used to add/subtract from the date the scheduler runs to determine the end of the date range.

BODY

(formdata)

DEL Unschedule a transformer

{{base_url}}/v1/transformers/{{transformer_name}}/schedule

This method will be removed in a future version of the API.

Example Request:

curl --location --request DELETE "{{base_url}}/v1/transformers/{{transformer_name}}/schedule" \
--header "Accept: application/json"

HEADERS

Accept

application/json

BODY

(formdata)

DEL Delete a transformer

{{base_url}}/v1/transformers/{{transformer_name}}

Example Request:

curl --location --request DELETE "{{base_url}}/v1/transformers/{{transformer_name}}" \
--header "Accept: application/json" \ --data ""

HEADERS

Accept

application/json

/desets

GET Retrieve a list of datasets

{{base_url}}/v1/dsets?page[limit]&page[offset]&sort&filter[attribute]&include=

Test Description

Example Request:

curl --location --request GET "{{base_url}}/v1/dsets?page%5Blimit%5D&page%5Boffset%5D&sort&filter%5Battribute%5D&include=" \
--header "Accept: application/vnd.api+json"

HEADERS

Accept

application/vnd.api+json

PARAMS

page[limit]

Limit the amount of results returned

page[offset]

Return this page of the results

sort

Sort results by this attribute

filter[attribute]

Filter results by this attribute

include

Include additional related resources. Possible values: services, reports.

GET Retrieve a dataset

{{base_url}}/v1/dsets/:name

Test Description

Example Request:

curl --location --request GET "{{base_url}}/v1/dsets/:name" \
            --header "Accept: application/vnd.api+json"

HEADERS

Accept

application/vnd.api+json

PATH VARIABLES

name

{{dset_id}}

DEL Delete a dataset

{{base_url}}/v1/dsets/:name?start={{start}}&end={{end}}

Example Request:

curl --location --request DELETE "{{base_url}}/v1/dsets/:name?start={{start}}&end={{end}}" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.api+json"

PARAMS

start

{{start}}

The start of the date range (inclusive) you want to delete from the dataset. If not specified, use the first date of the dataset.

end

{{end}}

The end of the date range (inclusive) you want to delete from the dataset. If not specified, use the last date of the dataset.

PATH VARIABLES

name

{{dset_id}}

BODY

(formdata)

/file

This endpoint lets you work with files in the home directory. Currently, only uploading files is supported.

POST Upload a file

{{base_url}}/v1/file

Only the following file types are accepted:
  • csv
  • txt
  • json
  • xml

Uploaded files are stored as %EXIVITY_HOME_PATH%/import/[group]/[yyyy]/[mm]/[dd]_uploaded_[sequence].[extension], where sequence is a 3 characters long numberic string with padded zeros (e.g. 001 or 026).

Example Request:

curl --location --request POST "{{base_url}}/v1/file" \
--header "Accept: application/json" \
--form "file=" \
--form "group=" \
--form "date=" \
--form "sequence="

HEADERS

Accept

application/json

BODY

(formdata)

file

File to be uploaded

group

Optional parameter to specify group (default=generic)

date

Optional parameter to specify date in YYYY-MM-DD format (default=current date)

sequence

Optional parameter to specify sequence (default=1 or auto incrementing if current sequence is already in use)

PUT Upload a file into a folder

{{base_url}}/v1/file/a.txt
Example Request:

curl --location --request PUT "{{base_url}}/v1/file/a.txt" \
--header "Accept: application/json" \
--header "Content-Type: application/x-www-form-urlencoded" \
--data-binary "=@"

HEADERS

Accept

application/json

Content-Type

application/x-www-form-urlencoded

BODY

(file)

GET List files in folder

{{base_url}}/v1/file/:folder
Example Request:

curl --location --request GET "{{base_url}}/v1/file/:folder" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PATH VARIABLES

folder

GET Retrieve file

{{base_url}}/v1/file/:folder/:filename
Example Request:

curl --location --request GET "{{base_url}}/v1/file/:folder/:filename" \
--header "Accept: application/json"

HEADERS

Accept

application/json

PATH VARIABLES

folder

filename

DEL Delete a file

{{base_url}}/v1/file/:folder/:filename
Example Request:

curl --location --request DELETE "{{base_url}}/v1/file/:folder/:filename" \
            --header "Accept: application/json"

HEADERS

Accept

application/json

PATH VARIABLES

folder

filename


How did we do?