OpenAPI Specification
openapi: 3.0.0
info:
title: Aloft API V1 Accounts Risk Assessment Executions API
contact:
email: support@aloft.ai
version: 1.0.0
description: Accounts
tags:
- name: Risk Assessment Executions
description: Risk Assessment Executions
paths:
/v1/account/{account_id}/risk-assessment-executions:
get:
tags:
- Risk Assessment Executions
summary: Get risk assessment executions
description: Gets risk assessment executions
operationId: cc5293f7e45d7992676112dc1b0e8126
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: user_id
in: query
description: user id
schema:
type: integer
- name: start
in: query
description: timestamp
schema:
type: integer
- name: stop
in: query
description: timestamp
schema:
type: integer
- name: risk_score_greater_than
in: query
description: Risk score must be greater than.
schema:
type: double
- name: risk_score_less_than
in: query
description: Risk score must be less than
schema:
type: double
- name: search
in: query
description: Search by identifier & source.
schema:
type: string
- name: order_by
in: query
description: The field to order the data by
schema:
type: string
enum:
- id
- risk_assessment_id
- user_id
- flight_id
- state
- completed_at
- created_at
- updated_at
- risk_score
- name: order
in: query
schema:
$ref: '#components/schemas/order_direction'
- name: appends[]
in: query
description: Array of appendable resource names
schema:
type: array
items:
type: string
enum:
- risk_assessment
- user
- user.is_retired
- flight
- risk_score
- name: page
in: query
schema:
type: integer
- name: page_length
in: query
schema:
type: integer
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'200':
description: Successful operation
content:
application/json: {}
application/csv: {}
security:
- Aloft Token: []
post:
tags:
- Risk Assessment Executions
summary: Create a risk assessment execution
description: Create a risk assessment execution
operationId: b41e41090e16c29e3a10f2d1a7ad4ec8
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: appends[]
in: query
description: Array of appendable resource names
schema:
type: array
items:
type: string
enum:
- risk_assessment
- items
- flight
- user
requestBody:
content:
application/json:
schema:
$ref: '#components/schemas/risk_assessment_execution'
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'200':
description: Successful operation
security:
- Aloft Token: []
/v1/account/{account_id}/risk-assessment-executions/{risk_assessment_execution_id}:
get:
tags:
- Risk Assessment Executions
summary: Get a risk assessment execution
description: Gets a risk assessment execution
operationId: c622e2134e383ba6581366190c585e8a
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: risk_assessment_execution_id
in: path
description: The risk assessment execution id.
required: true
schema:
type: integer
- name: appends[]
in: query
description: array of model names
schema:
type: array
items:
type: string
enum:
- risk_assessment
- flight
- user
- user.is_retired
- risk_score
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'200':
description: Successful operation
security:
- Aloft Token: []
put:
tags:
- Risk Assessment Executions
summary: Create a risk assessment execution
description: Create a risk assessment execution
operationId: daa48b1ed09824a47f898854339c2139
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: appends[]
in: query
description: Array of appendable resource names
schema:
type: array
items:
type: string
enum:
- risk_assessment
- items
- flight
- user
- name: risk_assessment_execution_id
in: path
description: Risk Assessment Execution ID
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#components/schemas/risk_assessment_execution'
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'200':
description: Successful operation
security:
- Aloft Token: []
delete:
tags:
- Risk Assessment Executions
summary: Delete a risk assessment execution
description: Delete a risk assessment execution
operationId: 5805fbc277ad2e54b152234294b9be92
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: risk_assessment_execution_id
in: path
required: true
schema:
type: integer
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'204':
description: Successful operation
security:
- Aloft Token: []
components:
securitySchemes:
Aloft Token:
type: http
name: Aloft Token
in: header
scheme: bearer