API documentation

All jobs

GET /api.sigtech.com/extraction/jobs/

Get all available jobs in Production

Headers

Name	Type	Description
token*	string	Personal access token

200 Success response:

[{
    "flow_id": "<flow_id>",
    "flow_name": "<flow_name>",
    "created_at": <unix epoch timestamp>
}]

Example:

Bash

curl --location --request GET 'https://api.sigtech.com/extraction/jobs/' \
--header 'Authorization: Bearer <token>' 

Python

import requests

url = 'https://api.sigtech.com/extraction/jobs/'
token = <token>

response = requests.get(url, headers={
        'Authorization': f'Bearer {token}',
})

response.json()

All runs

GET /api.sigtech.com/extraction/jobs/<job_id>/runs

Get all runs from a given job in Production

Path Parameters

Name	Type	Description
job_id*	string	Job ID

Headers

Name	Type	Description
token*	string	Personal access token

200 Success response:

[{
    "flow_id": "<flow_id>",
    "flow_name": "<flow_name>",
    "ts_epoch": <unix epoch timestamp>,
    "run_number": "<run_id>"
}]

Example:

Bash

curl --location --request GET 'https://api.sigtech.com/extraction/jobs/<job_id>/runs' \
--header 'Authorization: Bearer <token>'

Python

import requests

job_id = <token>
token = <token>
url = f'https://api.sigtech.com/extraction/jobs/{job_id}/runs'

response = requests.get(url, headers={
        'Authorization': f'Bearer {token}',
})

response.json()

All outputs

GET /api.sigtech.com/extraction/jobs/<job_id>/runs/<run_id>/outputs

Get all available outputs on a given run for a given job in Production

Path Parameters

Name	Type	Description
job_id*	string	Job ID
run_id*	string	Run ID

Headers

Name	Type	Description
token	string	Personal access token

200 Success response:

[{
    "flow_id": "<flow_id>",
    "flow_name": "<flow_name>",
    "ts_epoch": <unix epoch timestamp>,
    "run_number": "<run_id>",
    "step_name": "<step_id>"
}]

Example:

Bash

curl --location --request GET 'https://api.sigtech.com/extraction/jobs/<job_id>/runs/<run_id>/outputs' \
--header 'Authorization: Bearer <token>' 

Python

import requests

run_id = <run_id>
job_id = <job_id>
token = <token>

url = f'https://api.sigtech.com/extraction/jobs/{job_id}/runs/{run_id}/outputs'

response = requests.get(url, headers={
        'Authorization': f'Bearer {token}',
})

response.json()

All outputs latest run

GET /api.sigtech.com/extraction/jobs/<job_id>/runs/latest/outputs

Get all available outputs on a given run for a given job in Production

Path Parameters

Name	Type	Description
job_id*	string	Job ID

Headers

Name	Type	Description
token*	string	Personal access token

200 Success response:

[{
    "flow_id": "<flow_id>",
    "flow_name": "<flow_name>",
    "ts_epoch": <unix epoch timestamp>,
    "run_number": "<run_id>",
    "step_name": "<step_id>"
}]

Example:

Bash

curl --location --request GET 'https://api.sigtech.com/extraction/jobs/<job_id>/runs/latest/outputs' \
--header 'Authorization: Bearer <token>' 

Python

import requests

job_id = <job_id>
token = <token>

url = f'https://api.sigtech.com/extraction/jobs/{job_id}/runs/latest/outputs'

response = requests.get(url, headers={
        'Authorization': f'Bearer {token}',
})

response.json()

An output

GET /api.sigtech.com/extraction/jobs/<job_id>/runs/<run_id>/outputs/<output_name>

Get a specific output from a given run and a given job in Production

Path Parameters

Name	Type	Description
job_id*	string	Job ID
run_id*	string	Run ID

Headers

Name	Type	Description
token*	string	Personal access token

200 Success response:

[{
    "flow_id": "<flow_id>",
    "flow_name": "<flow_name>",
    "ts_epoch": <unix epoch timestamp>,
    "run_number": "<run_id>",
    "step_name": "<step_id>"
}]

Example:

Bash

curl --location --request GET 'https://api.sigtech.com/extraction/jobs/<job_id>/runs/<run_id>/outputs/<output_name>' \
--header 'Authorization: Bearer <token>' 

Python

import requests

run_id = <run_id>
job_id = <job_id>
token = <token>
output_name = <output_name>

url = f'https://api.sigtech.com/extraction/jobs/{job_id}/runs/{run_id}/outputs/{output_name}'

response = requests.get(url, headers={
        'Authorization': f'Bearer {token}',
})

response.json()

An output latest run

GET /api.sigtech.com/extraction/jobs/<job_id>/runs/latest/outputs/<output_name>

Get a specific output from the latest run and a given job in Production

Path Parameters

Name	Type	Description
job_id*	string	Job ID

Headers

Name	Type	Description
token*	string	Personal access token

200 Success response:

[{
    "flow_id": "<flow_id>",
    "flow_name": "<flow_name>",
    "ts_epoch": <unix epoch timestamp>,
    "run_number": "<run_id>",
    "step_name": "<step_id>"
}]

Example:

Bash

curl --location --request GET 'https://api.sigtech.com/extraction/jobs/<job_id>/runs/latest/outputs/<output_name>' \
--header 'Authorization: Bearer <token>' 

Python

import requests

job_id = <job_id>
token = <token>
output_name = <output_name>

url = f'https://api.sigtech.com/extraction/jobs/{job_id}/runs/latest/outputs/{output_name}'

response = requests.get(url, headers={
        'Authorization': f'Bearer {token}',
})

response.json()