1283 строки
34 KiB
JSON
1283 строки
34 KiB
JSON
{
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"version": "1.0.0",
|
||
"title": "Alkymi",
|
||
"description": "Alkymi transforms enterprise workflows by placing machine learning and automation technology into the hands of business users, turning operational data headaches into a source of efficiency. Alkymi’s core products—Data Inbox and Patterns—allow businesses to extract, analyze, and take action on critical business data in emails and documents.The Alkymi connector allows you to easily access the data extracted from unstructured documents processed by the Alkymi app.",
|
||
"contact": {
|
||
"name": "Alkymi Support",
|
||
"url": "https://www.alkymi.io/contact",
|
||
"email": "tori@alkymi.io"
|
||
}
|
||
},
|
||
"host": "www.example.com",
|
||
"basePath": "/",
|
||
"schemes": [
|
||
"https"
|
||
],
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"paths": {
|
||
"/api/v2/datasets/": {
|
||
"get": {
|
||
"description": "Lists all of the datasets available on the tenant.\n https://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/6VcSt63koHgyePk72r0pR",
|
||
"summary": "List All Datasets",
|
||
"tags": [
|
||
"datasets"
|
||
],
|
||
"operationId": "datasets_list",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "dataset list",
|
||
"schema": {
|
||
"$ref": "#/definitions/PaginatedDatasetList"
|
||
},
|
||
"x-ms-summary": "Paginated Dataset List"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/datasets/{uuid}/": {
|
||
"get": {
|
||
"description": "Retrieve a specific dataset instance. The returned dataset record may require additional parsing before using downstream in the workflow.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr",
|
||
"summary": "Get Dataset Information",
|
||
"x-ms-summary": "Retrieve a specific dataset instance. The returned dataset record may require additional parsing before using downstream in the workflow.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/dowMAn1aXoA6vyOj24fOr",
|
||
"tags": [
|
||
"datasets"
|
||
],
|
||
"operationId": "datasets_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "dataset uuid",
|
||
"x-ms-summary": "Dataset UUID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "dataset instance",
|
||
"schema": {
|
||
"$ref": "#/definitions/PaginatedDatasetList"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/documents/": {
|
||
"post": {
|
||
"description": "Uploads a file to a Data Inbox tenant for processing.",
|
||
"x-ms-summary": "Uploads a file to a Data Inbox tenant for processing.",
|
||
"summary": "Upload Document File",
|
||
"tags": [
|
||
"documents"
|
||
],
|
||
"operationId": "documents_create",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"consumes": [
|
||
"multipart/form-data"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "removed",
|
||
"in": "formData",
|
||
"type": "boolean",
|
||
"description": "removed",
|
||
"x-ms-summary": "Removed Boolean"
|
||
},
|
||
{
|
||
"name": "dataset",
|
||
"in": "formData",
|
||
"type": "string",
|
||
"description": "dataset uuid",
|
||
"x-ms-summary": "Dataset UUID"
|
||
},
|
||
{
|
||
"name": "subject",
|
||
"in": "formData",
|
||
"type": "string",
|
||
"description": "subject",
|
||
"x-ms-summary": "Subject"
|
||
},
|
||
{
|
||
"name": "sender",
|
||
"in": "formData",
|
||
"type": "string",
|
||
"description": "sender",
|
||
"x-ms-summary": "Sender"
|
||
},
|
||
{
|
||
"name": "folder",
|
||
"in": "formData",
|
||
"type": "string",
|
||
"description": "folder",
|
||
"x-ms-summary": "Folder"
|
||
},
|
||
{
|
||
"name": "file",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "file",
|
||
"description": "file data",
|
||
"x-ms-summary": "File Data"
|
||
},
|
||
{
|
||
"name": "targets",
|
||
"in": "formData",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"description": "targeted pattern names",
|
||
"x-ms-dynamic-values": {
|
||
"operationId": "pipelines_list",
|
||
"value-collection": "results",
|
||
"value-path": "name",
|
||
"value-title": "name"
|
||
},
|
||
"x-ms-dynamic-list": {
|
||
"operationId": "pipelines_list",
|
||
"itemsPath": "results",
|
||
"itemValuePath": "name",
|
||
"itemTitlePath": "name"
|
||
},
|
||
"x-ms-summary": "Targeted Patterns"
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "uploaded document"
|
||
}
|
||
}
|
||
},
|
||
"get": {
|
||
"description": "Lists all of the documents available on the tenant.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7DOwvq52yx9eVF2KFpkQH",
|
||
"summary": "List All Documents",
|
||
"tags": [
|
||
"documents"
|
||
],
|
||
"operationId": "documents_list",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [],
|
||
"responses": {
|
||
"200": {
|
||
"description": "document list",
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "count"
|
||
},
|
||
"next": {
|
||
"type": "string",
|
||
"description": "next"
|
||
},
|
||
"previous": {
|
||
"type": "string",
|
||
"description": "previous"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/Document"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/documents/{uuid}/": {
|
||
"get": {
|
||
"description": "Retrieve a specific document instance.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/IEdTOtMaW23SQFRPhkDXh",
|
||
"summary": "Get Document Information",
|
||
"tags": [
|
||
"documents"
|
||
],
|
||
"operationId": "documents_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "document uuid",
|
||
"x-ms-summary": "Document UUID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "document",
|
||
"schema": {
|
||
"$ref": "#/definitions/Document"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/documents/{uuid}/download_original/": {
|
||
"get": {
|
||
"description": "Downloads a copy of the document file posted to Data Inbox in its original format.",
|
||
"summary": "Get Document File (Original Format)",
|
||
"tags": [
|
||
"documents"
|
||
],
|
||
"operationId": "documents_download_original_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "document uuid",
|
||
"x-ms-summary": "Document UUID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "original document file",
|
||
"schema": {
|
||
"type": "string",
|
||
"format": "binary"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/documents/{uuid}/download_pdf/": {
|
||
"get": {
|
||
"description": "Downloads a copy of the document file posted to Data Inbox in a converted PDF format.",
|
||
"summary": "Get Document File (PDF Format)",
|
||
"tags": [
|
||
"documents"
|
||
],
|
||
"operationId": "documents_download_pdf_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "document uuid",
|
||
"x-ms-summary": "Document UUID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "document pdf file",
|
||
"schema": {
|
||
"type": "string",
|
||
"format": "binary"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/executions/": {
|
||
"get": {
|
||
"description": "Lists all of the executions available on the tenant.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/7qd1-PJ-P40RFf7ocIK5g",
|
||
"summary": "List All Executions",
|
||
"tags": [
|
||
"executions"
|
||
],
|
||
"operationId": "executions_list",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "document_status",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"enum": [
|
||
"completed",
|
||
"error",
|
||
"processing",
|
||
"uploaded"
|
||
]
|
||
},
|
||
"description": "document status",
|
||
"x-ms-summary": "Document Status"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "execution list",
|
||
"schema": {
|
||
"$ref": "#/definitions/PaginatedExecutionList"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/executions/{uuid}/": {
|
||
"get": {
|
||
"description": "Retrieve a specific execution instance.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/sugkRPXlX9jwR3dDbmrdX",
|
||
"summary": "Get Execution Information",
|
||
"tags": [
|
||
"executions"
|
||
],
|
||
"operationId": "executions_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "execution uuid",
|
||
"x-ms-summary": "Execution UUID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "execution",
|
||
"schema": {
|
||
"$ref": "#/definitions/Execution"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/pipelines/": {
|
||
"get": {
|
||
"description": "List all of the patterns available on the tenant. \nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/O_NVlCnEFDOAQPWev_rdb",
|
||
"summary": "List All Patterns",
|
||
"tags": [
|
||
"pipelines"
|
||
],
|
||
"operationId": "pipelines_list",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "pattern list",
|
||
"schema": {
|
||
"$ref": "#/definitions/PaginatedPipelineConfigurationList"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/pipelines/{name}/": {
|
||
"get": {
|
||
"description": "Retrieve a specific pattern instance. The returned pattern record may require additional parsing before using downstream in the workflow.",
|
||
"summary": "Get Pattern Information",
|
||
"tags": [
|
||
"pipelines"
|
||
],
|
||
"operationId": "pipelines_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "name",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"description": "pattern name",
|
||
"x-ms-summary": "Pattern Name",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "pattern",
|
||
"schema": {
|
||
"$ref": "#/definitions/PipelineConfiguration"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/records/": {
|
||
"post": {
|
||
"description": "Create a record on a document",
|
||
"summary": "Create Record",
|
||
"tags": [
|
||
"records"
|
||
],
|
||
"operationId": "record_create",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"consumes": [
|
||
"application/x-www-form-urlencoded"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "record uuid",
|
||
"x-ms-summary": "Record UUID"
|
||
},
|
||
{
|
||
"name": "created",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "date-time",
|
||
"x-ms-summary": "Minimum created time for record"
|
||
},
|
||
{
|
||
"name": "modified",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "date-time",
|
||
"x-ms-summary": "Minimum modified time for record"
|
||
},
|
||
{
|
||
"name": "document_uuid",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Document UUID"
|
||
},
|
||
{
|
||
"name": "document",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Document"
|
||
},
|
||
{
|
||
"name": "dataset",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Dataset"
|
||
},
|
||
{
|
||
"name": "pipeline",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Pattern"
|
||
},
|
||
{
|
||
"name": "status",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Record Status"
|
||
},
|
||
{
|
||
"name": "schema_name",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Schema Name"
|
||
},
|
||
{
|
||
"name": "data",
|
||
"in": "formData",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "Record Data"
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "created record"
|
||
}
|
||
},
|
||
"x-ms-visibility": "internal"
|
||
},
|
||
"get": {
|
||
"description": "Lists all of the records available on the tenant. For example, you can return all records for a specific pattern if the tenant is configured with multiple patterns.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/AxGvA5pWxls9DWOMUE1qs",
|
||
"summary": "List All Records",
|
||
"tags": [
|
||
"records"
|
||
],
|
||
"operationId": "records_list",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "dataset",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "dataset uuid",
|
||
"x-ms-summary": "Dataset UUID"
|
||
},
|
||
{
|
||
"name": "document_status",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"enum": [
|
||
"completed",
|
||
"error",
|
||
"processing",
|
||
"uploaded"
|
||
]
|
||
},
|
||
"description": "processing status",
|
||
"x-ms-summary": "Processing Status"
|
||
},
|
||
{
|
||
"name": "pipeline",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"description": "pattern name",
|
||
"x-ms-summary": "Pattern"
|
||
},
|
||
{
|
||
"name": "removed",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "boolean",
|
||
"description": "removed status",
|
||
"x-ms-summary": "Removed Status"
|
||
},
|
||
{
|
||
"name": "reviewed",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "boolean",
|
||
"description": "reviewed status",
|
||
"x-ms-summary": "Reviewed Status"
|
||
},
|
||
{
|
||
"name": "schema",
|
||
"in": "query",
|
||
"required": false,
|
||
"type": "string",
|
||
"description": "schema",
|
||
"x-ms-summary": "Schema"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "record list",
|
||
"schema": {
|
||
"$ref": "#/definitions/PaginatedRecordList"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/records/{uuid}/": {
|
||
"get": {
|
||
"description": "Retrieve a specific record instance. The returned record object may require additional parsing before using downstream in the workflow.\nhttps://app.archbee.io/docs/RHl7SG2eUFckQNrUgXcGp/HEVS5cHZTtViD4_F6BLlM",
|
||
"summary": "Get Record Information",
|
||
"tags": [
|
||
"records"
|
||
],
|
||
"operationId": "records_retrieve",
|
||
"deprecated": false,
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"parameters": [
|
||
{
|
||
"name": "uuid",
|
||
"in": "path",
|
||
"required": true,
|
||
"type": "string",
|
||
"format": "uuid",
|
||
"description": "record uuid",
|
||
"x-ms-summary": "Record UUID",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"200": {
|
||
"description": "record",
|
||
"schema": {
|
||
"$ref": "#/definitions/Record"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/webhooks/": {
|
||
"x-ms-notification-content": {
|
||
"description": "Details for Alkymi WebHook",
|
||
"schema": {
|
||
"$ref": "#/definitions/WebHookEvent"
|
||
}
|
||
},
|
||
"post": {
|
||
"description": "This trigger is executed when any of the selected Alkymi events occur.",
|
||
"summary": "When An Alkymi Event Triggers",
|
||
"x-ms-trigger": "single",
|
||
"operationId": "event_listener",
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": false,
|
||
"schema": {
|
||
"type": "object",
|
||
"properties": {
|
||
"target": {
|
||
"type": "string",
|
||
"description": "target",
|
||
"x-ms-visibility": "internal",
|
||
"x-ms-notification-url": true
|
||
},
|
||
"display_name": {
|
||
"type": "string",
|
||
"description": "display name"
|
||
},
|
||
"registered_events": {
|
||
"title": "Events",
|
||
"description": "webhook events",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string",
|
||
"enum": [
|
||
"on_execution_upload_start",
|
||
"on_execution_processing_start",
|
||
"on_execution_processing_complete",
|
||
"on_execution_reviewed",
|
||
"on_execution_unreviewed",
|
||
"on_execution_remove_status_change",
|
||
"on_execution_error",
|
||
"on_execution_assignment",
|
||
"on_execution_has_exceptions"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"target"
|
||
]
|
||
},
|
||
"x-ms-summary": "Creates a listener for events within the Alkymi app"
|
||
}
|
||
],
|
||
"responses": {
|
||
"201": {
|
||
"description": "Webhook Created",
|
||
"schema": {
|
||
"$ref": "#/definitions/WebHookCreatedResponse"
|
||
}
|
||
},
|
||
"403": {
|
||
"description": "Token Lacks Sufficient Permissions"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"/api/v2/webhooks/{webhook_uuid}/": {
|
||
"delete": {
|
||
"description": "Unsubscribe a specific webhook.",
|
||
"operationId": "delete_web_hook",
|
||
"parameters": [
|
||
{
|
||
"description": "ID of the webhook being deleted",
|
||
"in": "path",
|
||
"name": "webhook_uuid",
|
||
"required": true,
|
||
"type": "string",
|
||
"x-ms-summary": "ID of the webhook being deleted",
|
||
"x-ms-url-encoding": "single"
|
||
}
|
||
],
|
||
"responses": {
|
||
"204": {
|
||
"description": "WebHook successfully deleted"
|
||
},
|
||
"403": {
|
||
"description": "Token lacks sufficient permissions"
|
||
}
|
||
},
|
||
"summary": "Deletes a webhook",
|
||
"x-ms-visibility": "internal"
|
||
}
|
||
}
|
||
},
|
||
"definitions": {
|
||
"Dataset": {
|
||
"title": "Dataset",
|
||
"description": "dataset",
|
||
"type": "object",
|
||
"properties": {
|
||
"uuid": {
|
||
"type": "string",
|
||
"format": "uuid"
|
||
},
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"pipeline": {
|
||
"type": "string"
|
||
},
|
||
"documents": {
|
||
"type": "string"
|
||
},
|
||
"records": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"uuid",
|
||
"name",
|
||
"pipeline",
|
||
"documents",
|
||
"records"
|
||
]
|
||
},
|
||
"Document": {
|
||
"title": "Document",
|
||
"description": "document",
|
||
"type": "object",
|
||
"properties": {
|
||
"uuid": {
|
||
"type": "string",
|
||
"description": "uuid"
|
||
},
|
||
"created": {
|
||
"type": "string",
|
||
"description": "created"
|
||
},
|
||
"modified": {
|
||
"type": "string",
|
||
"description": "modified"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "status"
|
||
},
|
||
"archived": {
|
||
"type": "boolean",
|
||
"description": "archived"
|
||
},
|
||
"removed": {
|
||
"type": "boolean",
|
||
"description": "removed"
|
||
},
|
||
"file_name": {
|
||
"type": "string",
|
||
"description": "file name"
|
||
},
|
||
"page_count": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "page count"
|
||
},
|
||
"pages": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"number": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "number"
|
||
},
|
||
"width": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "width"
|
||
},
|
||
"height": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"description": "height"
|
||
}
|
||
}
|
||
},
|
||
"description": "pages"
|
||
},
|
||
"dataset": {
|
||
"type": "string",
|
||
"description": "dataset"
|
||
},
|
||
"records": {
|
||
"type": "array",
|
||
"items": {},
|
||
"description": "records"
|
||
},
|
||
"pipeline_records": {
|
||
"type": "object",
|
||
"description": "pipeline records"
|
||
},
|
||
"_s3_key": {
|
||
"type": "string",
|
||
"description": "s3 key"
|
||
},
|
||
"_replaced_by": {
|
||
"type": "string",
|
||
"description": "replaced by"
|
||
},
|
||
"subject": {
|
||
"type": "string",
|
||
"description": "subject"
|
||
},
|
||
"sender": {
|
||
"type": "string",
|
||
"description": "sender"
|
||
},
|
||
"folder": {
|
||
"type": "string",
|
||
"description": "folder"
|
||
},
|
||
"watermark_removed": {
|
||
"type": "boolean",
|
||
"description": "watermark removed"
|
||
}
|
||
}
|
||
},
|
||
"Execution": {
|
||
"title": "Execution",
|
||
"description": "execution",
|
||
"type": "object",
|
||
"properties": {
|
||
"uuid": {
|
||
"type": "string",
|
||
"format": "uuid"
|
||
},
|
||
"created": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"reviewed": {
|
||
"type": "boolean"
|
||
},
|
||
"archived": {
|
||
"type": "boolean"
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
},
|
||
"records": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"pipeline_records": {
|
||
"type": "object"
|
||
},
|
||
"file_name": {
|
||
"type": "string"
|
||
},
|
||
"documents": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"uuid",
|
||
"created",
|
||
"reviewed",
|
||
"archived",
|
||
"status",
|
||
"records",
|
||
"pipeline_records",
|
||
"file_name",
|
||
"documents"
|
||
]
|
||
},
|
||
"PaginatedDatasetList": {
|
||
"title": "PaginatedDatasetList",
|
||
"description": "dataset list",
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"example": 123,
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"next": {
|
||
"example": "http://api.example.org/accounts/?page=4",
|
||
"type": "string"
|
||
},
|
||
"previous": {
|
||
"example": "http://api.example.org/accounts/?page=2",
|
||
"type": "string"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/Dataset"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"PaginatedExecutionList": {
|
||
"title": "PaginatedExecutionList",
|
||
"description": "execution list",
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"example": 123,
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"next": {
|
||
"example": "http://api.example.org/accounts/?page=4",
|
||
"type": "string"
|
||
},
|
||
"previous": {
|
||
"example": "http://api.example.org/accounts/?page=2",
|
||
"type": "string"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/Execution"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"PaginatedPipelineConfigurationList": {
|
||
"title": "PaginatedPipelineConfigurationList",
|
||
"description": "pipeline configuration list",
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"example": 123,
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"next": {
|
||
"example": "http://api.example.org/accounts/?page=4",
|
||
"type": "string"
|
||
},
|
||
"previous": {
|
||
"example": "http://api.example.org/accounts/?page=2",
|
||
"type": "string"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/PipelineConfiguration"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"PaginatedRecordList": {
|
||
"title": "PaginatedRecordList",
|
||
"description": "record list",
|
||
"type": "object",
|
||
"properties": {
|
||
"count": {
|
||
"example": 123,
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"next": {
|
||
"example": "http://api.example.org/accounts/?page=4",
|
||
"type": "string"
|
||
},
|
||
"previous": {
|
||
"example": "http://api.example.org/accounts/?page=2",
|
||
"type": "string"
|
||
},
|
||
"results": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/Record"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"PipelineConfiguration": {
|
||
"title": "PipelineConfiguration",
|
||
"description": "pattern",
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string"
|
||
},
|
||
"records": {
|
||
"type": "string"
|
||
},
|
||
"schemas": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/Schema"
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"name",
|
||
"records",
|
||
"schemas"
|
||
]
|
||
},
|
||
"Record": {
|
||
"title": "Record",
|
||
"description": "record",
|
||
"type": "object",
|
||
"properties": {
|
||
"uuid": {
|
||
"type": "string",
|
||
"format": "uuid"
|
||
},
|
||
"created": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"modified": {
|
||
"type": "string",
|
||
"format": "date-time"
|
||
},
|
||
"document_uuid": {
|
||
"type": "string"
|
||
},
|
||
"document": {
|
||
"type": "string"
|
||
},
|
||
"dataset": {
|
||
"type": "string"
|
||
},
|
||
"pipeline": {
|
||
"type": "string"
|
||
},
|
||
"schema_name": {
|
||
"type": "string"
|
||
},
|
||
"status": {
|
||
"type": "string"
|
||
},
|
||
"data": {
|
||
"type": "object"
|
||
}
|
||
},
|
||
"required": [
|
||
"uuid",
|
||
"created",
|
||
"document_uuid",
|
||
"document",
|
||
"dataset",
|
||
"pipeline",
|
||
"status",
|
||
"data"
|
||
]
|
||
},
|
||
"Schema": {
|
||
"title": "Schema",
|
||
"description": "schema",
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"maxLength": 50,
|
||
"pattern": "^[-a-zA-Z0-9_]+$"
|
||
},
|
||
"primary": {
|
||
"type": "boolean"
|
||
},
|
||
"fields": {
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/SchemaField"
|
||
}
|
||
}
|
||
},
|
||
"required": [
|
||
"name",
|
||
"primary",
|
||
"fields"
|
||
]
|
||
},
|
||
"SchemaField": {
|
||
"title": "SchemaField",
|
||
"description": "schema field",
|
||
"type": "object",
|
||
"properties": {
|
||
"name": {
|
||
"type": "string",
|
||
"maxLength": 50,
|
||
"pattern": "^[-a-zA-Z0-9_]+$"
|
||
},
|
||
"field_type": {
|
||
"type": "string"
|
||
},
|
||
"sub_schema": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"name",
|
||
"field_type"
|
||
]
|
||
},
|
||
"WebHookCreatedResponse": {
|
||
"title": "WebHookCreatedResponse",
|
||
"description": "web hook created response",
|
||
"type": "object",
|
||
"properties": {
|
||
"uuid": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"required": [
|
||
"uuid"
|
||
]
|
||
},
|
||
"WebHookEvent": {
|
||
"title": "WebhookEvent",
|
||
"description": "webhook event",
|
||
"type": "object",
|
||
"properties": {
|
||
"uuid": {
|
||
"type": "string",
|
||
"description": "uuid"
|
||
},
|
||
"status": {
|
||
"type": "string",
|
||
"description": "status"
|
||
},
|
||
"created": {
|
||
"type": "string",
|
||
"description": "created"
|
||
},
|
||
"records": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"description": "records"
|
||
},
|
||
"archived": {
|
||
"type": "boolean",
|
||
"description": "archived"
|
||
},
|
||
"reviewed": {
|
||
"type": "boolean",
|
||
"description": "reviewed"
|
||
},
|
||
"documents": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"description": "documents"
|
||
},
|
||
"file_name": {
|
||
"type": "string",
|
||
"description": "file name"
|
||
},
|
||
"pipeline_records": {
|
||
"type": "object",
|
||
"description": "pipeline records"
|
||
},
|
||
"trigger_event_list": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
},
|
||
"description": "trigger event list"
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"tags": [
|
||
{
|
||
"name": "datasets",
|
||
"description": "datasets"
|
||
},
|
||
{
|
||
"name": "documents",
|
||
"description": "documents"
|
||
},
|
||
{
|
||
"name": "executions",
|
||
"description": "executions"
|
||
},
|
||
{
|
||
"name": "pipelines",
|
||
"description": "pipelines"
|
||
},
|
||
{
|
||
"name": "records",
|
||
"description": "records"
|
||
},
|
||
{
|
||
"name": "webhooks",
|
||
"description": "web hooks"
|
||
}
|
||
],
|
||
"x-ms-connector-metadata": [
|
||
{
|
||
"propertyName": "Website",
|
||
"propertyValue": "https://alkymi.io"
|
||
},
|
||
{
|
||
"propertyName": "Privacy policy",
|
||
"propertyValue": "https://www.alkymi.io/privacy-policy"
|
||
},
|
||
{
|
||
"propertyName": "Categories",
|
||
"propertyValue": "Content and Files"
|
||
}
|
||
]
|
||
}
|