Module: Grist::ApiRoutes

Defined in:
lib/grist/api_routes.rb

Constant Summary collapse

ORG_ALL =

ORGANIZATIONS

"https://{gristhost}/api/orgs"
ORG_FIND = 
"https://{gristhost}/api/orgs/{orgId}"
ORG_UPDATE = 
"https://{gristhost}/api/orgs/{orgId}"
ORG_DELETE = 
"https://{gristhost}/api/orgs/{orgId}"
ORG_ACCESS_ALL =

ORG ACCESS

"https://{gristhost}/api/orgs/{orgId}/access"
ORG_ACCESS_UPDATE = 
"https://{gristhost}/api/orgs/{orgId}/access"
WORKSPACE_ALL =

ORG WORKSPACE

"https://{gristhost}/api/orgs/{orgId}/workspaces"
WORKSPACE_CREATE = 
"https://{gristhost}/api/orgs/{orgId}/workspaces"
WORKSPACE_FIND =

WORKSPACES

"https://{gristhost}/api/workspaces/{workspaceId}"
WORKSPACE_UPDATE = 
"https://{gristhost}/api/workspaces/{workspaceId}"
WORKSPACE_DELETE = 
"https://{gristhost}/api/workspaces/{workspaceId}"
WORKSPACE_ACCESS_ALL =

WORKSPACE ACCESS

"https://{gristhost}/api/workspaces/{orgId}/access"
WORKSPACE_ACCESS_UPDATE = 
"https://{gristhost}/api/workspaces/{orgId}/access"
DOC_CREATE =

WORKSPACE DOCUMENTS

"https://{gristhost}/api/workspaces/{workspaceId}/docs"
DOC_FIND =

DOCUMENTS

"https://{gristhost}/api/docs/{docId}"
DOC_UPDATE = 
"https://{gristhost}/api/docs/{docId}"
DOC_DELETE = 
"https://{gristhost}/api/docs/{docId}"
DOC_MOVE = 
"https://{gristhost}/api/docs/{docId}/move"
DOC_ACCESS_ALL =

DOC ACCESS

"https://{gristhost}/api/docs/{docId}/access"
DOC_ACCESS_UPDATE = 
"https://{gristhost}/api/docs/{docId}/access"
DOC_DL_SQL =

DOC ACCESS

"https://{gristhost}/api/docs/{docId}/download"
DOC_DL_EXCEL = 
"https://{gristhost}/api/docs/{docId}/download/xlsx"
DOC_DL_CSV = 
"https://{gristhost}/api/docs/{docId}/download/csv"
DOC_DL_TABLE_SCHEMA = 
"https://{gristhost}/api/docs/{docId}/download/table-schema"
DOC_TRUNCATE_HISTORY = 
"https://{gristhost}/api/docs/{docId}/states/remove"
DOC_FORCE_RELOAD = 
"https://{gristhost}/api/docs/{docId}/force-reload"
DOC_CLEAR_QUEUE = 
"https://{gristhost}/api/docs/{docId}/webhooks/queue"
RECORD_ALL =

RECORDS

"https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
RECORD_CREATE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
RECORD_UPDATE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
RECORD_ADD_OR_UPDATE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/records"
TABLE_ALL =

TABLES

"https://{gristhost}/api/docs/{docId}/tables"
TABLE_CREATE = 
"https://{gristhost}/api/docs/{docId}/tables"
TABLE_UPDATE = 
"https://{gristhost}/api/docs/{docId}/tables"
COLUMN_ALL =

COLUMNS

"https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
COLUMN_CREATE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
COLUMN_UPDATE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
COLUMN_ADD_OR_UPDATE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns"
COLUMN_DELETE = 
"https://{gristhost}/api/docs/{docId}/tables/{tableId}/columns/{colId}"
ROW_DELETE =

ROWS

"https://{gristhost}/api/docs/{docId}/tables/{tableId}/data/delete"
ATTACHMENT_ALL =

ATTACHMENTS

"https://{gristhost}/api/docs/{docId}/attachments"
ATTACHMENT_UPDATE = 
"https://{gristhost}/api/docs/{docId}/attachments"
ATTACHMENT_METADATA = 
"https://{gristhost}/api/docs/{docId}/attachments/{attachmentId}"
ATTACHMENT_DL_CONTENT = 
"https://{gristhost}/api/docs/{docId}/attachments/{attachmentId}/download"
WEBHOOK_ALL =

WEBHOOKS

"https://{gristhost}/api/docs/{docId}/webhooks"
WEBHOOK_CREATE = 
"https://{gristhost}/api/docs/{docId}/webhooks"
WEBHOOK_UPDATE = 
"https://{gristhost}/api/docs/{docId}/webhooks/{webhookId}"
WEBHOOK_DELETE = 
"https://{gristhost}/api/docs/{docId}/webhooks/{webhookId}"
USER_DELETE = 
"https://{gristhost}/api/users/{userId}"