API docs by Redocly

Deianira (1.0)

Download OpenAPI specification:

The Deianira API

Authentication

Authentication operations

Acquire an access token

Acquire a short-lived access token using the provided refresh (session) token

Authorizations:
session_token

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Logout

End the User's current session

Authorizations:
session_token

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "statusCode": 0,
  • "error": "string"
}

Initiate SAML authentication using the provider identified by `:id`

Redirects to the SAML provider for authentication, or to the authentication failure URL. A Not Found response is never returned

path Parameters
id
required
string

The id of the SAML provider

Responses

Callback URL for SAML authentication

Handles the callback from the SAML provider. On succesful authentication, the session cookie containing the session token is set

path Parameters
id
required
string

The id of the SAML provider

Request Body schema: application/x-www-form-urlencoded
required
SAMLResponse
required
string

The SAML response from the Identity Provider

RelayState
string

The URL to redirect to after authentication

Responses

SAML metadata for the provider identified by `:id`

path Parameters
id
required
string

The id of the SAML provider

Responses

Authenticate using a username/password pair

Request Body schema: application/json
required
email
required
string <email>

User username/email address

password
required
string <password>

User password

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

SCIM

SCIM operations

Get Service Provider Configuration

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "authenticationSchemes": [
    ],
  • "patch": {
    },
  • "bulk": {
    },
  • "filter": {
    },
  • "changePassword": {
    },
  • "sort": {
    },
  • "etag": {
    }
}

Get Resource Types

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

Responses

Response samples

Content type
application/json
{
  • "totalResults": 0,
  • "itemsPerPage": 0,
  • "startIndex": 0,
  • "schemas": [
    ],
  • "Resources": [
    ]
}

Create a User

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

Request Body schema:
required
schemas
required
Array of strings
userName
required
string
externalId
string
displayName
string
title
string
active
boolean
preferredLanguage
string
locale
string
timezone
string
nickName
string
profileUrl
string
userType
string
object (UserNameDetailsDto)
Array of objects (GroupMemberDto)
Array of objects (UserEmailDto)
Array of objects (UserPhotoDto)
Array of objects (UserPhoneNumberDto)
Array of objects (UserAddressDto)

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "userName": "string",
  • "externalId": "string",
  • "displayName": "string",
  • "title": "string",
  • "active": true,
  • "preferredLanguage": "string",
  • "locale": "string",
  • "timezone": "string",
  • "nickName": "string",
  • "profileUrl": "string",
  • "userType": "string",
  • "name": {
    },
  • "groups": [
    ],
  • "emails": [
    ],
  • "photos": [
    ],
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "userName": "string",
  • "externalId": "string",
  • "displayName": "string",
  • "title": "string",
  • "active": true,
  • "preferredLanguage": "string",
  • "locale": "string",
  • "timezone": "string",
  • "nickName": "string",
  • "profileUrl": "string",
  • "userType": "string",
  • "name": {
    },
  • "groups": [
    ],
  • "emails": [
    ],
  • "photos": [
    ],
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "meta": {
    }
}

Retrieve all Users

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

query Parameters
filter
string
attributes
string
sortBy
string
sortOrder
string
startIndex
integer >= 1
count
integer

Responses

Response samples

Content type
application/json
{
  • "totalResults": 0,
  • "itemsPerPage": 0,
  • "startIndex": 0,
  • "Resources": [
    ]
}

Retrieve a User

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the User

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "userName": "string",
  • "externalId": "string",
  • "displayName": "string",
  • "title": "string",
  • "active": true,
  • "preferredLanguage": "string",
  • "locale": "string",
  • "timezone": "string",
  • "nickName": "string",
  • "profileUrl": "string",
  • "userType": "string",
  • "name": {
    },
  • "groups": [
    ],
  • "emails": [
    ],
  • "photos": [
    ],
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "meta": {
    }
}

Delete a User

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the User

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "status": "string",
  • "scimType": "string",
  • "detail": "string"
}

Update a User

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the User

