{ "openapi": "3.0.0", "info": { "title": "Data Tables Public API", "description": "Data Tables public-api", "version": "1.3.0", "contact": { "name": "Workato Inc.", "url": "https://workato.com", "email": "info@workato.com" } }, "servers": [ { "url": "https://data-tables.workato.com/api/v1" } ], "tags": [ { "name": "Tables" } ], "paths": { "/tables/{table_id}/records": { "post": { "tags": [ "Tables" ], "summary": "Create record", "description": "Endpoint allows you to insert a new record into a table", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - CreateRecordRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateRecordRequest" } } }, "required": true }, "responses": { "201": { "description": "Returns when the table is successfully created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/RecordResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "create_record" } }, "/managed_users/{managed_user_id}/tables/{table_id}/records": { "post": { "tags": [ "Tables" ], "summary": "Create record", "description": "Endpoint allows you to insert a new record into a table in a customer workspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - CreateRecordRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateRecordRequest" } } }, "required": true }, "responses": { "201": { "description": "Returns when the table is successfully created", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/RecordResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "create_record_oem" } }, "/tables/{table_id}/records/{record_id}": { "put": { "tags": [ "Tables" ], "summary": "Update record", "description": "Endpoint allows you to update table record", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "record_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_record_id_ - The identifier of record", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - UpdateRecordRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UpdateRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns when the record is successfully updated", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/RecordResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Failed to acquire lock", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "update_record" }, "delete": { "tags": [ "Tables" ], "summary": "Delete record", "description": "Endpoint allows your to delete a record from the table", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "record_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_record_id_ - The identifier of record", "required": true, "deprecated": false, "explode": true } ], "responses": { "200": { "description": "Returns when the record was successfully deleted", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DeleteRecordResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "delete_record" } }, "/managed_users/{managed_user_id}/tables/{table_id}/records/{record_id}": { "put": { "tags": [ "Tables" ], "summary": "Update record", "description": "Endpoint allows you to update table record in a customer workspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "record_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_record_id_ - The identifier of record", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - UpdateRecordRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/UpdateRecordRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns when the record is successfully updated", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/RecordResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Failed to acquire lock", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "update_record_oem" }, "delete": { "tags": [ "Tables" ], "summary": "Delete record", "description": "Endpoint allows your to delete a record from the table in a customer workspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "record_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_record_id_ - The identifier of record", "required": true, "deprecated": false, "explode": true } ], "responses": { "200": { "description": "Returns when the record was successfully deleted", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DeleteRecordResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "delete_record_oem" } }, "/tables/{table_id}/fields/{field_id}/file": { "post": { "tags": [ "Tables" ], "summary": "Generate file upload link", "description": "Endpoint allows you to create an upload link for file field\n(for use in `create_record` / `update_record`)", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "field_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_field_id_ - The identifier of column", "required": true, "deprecated": false, "explode": true } ], "responses": { "201": { "description": "Returns when the link is successfully generated", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateUploadLinkResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "create_file_upload" } }, "/managed_users/{managed_user_id}/tables/{table_id}/fields/{field_id}/file": { "post": { "tags": [ "Tables" ], "summary": "Generate file upload link", "description": "Endpoint allows you to create an upload link for file field\n(for use in `create_record` / `update_record`)\nin a customer workspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "field_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_field_id_ - The identifier of column", "required": true, "deprecated": false, "explode": true } ], "responses": { "201": { "description": "Returns when the link is successfully generated", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/CreateUploadLinkResponseBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "create_file_upload_oem" } }, "/tables/{table_id}/records/{record_id}/fields/{field_id}/file": { "get": { "tags": [ "Tables" ], "summary": "Download file from the record", "description": "Endpoint allows you to download file from the record for file field", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "record_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_record_id_ - The identifier of the record", "required": true, "deprecated": false, "explode": true }, { "name": "field_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_field_id_ - The identifier of column", "required": true, "deprecated": false, "explode": true } ], "responses": { "303": { "description": "", "headers": { "LOCATION": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Returns when conflict occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "file_download" } }, "/managed_users/{managed_user_id}/tables/{table_id}/records/{record_id}/fields/{field_id}/file": { "get": { "tags": [ "Tables" ], "summary": "Download file from the record", "description": "Endpoint allows you to download file from the record for file field in a customer workspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true }, { "name": "record_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_record_id_ - The identifier of the record", "required": true, "deprecated": false, "explode": true }, { "name": "field_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_field_id_ - The identifier of column", "required": true, "deprecated": false, "explode": true } ], "responses": { "303": { "description": "", "headers": { "LOCATION": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "Returns when conflict occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "file_download_oem" } }, "/tables/{table_id}/query": { "post": { "tags": [ "Tables" ], "summary": "Query records", "description": "Endpoint allows you to specify queries to filter records in the table", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - ApiQueryRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ApiQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the list of documents", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DocumentsQueriedResponse" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "One of the fields used in the query is temporarily locked.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "query_records" }, "delete": { "tags": [ "Tables" ], "summary": "Delete records by a condition", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - ApiDeleteByConditionRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ApiDeleteByConditionRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the list of documents", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DeleteRecordsByConditionsBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Table not found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "One of the fields used in the query is temporarily locked.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "delete_records_by_condition" } }, "/managed_users/{managed_user_id}/tables/{table_id}/query": { "post": { "tags": [ "Tables" ], "summary": "Query records", "description": "Endpoint allows you to specify queries to filter records in the table in a customer\nworkspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - ApiQueryRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ApiQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the list of documents", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DocumentsQueriedResponse" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "One of the fields used in the query is temporarily locked.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "query_records_oem" }, "delete": { "tags": [ "Tables" ], "summary": "Delete records by a condition in a managed workspace", "parameters": [ { "name": "AUTHORIZATION", "schema": { "type": "string" }, "in": "header", "description": "Bearer {token}", "required": true, "deprecated": false, "explode": true }, { "name": "managed_user_id", "schema": { "type": "integer", "format": "uint32" }, "in": "path", "description": "_managed_user_id_ - The identifier of customer environment", "required": true, "deprecated": false, "explode": true }, { "name": "table_id", "schema": { "type": "string", "format": "uuid" }, "in": "path", "description": "_table_id_ - The identifier of table", "required": true, "deprecated": false, "explode": true } ], "requestBody": { "description": "_request_ - ApiDeleteByConditionRequest", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ApiDeleteByConditionRequest" } } }, "required": true }, "responses": { "200": { "description": "Returns the list of documents", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/DeleteRecordsByConditionsBody" } } } }, "400": { "description": "Returns when request is invalid", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bad authorization supplied", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "No access to this resource or endpoint", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Table not found", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "409": { "description": "One of the fields used in the query is temporarily locked.", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Returns when rate limit is exceeded", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "headers": { "RETRY-AFTER": { "required": true, "deprecated": false, "schema": { "type": "string" } } } }, "500": { "description": "Returns when server error occurs", "content": { "application/json; charset=utf-8": { "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } } } }, "operationId": "delete_records_by_condition_oem" } } }, "components": { "schemas": { "AndCompoundingOperator": { "type": "object", "title": "AndCompoundingOperator", "required": [ "$and" ], "properties": { "$and": { "type": "array", "items": { "$ref": "#/components/schemas/ApiQueryWhere" } } } }, "ApiCompoundingOperator": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AndCompoundingOperator" }, { "$ref": "#/components/schemas/OrCompoundingOperator" } ] }, "ApiDeleteByConditionRequest": { "type": "object", "title": "ApiDeleteByConditionRequest", "properties": { "where": { "description": "Records filter. By default returns all the records", "default": {}, "allOf": [ { "$ref": "#/components/schemas/ApiQueryWhere" }, { "description": "Records filter. By default returns all the records", "default": {}, "writeOnly": true } ], "writeOnly": true }, "timezone_offset_secs": { "type": "integer", "format": "int32", "description": "Time zone offset for query. Used for comparing date-time values against date values.\nRequired if the query includes comparison of a date-time field to a date value", "writeOnly": true }, "limit": { "type": "integer", "format": "uint16", "description": "Limit the number of records (max 200)", "writeOnly": true } } }, "ApiDocumentCreateUpdate": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ApiValue" }, "example": { "$$dollar_escaped": "value", "$00000000-0000-0000-0000-000000000000": "value", "field_by_name": "value" } }, "ApiDocumentGetItem": { "type": "object", "title": "ApiDocumentGetItem", "required": [ "field_id", "field_name" ], "properties": { "field_id": { "type": "string", "format": "uuid", "description": "`field_id` - UUID identified of the field" }, "field_name": { "type": "string", "description": "`field_name` - textual name of the field" }, "value": { "description": "`value` - value stored", "allOf": [ { "$ref": "#/components/schemas/ApiValue" }, { "description": "`value` - value stored" } ] } } }, "ApiFileValue": { "type": "object", "title": "ApiFileValue", "properties": { "upload_id": { "type": "string", "format": "uuid", "description": "`upload_id` - upload id", "writeOnly": true }, "filename": { "type": "string", "description": "`filename` - filename visible in the data table" } } }, "ApiOrderDirection": { "type": "string", "enum": [ "asc", "desc" ] }, "ApiQueryConditionRhs": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/ApiQueryValue" }, { "type": "array", "items": { "$ref": "#/components/schemas/ApiQueryValue" } } ] }, "ApiQueryConditions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ApiQueryOperator" } }, "ApiQueryOperator": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ApiQueryConditionRhs" }, { "$ref": "#/components/schemas/EqOperation" }, { "$ref": "#/components/schemas/NeOperation" }, { "$ref": "#/components/schemas/GteOperation" }, { "$ref": "#/components/schemas/GtOperation" }, { "$ref": "#/components/schemas/LteOperation" }, { "$ref": "#/components/schemas/LtOperation" }, { "$ref": "#/components/schemas/InOperation" }, { "$ref": "#/components/schemas/StartsWithOperation" } ] }, "ApiQueryOrder": { "type": "object", "anyOf": [ { "type": "string", "title": "Field specifier", "description": "Can be either:\n- meta field (i.e. `$record_id`, `$created_at`, `$updated_at`)\n- field id (`$00000000-0000-0000-0000-000000000000`)\n- field name (`field_name`)\n\nNote: starting `$` in the field name should be escaped with `$$` if exists", "example": "field_name" }, { "$ref": "#/components/schemas/ApiQueryOrderLong" } ] }, "ApiQueryOrderLong": { "type": "object", "title": "ApiQueryOrderLong", "required": [ "by" ], "properties": { "by": { "type": "string", "title": "Field specifier", "description": "Sort by this field", "writeOnly": true, "example": "field_name" }, "direction": { "description": "Sorting direction (defaults to ascending)", "default": "asc", "allOf": [ { "$ref": "#/components/schemas/ApiOrderDirection" }, { "description": "Sorting direction (defaults to ascending)", "default": "asc", "writeOnly": true } ], "writeOnly": true }, "case_sensitive": { "type": "boolean", "description": "Sorting case-sensitivity (defaults to case-insensitive).\nMay only be specified for string fields.", "writeOnly": true } } }, "ApiQueryRecordFieldSchema": { "type": "object", "title": "ApiQueryRecordFieldSchema", "required": [ "name" ], "properties": { "name": { "type": "string", "readOnly": true }, "id": { "type": "string", "format": "uuid", "readOnly": true } } }, "ApiQueryRequest": { "type": "object", "title": "ApiQueryRequest", "description": "Query request", "properties": { "select": { "type": "array", "description": "Select fields to return. By default all fields will be returned", "items": { "type": "string", "title": "Field specifier", "description": "Can be either:\n- field id (`$00000000-0000-0000-0000-000000000000`)\n- field name (`field_name`)\n\nNote: starting `$` in the field name should be escaped with `$$` if exists" }, "writeOnly": true }, "where": { "description": "Records filter. By default returns all the records", "default": {}, "allOf": [ { "$ref": "#/components/schemas/ApiQueryWhere" }, { "description": "Records filter. By default returns all the records", "default": {}, "writeOnly": true } ], "writeOnly": true }, "order": { "description": "Order by. Results are ordered by `$created_at` by default", "default": "$created_at", "allOf": [ { "$ref": "#/components/schemas/ApiQueryOrder" }, { "description": "Order by. Results are ordered by `$created_at` by default", "default": "$created_at", "writeOnly": true } ], "writeOnly": true }, "timezone_offset_secs": { "type": "integer", "format": "int32", "description": "Time zone offset for query. Used for comparing date-time values against date values.\nRequired if the query includes comparison of a date-time field to a date value", "writeOnly": true }, "limit": { "type": "integer", "format": "uint16", "description": "Limit the number of records (max 200)", "writeOnly": true }, "continuation_token": { "type": "string", "description": "Continuation Token to use", "writeOnly": true } } }, "ApiQueryValue": { "type": "object", "anyOf": [ { "type": "boolean" }, { "type": "integer", "format": "int64" }, { "type": "number", "format": "double" }, { "type": "string" } ] }, "ApiQueryWhere": { "type": "object", "anyOf": [ { "$ref": "#/components/schemas/ApiCompoundingOperator" }, { "$ref": "#/components/schemas/ApiQueryConditions" } ] }, "ApiRecord": { "type": "object", "title": "ApiRecord", "required": [ "record_id", "document", "created_at", "updated_at" ], "properties": { "record_id": { "type": "string", "format": "uuid", "readOnly": true }, "document": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDocumentGetItem" }, "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "ApiRelationValue": { "type": "object", "title": "ApiRelationValue", "required": [ "record_id" ], "properties": { "record_id": { "type": "string", "format": "uuid", "description": "`record_id` - UUID identifier of the record" }, "value": { "type": "string", "description": "`value` - Value stored in the referenced table (can't be passed by client)", "readOnly": true }, "invalid": { "type": "boolean", "description": "`invalid` - this field is only present when reference is invalid\n(which may happen if referenced record is deleted).", "readOnly": true } } }, "ApiValue": { "anyOf": [ { "type": "boolean" }, { "type": "integer", "format": "int64" }, { "type": "number", "format": "double" }, { "type": "string" }, { "$ref": "#/components/schemas/ApiFileValue" }, { "$ref": "#/components/schemas/ApiRelationValue" }, { "type": "array", "items": { "$ref": "#/components/schemas/ApiValueArrayItem" } } ] }, "ApiValueArrayItem": { "type": "object", "anyOf": [ { "type": "boolean" }, { "type": "integer", "format": "int64" }, { "type": "number", "format": "double" }, { "type": "string" }, { "$ref": "#/components/schemas/ApiRelationValue" } ] }, "CaseSensitiveUnaryOp": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ApiQueryConditionRhs" }, { "$ref": "#/components/schemas/CaseSensitiveUnaryOpLong" } ] }, "CaseSensitiveUnaryOpLong": { "type": "object", "title": "CaseSensitiveUnaryOpLong", "required": [ "value" ], "properties": { "value": { "description": "Comparison value", "allOf": [ { "$ref": "#/components/schemas/ApiQueryConditionRhs" }, { "description": "Comparison value", "writeOnly": true } ], "writeOnly": true }, "case_sensitive": { "type": "boolean", "description": "Case-sensitivity (defaults to case-insensitive)", "writeOnly": true } } }, "CreateRecordRequest": { "type": "object", "title": "CreateRecordRequest", "required": [ "document" ], "properties": { "document": { "description": "Document to create.\n\nFields can be specified using their names or UUIDs.\nFields not listed in the schema will be replaced with default values.\nExtra fields (fields that aren't in the schema) are ignored.", "allOf": [ { "$ref": "#/components/schemas/ApiDocumentCreateUpdate" }, { "description": "Document to create.\n\nFields can be specified using their names or UUIDs.\nFields not listed in the schema will be replaced with default values.\nExtra fields (fields that aren't in the schema) are ignored." } ] } } }, "CreateUploadLinkResponseBody": { "type": "object", "title": "CreateUploadLinkResponseBody", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UploadLink" } } }, "DeleteRecordResponseBody": { "type": "object", "title": "DeleteRecordResponseBody", "required": [ "data" ], "properties": { "data": {} } }, "DeleteRecordsByConditionsBody": { "type": "object", "title": "DeleteRecordsByConditionsBody", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/DeleteRecordsByConditionsOkBody" } } }, "DeleteRecordsByConditionsOkBody": { "type": "object", "title": "DeleteRecordsByConditionsOkBody", "required": [ "num_records_deleted" ], "properties": { "num_records_deleted": { "type": "integer", "format": "uint32" } } }, "DocumentsQueriedResponse": { "type": "object", "title": "DocumentsQueriedResponse", "required": [ "schema", "data", "count", "limit" ], "properties": { "schema": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiQueryRecordFieldSchema" } }, "readOnly": true }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiValue" } } }, "readOnly": true }, "count": { "type": "integer", "format": "uint64", "readOnly": true }, "limit": { "type": "integer", "format": "uint16", "readOnly": true }, "continuation_token": { "type": "string", "readOnly": true } } }, "EqOperation": { "type": "object", "title": "EqOperation", "required": [ "$eq" ], "properties": { "$eq": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "Error": { "type": "object", "title": "Error", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "Internal code of error to identify the reason" }, "title": { "type": "string", "description": "Error message (i.e human readable message)" }, "detail": { "type": "string", "description": "Error details" } } }, "ErrorResponse": { "type": "object", "title": "ErrorResponse", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "maxLength": 1, "minLength": 1 } } }, "GeneralServerError": { "type": "object", "title": "GeneralServerError" }, "GtOperation": { "type": "object", "title": "GtOperation", "required": [ "$gt" ], "properties": { "$gt": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "GteOperation": { "type": "object", "title": "GteOperation", "required": [ "$gte" ], "properties": { "$gte": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "InOperation": { "type": "object", "title": "InOperation", "required": [ "$in" ], "properties": { "$in": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "InternalServerError": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/InternalServerError_RequestProcessingTimeout" }, { "$ref": "#/components/schemas/InternalServerError_GeneralServerError" } ], "discriminator": { "propertyName": "code", "mapping": { "TIMEOUT": "#/components/schemas/InternalServerError_RequestProcessingTimeout", "INTERNAL_SERVER_ERROR": "#/components/schemas/InternalServerError_GeneralServerError" } } }, "InternalServerErrorResponse": { "type": "object", "title": "InternalServerErrorResponse", "description": "Typed representation of Internal Server Error response for Workato's Public API", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/InternalServerError" }, "maxLength": 1, "minLength": 1 } } }, "InternalServerError_GeneralServerError": { "allOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "INTERNAL_SERVER_ERROR" ], "example": "INTERNAL_SERVER_ERROR" } } }, { "$ref": "#/components/schemas/GeneralServerError" } ] }, "InternalServerError_RequestProcessingTimeout": { "allOf": [ { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "enum": [ "TIMEOUT" ], "example": "TIMEOUT" } } }, { "$ref": "#/components/schemas/RequestProcessingTimeout" } ] }, "LtOperation": { "type": "object", "title": "LtOperation", "required": [ "$lt" ], "properties": { "$lt": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "LteOperation": { "type": "object", "title": "LteOperation", "required": [ "$lte" ], "properties": { "$lte": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "NeOperation": { "type": "object", "title": "NeOperation", "required": [ "$ne" ], "properties": { "$ne": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "OrCompoundingOperator": { "type": "object", "title": "OrCompoundingOperator", "required": [ "$or" ], "properties": { "$or": { "type": "array", "items": { "$ref": "#/components/schemas/ApiQueryWhere" } } } }, "RecordResponseBody": { "type": "object", "title": "RecordResponseBody", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/ApiRecord" } } }, "RequestProcessingTimeout": { "type": "object", "title": "RequestProcessingTimeout" }, "StartsWithOperation": { "type": "object", "title": "StartsWithOperation", "required": [ "$starts_with" ], "properties": { "$starts_with": { "$ref": "#/components/schemas/CaseSensitiveUnaryOp" } } }, "UpdateRecordRequest": { "type": "object", "title": "UpdateRecordRequest", "required": [ "document" ], "properties": { "document": { "description": "Document fields to update.\n\nFields can be specified using their names or UUIDs.\nFields not listed in the schema will not be touched.\nExtra fields (fields that aren't in the schema) are ignored.", "allOf": [ { "$ref": "#/components/schemas/ApiDocumentCreateUpdate" }, { "description": "Document fields to update.\n\nFields can be specified using their names or UUIDs.\nFields not listed in the schema will not be touched.\nExtra fields (fields that aren't in the schema) are ignored." } ] } } }, "UploadLink": { "type": "object", "title": "UploadLink", "required": [ "upload_id", "url" ], "properties": { "upload_id": { "type": "string", "format": "uuid" }, "url": { "type": "string" } } } } } }