Alegion Public API V1 (1.0)

Download OpenAPI specification:Download

Alegion Public API V1

Authentication

api_key

Security Scheme Type API Key
Header parameter name: x-api-key

Assets

getAssetById

Authorizations:
path Parameters
assetId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tenantReference": "string",
  • "fileName": "string",
  • "fps": 0,
  • "frameCount": 0,
  • "status": "uploading",
  • "source": "csv",
  • "type": "video",
  • "createdAt": "string",
  • "errorMessage": "string",
  • "preprocessingProgress": 0,
  • "originalUrl": "http://example.com",
  • "originalFileName": "string"
}

deleteAsset

Authorizations:
path Parameters
assetId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

listAssets

Authorizations:
query Parameters
sortDirection
string
url
string
pageSize
string
statuses
string
name
string
type
string
page
string
sortBy
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createAsset

header Parameters
Authorization
required
string
Request Body schema: application/json
id
string <uuid>

id of an asset

url
string <uri>

unique, valid asset url

name
string

optional friendly name

tenantReference
string

optional reference for deduplicate per tenant

fileName
string

file name, mandatory when source is FILE

fps
number

frames per second for video

frameCount
integer <int32> >= 0

number of frames for video

status
string (Status)
Enum: "uploading" "upload-error" "pending-preprocessing" "preprocessing" "recovering-preprocessing" "uploaded"

Status of the Asset

source
string (Source)
Enum: "csv" "file"

Source of Asset

type
string (AssetType)
Enum: "video" "image"
createdAt
string <dateTime>

UTC timestamp

errorMessage
string

error message if status is upload-error

preprocessingProgress
number

preprocessing progress, between 0 and 1

originalUrl
string <uri>

original URL before preprocessing

originalFileName
string

original file name before preprocessing

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tenantReference": "string",
  • "fileName": "string",
  • "fps": 0,
  • "frameCount": 0,
  • "status": "uploading",
  • "source": "csv",
  • "type": "video",
  • "createdAt": "string",
  • "errorMessage": "string",
  • "preprocessingProgress": 0,
  • "originalUrl": "http://example.com",
  • "originalFileName": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tenantReference": "string",
  • "fileName": "string",
  • "fps": 0,
  • "frameCount": 0,
  • "status": "uploading",
  • "source": "csv",
  • "type": "video",
  • "createdAt": "string",
  • "errorMessage": "string",
  • "preprocessingProgress": 0,
  • "originalUrl": "http://example.com",
  • "originalFileName": "string"
}

initiateAssetUpload

Authorizations:
path Parameters
assetId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json

terminateAssetUpload

Authorizations:
path Parameters
assetId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

Token

login

Authorizations:
Request Body schema: application/json
username
required
string <string>

username

password
required
string <string>

password

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "token_type": "string",
  • "refresh_token": "string",
  • "id_token": "string"
}

Exports

downloadExport

Authorizations:
path Parameters
exportId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

getWorkflowRecordResults

Authorizations:
path Parameters
workflowId
required
string
query Parameters
query
string
sort
string
pageSize
string
minCreatedAt
string
ids
string
page
string
batchIds
string
maxCreatedAt
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getExport

Authorizations:
path Parameters
exportId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "in-progress",
  • "filename": "string",
  • "fileType": "json",
  • "recordResultCount": 0,
  • "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  • "createdAt": "string",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "s3Path": "string",
  • "statusMessage": "string"
}

deleteExport

Authorizations:
path Parameters
exportId
required
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}

getRecordResultExports

Authorizations:
query Parameters
workflowId
string
query
string
projectId
string
sort
string
pageSize
string
readyOnly
string
page
string
header Parameters
Authorization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createRecordResultExport

Authorizations:
header Parameters
Authorization
required
string
Request Body schema: application/json
workflowId
string <uuid>

Workflow ID

batchIds
Array of strings <uuid>

List of uuid id

query
string

Full text search query

minCreatedAt
string <dateTime>

Minimum creation date filter

maxCreatedAt
string <dateTime>

Maximum creation date filter

ids
Array of strings <uuid>

List of record result uuids

filename
required
string

User friendly name for export file

fileType
required
string (ExportFileType)
Enum: "json" "zip"

filetype for the export

Responses

Request samples

Content type
application/json
{
  • "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  • "batchIds": [
    ],
  • "query": "string",
  • "minCreatedAt": "string",
  • "maxCreatedAt": "string",
  • "ids": [
    ],
  • "filename": "string",
  • "fileType": "json"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "in-progress",
  • "filename": "string",
  • "fileType": "json"