Request Body schema:
required
schemas
required
Array of strings
userName
required
string
externalId
string
displayName
string
title
string
active
boolean
preferredLanguage
string
locale
string
timezone
string
nickName
string
profileUrl
string
userType
string
object (UserNameDetailsDto)
Array of objects (UserEmailDto)
Array of objects (UserPhotoDto)
Array of objects (UserPhoneNumberDto)
Array of objects (UserAddressDto)

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "userName": "string",
  • "externalId": "string",
  • "displayName": "string",
  • "title": "string",
  • "active": true,
  • "preferredLanguage": "string",
  • "locale": "string",
  • "timezone": "string",
  • "nickName": "string",
  • "profileUrl": "string",
  • "userType": "string",
  • "name": {
    },
  • "emails": [
    ],
  • "photos": [
    ],
  • "phoneNumbers": [
    ],
  • "addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "userName": "string",
  • "externalId": "string",
  • "displayName": "string",
  • "title": "string",
  • "active": true,
  • "preferredLanguage": "string",
  • "locale": "string",
  • "timezone": "string",
  • "nickName": "string",
  • "profileUrl": "string",
  • "userType": "string",
  • "name": {
    },
  • "groups": [
    ],
  • "emails": [
    ],
  • "photos": [
    ],
  • "phoneNumbers": [
    ],
  • "addresses": [
    ],
  • "meta": {
    }
}

Create a Group

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

Request Body schema:
required
schemas
required
Array of strings
displayName
required
string
Array of objects (GroupMemberDto)

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "displayName": "string",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "displayName": "string",
  • "members": [
    ],
  • "meta": {
    }
}

Retrieve all Groups

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

query Parameters
filter
string
attributes
string
sortBy
string
sortOrder
string
startIndex
integer >= 1
count
integer

Responses

Response samples

Content type
application/json
{
  • "totalResults": 0,
  • "itemsPerPage": 0,
  • "startIndex": 0,
  • "Resources": [
    ]
}

Retrieve a Group

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the Group

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "displayName": "string",
  • "members": [
    ],
  • "meta": {
    }
}

Delete a Group

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the Group

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "status": "string",
  • "scimType": "string",
  • "detail": "string"
}

Update a Group

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the Group

Request Body schema:
required
schemas
required
Array of strings
displayName
required
string
required
Array of objects (GroupMemberDto)

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "displayName": "string",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "displayName": "string",
  • "members": [
    ],
  • "meta": {
    }
}

Update a Group

Authorizations:
scim_token
path Parameters
providerId
required
string

The id of the Provider

id
required
string

The id of the Group

Request Body schema:
required
schemas
required
Array of strings
required
Array of objects (GroupOperationDto)

Responses

Request samples

Content type
{
  • "schemas": [
    ],
  • "Operations": [
    ]
}

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "id": "string",
  • "displayName": "string",
  • "members": [
    ],
  • "meta": {
    }
}

Adjustment

Adjustment operations

Download an Image associated with an Adjustment

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

id
required
string <uuid>

The id of the File

query Parameters
height
integer [ 8 .. 4096 ]

The required height of the image

width
integer [ 8 .. 4096 ]

The required width of the image

fit
string
Enum: "contain" "cover" "fill" "inside" "outside"

The required image transform to apply

format
string
Enum: "jpg" "png" "webp" "native"

The required image format

Responses

Preview a Document associated with an Adjustment

The Document is automatically converted to a PDF file if it is not already

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

id
required
string <uuid>

The id of the File

Responses

Download a Document associated with an Adjustment

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

id
required
string <uuid>

The id of the File

Responses

Upload and associate an Image with an Adjustment

The Image must be associated with an Engine or Damage, but not both.

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

Request Body schema: multipart/form-data
required
file
required
string <binary>

The Image file to upload

engineId
string <uuid>

The id of the Engine

partDamageId
string <uuid>

The id of the Damage

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "mimeType": "string",
  • "size": 0,
  • "height": 0,
  • "width": 0,
  • "attachReport": true
}

Upload and associate a Document with an Adjustment

