API documentation

{% swagger baseUrl=”/” path=”api.sigtech.com/extraction/jobs/” method=”get” summary=”All jobs” %} {% swagger-description %} Get all available jobs in Production {% endswagger-description %}

{% swagger-parameter in=”header” name=”token” type=”string” required=”true” %} Personal access token {% endswagger-parameter %}

{% swagger-response status=”200” description=”Success response:” %}

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

{% endswagger-response %} {% endswagger %}

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()

{% swagger baseUrl=”/” path=”api.sigtech.com/extraction/jobs/<job_id>/runs” method=”get” summary=”All runs” %} {% swagger-description %} Get all runs from a given job in Production {% endswagger-description %}

{% swagger-parameter in=”path” name=”job_id” type=”string” required=”true” %} Job ID {% endswagger-parameter %}

{% swagger-parameter in=”header” name=”token” type=”string” required=”true” %} Personal access token {% endswagger-parameter %}

{% swagger-response status=”200” description=”Success response:” %}

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

{% endswagger-response %} {% endswagger %}

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()

{% swagger baseUrl=”/” path=”api.sigtech.com/extraction/jobs/<job_id>/runs/<run_id>/outputs” method=”get” summary=”All outputs” %} {% swagger-description %} Get all available outputs on a given run for a given job in Production {% endswagger-description %}

{% swagger-parameter in=”path” name=”job_id” type=”string” required=”true” %} Job ID {% endswagger-parameter %}

{% swagger-parameter in=”header” name=”token” type=”string” %} Personal access token {% endswagger-parameter %}

{% swagger-parameter in=”path” name=”run_id” type=”string” required=”true” %} Run ID {% endswagger-parameter %}

{% swagger-response status=”200” description=”Success response:” %}

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

{% endswagger-response %} {% endswagger %}

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()

{% swagger baseUrl=”/” path=”api.sigtech.com/extraction/jobs/<job_id>/runs/latest/outputs” method=”get” summary=”All outputs latest run” %} {% swagger-description %} Get all available outputs on a given run for a given job in Production {% endswagger-description %}

{% swagger-parameter in=”path” name=”job_id” type=”string” required=”true” %} Job ID {% endswagger-parameter %}

{% swagger-parameter in=”header” name=”token” type=”string” required=”true” %} Personal access token {% endswagger-parameter %}

{% swagger-response status=”200” description=”Success response:” %}

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

{% endswagger-response %} {% endswagger %}

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()

{% swagger baseUrl=”/” path=”api.sigtech.com/extraction/jobs/<job_id>/runs/<run_id>/outputs/<output_name>” method=”get” summary=”An output” %} {% swagger-description %} Get a specific output from a given run and a given job in Production {% endswagger-description %}

{% swagger-parameter in=”path” name=”job_id” type=”string” required=”true” %} Job ID {% endswagger-parameter %}

{% swagger-parameter in=”header” name=”token” type=”string” required=”true” %} Personal access token {% endswagger-parameter %}

{% swagger-parameter in=”path” name=”run_id” type=”string” required=”true” %} Run ID {% endswagger-parameter %}

{% swagger-response status=”200” description=”Success response:” %}

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

{% endswagger-response %} {% endswagger %}

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()

{% swagger baseUrl=”/” path=”api.sigtech.com/extraction/jobs/<job_id>/runs/latest/outputs/<output_name>” method=”get” summary=”An output latest run” %} {% swagger-description %} Get a specific output from the latest run and a given job in Production {% endswagger-description %}

{% swagger-parameter in=”path” name=”job_id” type=”string” required=”true” %} Job ID {% endswagger-parameter %}

{% swagger-parameter in=”header” name=”token” type=”string” required=”true” %} Personal access token {% endswagger-parameter %}

{% swagger-response status=”200” description=”Success response:” %}

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

{% endswagger-response %} {% endswagger %}

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()