OpenAPI Specification
openapi: 3.0.0
info:
title: Aloft API V1 Accounts Activity API
contact:
email: support@aloft.ai
version: 1.0.0
description: Accounts
tags:
- name: Activity
description: Activity
paths:
/v1/account/{account_id}/{resource}/{id}/activity:
get:
tags:
- Activity
summary: Get all activities
description: Gets activities for a specific resource.
operationId: 159ae876b6467536e7c1fc162044d886
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: resource
in: path
required: true
schema:
type: string
enum:
- aircraft
- incidents
- users
- maintenance
- mission
- name: id
in: path
required: true
schema:
type: integer
- name: appends[]
in: query
description: Array of appendable resources
schema:
type: array
items:
type: string
enum:
- user
- name: order_by
in: query
description: The field to order the data by
required: false
schema:
type: string
enum:
- created_at
- name: order
in: query
required: false
schema:
$ref: '#components/schemas/order_direction'
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'200':
description: Successful operation
content:
application/json: {}
application/csv: {}
security:
- Aloft Token: []
post:
tags:
- Activity
summary: Create an activity.
description: Create an activity for the specified resource.
operationId: c2337efb96d901cc89150e13abaedeaa
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: resource
in: path
required: true
schema:
type: string
enum:
- aircraft
- incidents
- users
- maintenance
- mission
- name: id
in: path
required: true
schema:
type: integer
- name: appends[]
in: query
description: Array of appendable resources
schema:
type: array
items:
type: string
enum:
- user
requestBody:
content:
application/json:
schema:
$ref: '#components/schemas/Activity'
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'422':
description: Unprocessable Content
'200':
description: Successful operation
security:
- Aloft Token: []
/v1/account/{account_id}/{resource}/{id}/activity/{activity_id}:
put:
tags:
- Activity
summary: Update an activity.
description: Update an activity
operationId: d7aa6649be926345b76e925b2c63f722
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: resource
in: path
required: true
schema:
type: string
enum:
- aircraft
- incidents
- users
- maintenance
- mission
- name: id
in: path
required: true
schema:
type: integer
- name: activity_id
in: path
required: true
schema:
type: integer
- name: appends[]
in: query
description: Array of appendable resources
schema:
type: array
items:
type: string
enum:
- user
requestBody:
content:
application/json:
schema:
$ref: '#components/schemas/Activity'
responses:
'403':
description: Access Denied
'401':
description: Unauthorized
'422':
description: Unprocessable Content
'200':
description: Successful operation
security:
- Aloft Token: []
delete:
tags:
- Activity
summary: Delete an activity
description: Delete an activity
operationId: a44b85d441572f9cc77ced105a8a0354
parameters:
- name: account_id
in: path
required: true
schema:
$ref: '#components/schemas/model_id'
- name: resource
in: path
required: true
schema:
type: string
enum:
- aircraft
- incidents
- users
- maintenance
- mission
- name: id
in: path
required: true
schema:
type: integer
- name: activity_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