Broken LinksNotebooks
# Table of contents
Aidbox FHIR platform documentation
Getting Started
Tutorials
CRUD, Search Tutorials
Bulk API Tutorials
Security & Access Control Tutorials
RBAC
Terminology Tutorials
Validation Tutorials
Upload FHIR Implementation Guide
Aidbox UI
Integration Toolkit Tutorials
Other tutorials
## Overview
Aidbox user portal
Aidbox UI
## Configuration
## API
REST API
CRUD
Search
Custom Search Parameter
SearchParameter types
Search parameters list
Other
Other
Bulk API
Other APIs
Plan API
Provider Directory API
Archive/Restore API
## Modules
Profiling and validation
FHIR Schema Validator
Security & Access Control
Authentication
Access to AidboxUI
External identity providers
Authentication Flows
Access Control
Attribute-based Access Control (ABAC)
Label-based Access Control
SMART on FHIR
SMART Client Authorization
SMART Client Authentication
SMART (deprecated)
SMART on FHIR
Multitenancy
Patient data access API
Audit
Technical reference
Observability
Getting started
Logs
How-to guides
Tutorials
Technical reference
Metrics
How-to guides
Technical reference
Traces
Subscriptions
Aidbox topic-based subscriptions
Aidbox Forms
Aidbox UI Builder
Form creation
How-to guides
Printing forms
Embedding
Aidbox Code Editor (deprecated)
Define extensions
Custom Resources
Migrate to FHIR Schema
Aidbox terminology module
Concept
ValueSet
CodeSystem
Import external terminologies
SQL on FHIR
Integration toolkit
C-CDA / FHIR Converter
List of supported templates
HL7 v2 Integration
Analytics
Email Providers integration
SMARTbox | FHIR API for EHRs
Get started
The B11 Decision Support Interventions
How-to guides
Background information
Other modules
MDM
## Storage
AidboxDB
Other
S3-compatible storages
## Deployment and maintenance
Deploy Aidbox
Run Aidbox on Kubernetes
Backup and Restore
Indexes
## App development
Aidbox SDK
## Reference
Settings reference
Environment variables
Email Providers reference
Aidbox Forms reference
## Deprecated
Deprecated
Zen-related
RPC reference
aidbox
mdm
Aidbox configuration project
Aidbox Configuration project reference
US Core IG
Workflow Engine
Task
Workflow
FHIR conformance Deprecated guides
How to enable US Core IG
Terminology Deprecated Tutorials
zen-lang validator
FHIR topic-based subscriptions
API Reference
🏗️ FHIR Terminology Repository
Create an FTR instance
Entity / Attribute
Other
App Development Deprecated Tutorials
Receive logs from your app
Other Deprecated Tutorials

delete-archive

To delete archived data from cloud you should start deleting process with /execution/aidbox.archive/delete-archive task.

delete-archive properties:

PropertiesRequiredDescription
archiveIdtruearchiveId property of succeeded create-archive status response if it archived at least 1 row.

http
POST /execution/aidbox.archive/delete-archive
accept: text/yaml
content-type: text/yaml

archiveId: 07738389-196d-4879-a2da-04e9cd9272
yaml
Status: 201

id: 646fbd75-7365-4422-938a-0ba8d0efcb0e

To fetch status of the task make /execution/aidbox.archive/delete-archive/[task_id] request with id from delete-archive response:

http
GET /execution/aidbox.archive/delete-archive/646fbd75-7365-4422-938a-0ba8d0efcb0e
accept: text/yaml
content-type: text/yaml
yaml
Status: 200

definition: aidbox.archive/delete-archive
meta:
  lastUpdated: '2023-01-10T11:18:29.355638Z'
  createdAt: '2023-01-10T11:18:28.803714Z'
  versionId: '26064'
params:
  archiveId: 07738389-196d-4879-a2da-04e9cd9272
retryCount: 1
outcome: succeeded
resourceType: AidboxTask
requester:
  id: >-
    admin
  resourceType: User
status: done
result:
  unmarkedResourcesCount: 30
execId: 1fd9ecee-d093-4949-9d73-15cba78ada7a
id: >-
  646fbd75-7365-4422-938a-0ba8d0efcb0e