The Document may be associated with an Airframe, Engine or Damage. Only a single association is allowed.

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to upload

airframeId
string <uuid>

The id of the Airframe

engineId
string <uuid>

The id of the Engine

partDamageId
string <uuid>

The id of the Damage

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "mimeType": "string",
  • "size": 0,
  • "height": 0,
  • "width": 0,
  • "attachReport": true
}

Get a Adjustment Report stylesheet

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

fileName
required
string

The file name

Responses

Get the Adjustment Report header branding image

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

Responses

Get the Adjustment Report footer branding image

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

Responses

Get a versioned Adjustment Report PDF file

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

reportId
required
string <uuid>

The id of the Report

Responses

Get a PDF preview of the latest Adjustment Report

Authorizations:
access_token
path Parameters
adjustmentId
required
string <uuid>

The id of the Adjustment

query Parameters
showLinks
boolean

Include hyperlinks in the generated PDF to jump back to the source of information

Responses

Company

Company/Organisation operations

Download the logo of a Company/Organisation

Authorizations:
access_token
path Parameters
id
required
string <uuid>

The id of the Image/Document/File

query Parameters
height
integer [ 8 .. 4096 ]

The required height of the image

width
integer [ 8 .. 4096 ]

The required width of the image

fit
string
Enum: "contain" "cover" "fill" "inside" "outside"

The required image transform to apply

format
string
Enum: "jpg" "png" "webp" "native"

The required image format

Responses

Upload and set the logo of a Company/Organisation

Authorizations:
access_token
path Parameters
id
required
string <uuid>

The id of the Company/Organisation

Request Body schema: multipart/form-data
required
file
required
string <binary>

The Image file to upload

usage
required
string
Enum: "report_header_image" "report_footer_image" "operator_image"

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "mimeType": "string",
  • "size": 0,
  • "height": 0,
  • "width": 0,
  • "attachReport": true
}

Loss Notice

Loss Notice operations

Download an Image associated with a Loss Notice

Authorizations:
access_token
path Parameters
lossNoticeId
required
string <uuid>

The id of the Loss Notice

id
required
string <uuid>

The id of the File

query Parameters
height
integer [ 8 .. 4096 ]

The required height of the image

width
integer [ 8 .. 4096 ]

The required width of the image

fit
string
Enum: "contain" "cover" "fill" "inside" "outside"

The required image transform to apply

format
string
Enum: "jpg" "png" "webp" "native"

The required image format

Responses

Download a Document associated with a Loss Notice

Authorizations:
access_token
path Parameters
lossNoticeId
required
string <uuid>

The id of the Loss Notice

id
required
string <uuid>

The id of the File

Responses

Upload and associate an Image with a Loss Notice

The Image must be associated with an Engine or Damage, but not both.

Authorizations:
access_token
path Parameters
lossNoticeId
required
string <uuid>

The id of the Loss Notice

Request Body schema: multipart/form-data
required
file
required
string <binary>

The Image file to upload

engineId
string <uuid>

The id of the Engine

partDamageId
string <uuid>

The id of the Damage

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "mimeType": "string",
  • "size": 0,
  • "height": 0,
  • "width": 0,
  • "attachReport": true
}

Upload and associate a Document with a Loss Notice

The Document may be associated with an Airframe, Engine or Damage. Only a single association is allowed.

Authorizations:
access_token
path Parameters
lossNoticeId
required
string <uuid>

The id of the Loss Notice

Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to upload

airframeId
string <uuid>

The id of the Airframe

engineId
string <uuid>

The id of the Engine

partDamageId
string <uuid>

The id of the Damage

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "fileName": "string",
  • "mimeType": "string",
  • "size": 0,
  • "height": 0,
  • "width": 0,
  • "attachReport": true
}

Miscellaneous

Miscellaneous operations

Get the OpenAPI schema

Responses

Response samples

Content type
application/json
"string"

Get the GraphQL schema

Responses

Health

Health check operations

Perform a health check

Determine if the service is in a healthy state.

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}