{ "swagger": "2.0", "info": { "version": "v1", "title": "Rest API v1" }, "host": "ft-nostress.chili-publish-sandbox.online", "schemes": [ "http", "https" ], "paths": { "/rest-api/v1/resources/{assetType}/download/tempfile": { "get": { "tags": [ "Resources" ], "summary": "DownloadTempFile", "description": "Download a temporary asset file from the server\r\nSoap API equivalent is 'DownloadTempFile'", "operationId": "RestApi_DownloadTempFile", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "assetType", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "path", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "data", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "dynamicAssetProviderID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "noContentHeader", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/folders/move": { "put": { "tags": [ "Resources" ], "summary": "ResourceFolderMove", "description": "Moves a Resource folder to a new location in the Resource's tree\r\nSoap API equivalent is 'ResourceFolderMove'", "operationId": "RestApi_ResourceFolderMove", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "Name of the Resource in which to find the folder", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The folder to move", "required": true, "type": "string" }, { "name": "newFolderPath", "in": "query", "description": "The new folder location", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetByIdOrPath", "description": "Returns a ResourceItem based on its ID (checked first) or path in the Resource's tree (or, if the resource is of type list, its name)\r\nSoap API equivalent is 'ResourceItemGetByIdOrPath'", "operationId": "RestApi_ResourceItemGetByIdOrPath", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemIdOrPath", "in": "query", "description": "The id or relative path to the Resource Item to find", "required": true, "type": "string" }, { "name": "includeSubFolders", "in": "query", "description": "If true, search will include subfolders", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "post": { "tags": [ "Resources" ], "summary": "ResourceItemAdd", "description": "Adds a ResourceItem to the specified Resource, and returns its definition XML\r\nSoap API equivalent is 'ResourceItemAdd'", "operationId": "RestApi_ResourceItemAdd", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name of the new resource item", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemAddBodyWrapper" } }, { "name": "folderPath", "in": "query", "description": "The relative path of the resource item in the resource's tree (for resources of type directory_object or directory_file)", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/fromzip": { "post": { "tags": [ "Resources" ], "summary": "ResourceItemsAddFromZip", "description": "Adds ResourceItems to the specified Resource, based on a ZIP file\r\nSoap API equivalent is 'ResourceItemsAddFromZip'", "operationId": "RestApi_ResourceItemsAddFromZip", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The relative path of the resource items in the resource's tree", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemsAddFromZipBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/paged": { "get": { "tags": [ "Resources" ], "summary": "ResourceSearchPaged", "description": "Search for items in the resource, and returns a paged result list\r\nSoap API equivalent is 'ResourceSearchPaged'", "operationId": "RestApi_ResourceSearchPaged", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "name", "in": "query", "description": "The name to search on", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Number of items per page", "required": false, "type": "integer", "format": "int32" }, { "name": "pageNum", "in": "query", "description": "1-based index of the page to return", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/transformedurl": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetTransformedURL", "description": "Returns a url pointing to the preview (in the specified type and for the specified page, and with the provided Transformation effects) of the ResourceItem\r\nSoap API equivalent is 'ResourceItemGetTransformedURL'", "operationId": "RestApi_ResourceItemGetTransformedURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The type of URL", "required": true, "type": "string" }, { "name": "transformationID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pageNum", "in": "query", "description": "The page number (1-based)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/transformedurldebug": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetTransformedURLWithDebugInfo", "description": "Returns a url pointing to the preview (in the specified type and for the specified page, and with the provided Transformation effects) of the ResourceItem, similar to ResourceItemGetTransformedURL. But the current function also includes information which can be used to debug the generated preview (file size, dimensions, ...)\r\nSoap API equivalent is 'ResourceItemGetTransformedURLWithDebugInfo'", "operationId": "RestApi_ResourceItemGetTransformedURLWithDebugInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The type of URL", "required": true, "type": "string" }, { "name": "transformationID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pageNum", "in": "query", "description": "The page number (1-based)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/treelevel": { "get": { "tags": [ "Resources" ], "summary": "ResourceGetTreeLevel", "description": "Returns the tree structure of the Resource (if the type of the resource is \"directory_file\" or \"directory_object\"), with a maximum number of sub-folders included. Use '1' to get the files and folders without any files inside the folders\r\nSoap API equivalent is 'ResourceGetTreeLevel'", "operationId": "RestApi_ResourceGetTreeLevel", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "parentFolder", "in": "query", "description": "The folder where to start listing contents", "required": false, "type": "string" }, { "name": "numLevels", "in": "query", "description": "The amount of levels to return", "required": false, "type": "integer", "format": "int32" }, { "name": "includeSubDirectories", "in": "query", "description": "If true, the tree also contains the directories under parentFolder", "required": false, "type": "boolean" }, { "name": "includeFiles", "in": "query", "description": "If true, the tree structure is returned including files (ResourceItems)", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/fromurlmod": { "post": { "tags": [ "Resources" ], "summary": "ResourceItemAddFromURLWithModificationDate", "description": "Adds a ResourceItem by downloading the underlying file from an external URL\r\nSoap API equivalent is 'ResourceItemAddFromURLWithModificationDate'", "operationId": "RestApi_ResourceItemAddFromURLWithModificationDate", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name for the new resource item", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "Location for the new ResourceItem.", "required": true, "type": "string" }, { "name": "url", "in": "query", "description": "URL to download (needs to be accessible from the CHILI server)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemAddFromURLWithModificationDateBodyWrapper" } }, { "name": "login", "in": "query", "description": "Optional user name for authentication into the URL (passed on using Basic Authentication)", "required": false, "type": "string" }, { "name": "pw", "in": "query", "description": "Optional user password for authentication into the URL (passed on using Basic Authentication)", "required": false, "type": "string" }, { "name": "reuseExisting", "in": "query", "description": "If true, the function will check if an item already exists in the Resource with the provided path/name. If it does, the existing ResourceItem is returned, and the URL is not downloaded.", "required": false, "type": "boolean" }, { "name": "previewFileURL", "in": "query", "description": "Optional URL to a preview file. If provided, this is downloaded and used as a preview override file.", "required": false, "type": "string" }, { "name": "previewExtension", "in": "query", "description": "The extension of the downloaded preview file (if provided)", "required": false, "type": "string" }, { "name": "isPermanentPreview", "in": "query", "description": "If true, the provided preview override file remains valid even after the ResourceItem is modified", "required": false, "type": "boolean" }, { "name": "modificationDate", "in": "query", "description": "Modification date (should be the same format and timezone as GetServerDate api call returns) of the external resource", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/folders/copy": { "post": { "tags": [ "Resources" ], "summary": "ResourceFolderCopy", "description": "Copies a Resource folder to a new location in the Resource's tree\r\nSoap API equivalent is 'ResourceFolderCopy'", "operationId": "RestApi_ResourceFolderCopy", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "Name of the Resource in which to find the folder", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The folder to move", "required": true, "type": "string" }, { "name": "newFolderPath", "in": "query", "description": "The new folder location", "required": true, "type": "string" }, { "name": "includeSubFolders", "in": "query", "description": "", "required": true, "type": "boolean" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{id}/metadata": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetCustomMetaData", "description": "Returns metadata of the object\r\nSoap API equivalent is 'ResourceItemGetCustomMetaData'", "operationId": "RestApi_ResourceItemGetCustomMetaData", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "setName", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "put": { "tags": [ "Resources" ], "summary": "ResourceItemSaveCustomMetaData", "description": "Saves metadata of specified resource item\r\nSoap API equivalent is 'ResourceItemSaveCustomMetaData'", "operationId": "RestApi_ResourceItemSaveCustomMetaData", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "id", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "setName", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemSaveCustomMetaDataBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/nextitemid": { "post": { "tags": [ "Resources" ], "summary": "SetNextResourceItemID", "description": "Set the GUID for the next item in the queue.\r\nIt will be used when adding items via \"ResourceItemAdd\" or equivalents\r\nSoap API equivalent is 'SetNextResourceItemID'", "operationId": "RestApi_SetNextResourceItemID", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "query", "description": "The itemID (guid) to be added to the queue", "required": true, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/sorted": { "get": { "tags": [ "Resources" ], "summary": "ResourceSearchPagedWithSorting", "description": "Search for items in the resource, and returns a sorted paged result list.\r\nWhen using paging, you can either specify a page number or a an item id.\r\n\r\nSoap API equivalent is 'ResourceSearchPagedWithSorting'", "operationId": "RestApi_ResourceSearchPagedWithSorting", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "parentFolderPath", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "includeSubDirectories", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "name", "in": "query", "description": "The name to search on", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Number of items per page", "required": false, "type": "integer", "format": "int32" }, { "name": "pageNum", "in": "query", "description": "1-based index of the page to return", "required": false, "type": "integer", "format": "int32" }, { "name": "sortOn", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "sortOrder", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "itemID", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}": { "get": { "tags": [ "Resources" ], "summary": "ResourceSearch", "description": "Search for items in the resource\r\nSoap API equivalent is 'ResourceSearch'", "operationId": "RestApi_ResourceSearch", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "name", "in": "query", "description": "The name to search on", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/tree": { "get": { "tags": [ "Resources" ], "summary": "ResourceGetTree", "description": "Returns the tree structure of the Resource (if the type of the resource is \"directory_file\" or \"directory_object\")\r\nSoap API equivalent is 'ResourceGetTree'", "operationId": "RestApi_ResourceGetTree", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "parentFolder", "in": "query", "description": "The folder where to start listing contents", "required": false, "type": "string" }, { "name": "includeSubDirectories", "in": "query", "description": "If true, the tree also contains the directories under parentFolder", "required": false, "type": "boolean" }, { "name": "includeFiles", "in": "query", "description": "If true, the tree structure is returned including files (ResourceItems)", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/fromurl": { "post": { "tags": [ "Resources" ], "summary": "ResourceItemAddFromURL", "description": "Adds a ResourceItem by downloading the underlying file from an external URL\r\nSoap API equivalent is 'ResourceItemAddFromURL'", "operationId": "RestApi_ResourceItemAddFromURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name for the new resource item", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "Location for the new ResourceItem.", "required": true, "type": "string" }, { "name": "url", "in": "query", "description": "URL to download (needs to be accessible from the CHILI server)", "required": true, "type": "string" }, { "name": "login", "in": "query", "description": "Optional user name for authentication into the URL (passed on using Basic Authentication)", "required": false, "type": "string" }, { "name": "pw", "in": "query", "description": "Optional user password for authentication into the URL (passed on using Basic Authentication)", "required": false, "type": "string" }, { "name": "reuseExisting", "in": "query", "description": "If true, the function will check if an item already exists in the Resource with the provided path/name. If it does, the existing ResourceItem is returned, and the URL is not downloaded.", "required": false, "type": "boolean" }, { "name": "previewFileURL", "in": "query", "description": "Optional URL to a preview file. If provided, this is downloaded and used as a preview override file.", "required": false, "type": "string" }, { "name": "previewExtension", "in": "query", "description": "The extension of the downloaded preview file (if provided)", "required": false, "type": "string" }, { "name": "isPermanentPreview", "in": "query", "description": "If true, the provided preview override file remains valid even after the ResourceItem is modified", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/previews": { "put": { "tags": [ "Resources" ], "summary": "ResourceItemAddPreviewOverride", "description": "Adds an override file to the ResourceItem, which is used to generate previews\r\nSoap API equivalent is 'ResourceItemAddPreviewOverride'", "operationId": "RestApi_ResourceItemAddPreviewOverride", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the item", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemAddPreviewOverrideBodyWrapper" } }, { "name": "previewExtension", "in": "query", "description": "Extension (\"jpg\", \"png\", ...) of the preview file", "required": false, "type": "string" }, { "name": "isPermanentPreview", "in": "query", "description": "If true, the preview override remains valid even after the resource item is modified", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "delete": { "tags": [ "Resources" ], "summary": "ResourceItemResetPreviews", "description": "Deletes all generated previews of the ResourceItem, and resets any \"error\" switches\r\nSoap API equivalent is 'ResourceItemResetPreviews'", "operationId": "RestApi_ResourceItemResetPreviews", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/copy": { "post": { "tags": [ "Resources" ], "summary": "ResourceItemCopy", "description": "Copies a ResourceItem, and returns the definition XML of the new item.\r\nSoap API equivalent is 'ResourceItemCopy'", "operationId": "RestApi_ResourceItemCopy", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the item to copy", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name for the new ResourceItem", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The location (relative path within the Resource's tree) for the new ResourceItem", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/previewoverride": { "delete": { "tags": [ "Resources" ], "summary": "ResourceItemRemovePreviewOverride", "description": "Deletes the preview override files for a ResourceItem\r\nSoap API equivalent is 'ResourceItemRemovePreviewOverride'", "operationId": "RestApi_ResourceItemRemovePreviewOverride", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/preview": { "post": { "tags": [ "Resources" ], "summary": "ResourceItemAddWithPreview", "description": "Adds a ResourceItem to a Resource, and returns its definition XML.\r\nTo prevent previews from being generated automatically while you intend to supply an override file, this function allows you to pass both at the same time.\r\nSoap API equivalent is 'ResourceItemAddWithPreview'", "operationId": "RestApi_ResourceItemAddWithPreview", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The resource name", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name of the new resource item", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The relative path of the resource item in the resource's tree (for resources of type directory_object or directory_file)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemAddWithPreviewBodyWrapper" } }, { "name": "previewExtension", "in": "query", "description": "The extension of the preview file. If previewFileData contains a path, the extension is optional", "required": false, "type": "string" }, { "name": "isPermanentPreview", "in": "query", "description": "If true, the preview override remains valid even after the resource item is modified", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/anonymousurl": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetURLForAnonymousUser", "description": "Returns a url pointing to the preview (in the specified type and for the specified page) of the ResourceItem.\r\nThe URL contains an apiKey for the Anonymous user (which does not expire, and has highly limited privileges).\r\nSoap API equivalent is 'ResourceItemGetURLForAnonymousUser'", "operationId": "RestApi_ResourceItemGetURLForAnonymousUser", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The type of preview", "required": true, "type": "string" }, { "name": "pageNum", "in": "query", "description": "The page number (1-based)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/url": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetURL", "description": "Returns a url pointing to the preview (in the specified type and for the specified page) of the ResourceItem\r\nSoap API equivalent is 'ResourceItemGetURL'", "operationId": "RestApi_ResourceItemGetURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The type of URL", "required": true, "type": "string" }, { "name": "pageNum", "in": "query", "description": "The page number (1-based)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/definitionxml": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetDefinitionXML", "description": "Returns the definition XML of a ResourceItem\r\nSoap API equivalent is 'ResourceItemGetDefinitionXML'", "operationId": "RestApi_ResourceItemGetDefinitionXML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/xml": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetXML", "description": "Returns the underlying XML of the object (for a Resource of type directory_object), or the definition XML for other types\r\nSoap API equivalent is 'ResourceItemGetXML'", "operationId": "RestApi_ResourceItemGetXML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/history": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetHistory", "description": "Returns the history of a ResourceItem\r\nSoap API equivalent is 'ResourceItemGetHistory'", "operationId": "RestApi_ResourceItemGetHistory", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/cacheinfo": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetCacheInfo", "description": "Returns XML describing the state of the cache (previews, ...) of the ResourceItem\r\nSoap API equivalent is 'ResourceItemGetCacheInfo'", "operationId": "RestApi_ResourceItemGetCacheInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the resource item", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/history": { "get": { "tags": [ "Resources" ], "summary": "ResourceGetHistory", "description": "Returns the history of a Resource\r\nSoap API equivalent is 'ResourceGetHistory'", "operationId": "RestApi_ResourceGetHistory", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/folders/settings": { "get": { "tags": [ "Resources" ], "summary": "ResourceLibraryGetSettings", "description": "Returns the settings of the specified Library (a top-level directory in the Resource's tree)\r\nSoap API equivalent is 'ResourceLibraryGetSettings'", "operationId": "RestApi_ResourceLibraryGetSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "libraryName", "in": "query", "description": "The name of the library for which to return the settings", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "put": { "tags": [ "Resources" ], "summary": "ResourceLibrarySaveSettings", "description": "Saves the settings of the specified Library (a top-level directory in the Resource's tree)\r\nSoap API equivalent is 'ResourceLibrarySaveSettings'", "operationId": "RestApi_ResourceLibrarySaveSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "folderName", "in": "query", "description": "The name of the library for which to save the settings", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceLibrarySaveSettingsBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/folders": { "post": { "tags": [ "Resources" ], "summary": "ResourceFolderAdd", "description": "Adds a folder to a Resource (if it is of type directory_object or directory_file\r\nSoap API equivalent is 'ResourceFolderAdd'", "operationId": "RestApi_ResourceFolderAdd", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource in which to add a folder", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name for the new folder", "required": true, "type": "string" }, { "name": "parentPath", "in": "query", "description": "The location of the folder", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } }, "delete": { "tags": [ "Resources" ], "summary": "ResourceFolderDelete", "description": "Removes a folder from a Resource tree (if it is of type directory_object or directory_file\r\nSoap API equivalent is 'ResourceFolderDelete'", "operationId": "RestApi_ResourceFolderDelete", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource in which to delete the folder", "required": true, "type": "string" }, { "name": "relativePath", "in": "query", "description": "The relative path (in the resource's tree) of the folder to delete", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}": { "delete": { "tags": [ "Resources" ], "summary": "ResourceItemDelete", "description": "Deletes a ResourceItem\r\nSoap API equivalent is 'ResourceItemDelete'", "operationId": "RestApi_ResourceItemDelete", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem to delete", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/byname": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetByName", "description": "Gets the definition XML of a ResourceItem based on its name. For Resources of type directory_object or directory_list, the first found item (being the oldest) is returned\r\nSoap API equivalent is 'ResourceItemGetByName'", "operationId": "RestApi_ResourceItemGetByName", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemName", "in": "query", "description": "The name of the Resource Item to find", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/bypath": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetByPath", "description": "Returns a ResourceItem based on its path in the Resource's tree\r\nSoap API equivalent is 'ResourceItemGetByPath'", "operationId": "RestApi_ResourceItemGetByPath", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemPath", "in": "query", "description": "The relative path to the Resource Item to find", "required": true, "type": "string" }, { "name": "includeSubFolders", "in": "query", "description": "If true, search will include subfolders", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/save": { "put": { "tags": [ "Resources" ], "summary": "ResourceItemSave", "description": "Saves the definition XML or the underlying object XML of a Resource Item (depending on the Resource's type)\r\nSoap API equivalent is 'ResourceItemSave'", "operationId": "RestApi_ResourceItemSave", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemSaveBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/infolder": { "get": { "tags": [ "Resources" ], "summary": "ResourceSearchInFolder", "description": "Search for items in the resource\r\nSoap API equivalent is 'ResourceSearchInFolder'", "operationId": "RestApi_ResourceSearchInFolder", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource in which to search", "required": true, "type": "string" }, { "name": "parentFolderPath", "in": "query", "description": "The folder path where the search will originate", "required": true, "type": "string" }, { "name": "includeSubDirectories", "in": "query", "description": "If true, the search will include files of sub-directories", "required": false, "type": "boolean" }, { "name": "name", "in": "query", "description": "The name to search on", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/move": { "put": { "tags": [ "Resources" ], "summary": "ResourceItemMove", "description": "Moves a Resource Item to a new location in the Resource's tree\r\nSoap API equivalent is 'ResourceItemMove'", "operationId": "RestApi_ResourceItemMove", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "Name of the Resource in which to find the item", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the item to move", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The new name for the Resource Item", "required": true, "type": "string" }, { "name": "newFolderPath", "in": "query", "description": "The new folder for the resource item", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/filewithpreview": { "put": { "tags": [ "Resources" ], "summary": "ResourceItemReplaceFileWithPreviewOverride", "description": "Replaces the underlying file of a Resource Item of type directory_file, and returns its definition XML.\r\nTo prevent previews from being generated automatically while you intend to supply an override file, this function allows you to pass both at the same time.\r\nSoap API equivalent is 'ResourceItemReplaceFileWithPreviewOverride'", "operationId": "RestApi_ResourceItemReplaceFileWithPreviewOverride", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemReplaceFileWithPreviewOverrideBodyWrapper" } }, { "name": "previewExtension", "in": "query", "description": "The extension of the preview file", "required": false, "type": "string" }, { "name": "isPermanentPreview", "in": "query", "description": "If true, the preview override remains valid after the ResourceItem is modified", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/file": { "put": { "tags": [ "Resources" ], "summary": "ResourceItemReplaceFile", "description": "Replaces the underlying file of a Resource Item of type directory_file, and returns its definition XML.\r\nSoap API equivalent is 'ResourceItemReplaceFile'", "operationId": "RestApi_ResourceItemReplaceFile", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ResourceItemReplaceFileBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/privateinfo": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetPrivateInfo", "description": "Returns XML describing the state of the private data (previewErrors, fileinfo, ...) of the ResourceItem\r\nSoap API equivalent is 'ResourceItemGetPrivateInfo'", "operationId": "RestApi_ResourceItemGetPrivateInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the resource item", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/byid": { "get": { "tags": [ "Resources" ], "summary": "ResourceSearchByIDs", "description": "Search for items in the resource, based on a list of IDs\r\nSoap API equivalent is 'ResourceSearchByIDs'", "operationId": "RestApi_ResourceSearchByIDs", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "IDs", "in": "query", "description": "A ';' separated list of IDs to search for", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceName}/items/{itemID}/debugurl": { "get": { "tags": [ "Resources" ], "summary": "ResourceItemGetURLWithDebugInfo", "description": "Returns a url pointing to the preview (in the specified type and for the specified page) of the ResourceItem, similar to ResourceItemGetURL. But the current function also includes information which can be used to debug the generated preview (file size, dimensions, ...)\r\nSoap API equivalent is 'ResourceItemGetURLWithDebugInfo'", "operationId": "RestApi_ResourceItemGetURLWithDebugInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceName", "in": "path", "description": "The name of the Resource", "required": true, "type": "string" }, { "name": "itemID", "in": "path", "description": "The ID of the ResourceItem", "required": true, "type": "string" }, { "name": "type", "in": "query", "description": "The type of URL", "required": true, "type": "string" }, { "name": "pageNum", "in": "query", "description": "The page number (1-based)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/{resourceType}/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadAssets", "description": "Download an Asset from the server\r\nSoap API equivalent is 'DownloadAssets'", "operationId": "RestApi_DownloadAssets", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "resourceType", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "id", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "path", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "type", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "page", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "client_app", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "colorType", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "noContentHeader", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "taskId", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "docId", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "scale", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "ipadItemPath", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "transformationID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "transformationName", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "async", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/3dmodels/{threeDModelId}/package": { "get": { "tags": [ "Resources" ], "summary": "ThreeDModelCreatePackage", "description": "Returns a ZIP with all the needed recources and the settings file with fixed references.\r\nSoap API equivalent is 'ThreeDModelCreatePackage'", "operationId": "RestApi_ThreeDModelCreatePackage", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "threeDModelId", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/withsetting": { "post": { "tags": [ "System" ], "summary": "GenerateApiKeyWithSettings", "description": "Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments. Date formatting was changed from version 1.2. The timezone can be checked by calling GetServerDate api method.\r\nSoap API equivalent is 'GenerateApiKeyWithSettings'\r\nSoap API equivalent is 'GenerateApiKeyWithSettings'", "operationId": "RestApi_GenerateApiKeyWithSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentNameOrURL", "in": "query", "description": "The identifier for the environment in which to log in\r\n \r\n This can be:\r\n - the name of the environment\r\n - one of the values entered in the URLs setting of the environment\r\n - the full URL to the backoffice (eg: http://www.domain.com/CHILI/ENVIRONMENT_NAME/interface.aspx)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GenerateApiKeyWithSettingsBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/withsettings": { "get": { "tags": [ "System" ], "summary": "ApiKeyGetCurrentSettings", "description": "Return the current XML representation of the apiKey\r\nSoap API equivalent is 'ApiKeyGetCurrentSettings'", "operationId": "RestApi_ApiKeyGetCurrentSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/autopreviewgeneration": { "put": { "tags": [ "System" ], "summary": "SetAutomaticPreviewGeneration", "description": "If set to false, previews for new items are not automatically generated all at once (to prevent file locks while you still plan on working on the new item, for example)\r\nSoap API equivalent is 'SetAutomaticPreviewGeneration'", "operationId": "RestApi_SetAutomaticPreviewGeneration", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "createPreviews", "in": "query", "description": "Set automatic preview generation to true (default) or false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/contentadministration": { "put": { "tags": [ "System" ], "summary": "SetContentAdministration", "description": "Toggles content administration privileges for the current apiKey.\r\nThis privilege influences the possibility to manage the content of a document in the CHILI Editor including more advanced settings (eg Constraints). Inside the editor, various items have settings referencing \"Administrators\". This means a user which has workspace or content administration privileges, depending on the context.\r\nSoap API equivalent is 'SetContentAdministration'", "operationId": "RestApi_SetContentAdministration", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "allowContentAdministration", "in": "query", "description": "Set content administration to true or false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/lock/{apiKeyToLock}": { "put": { "tags": [ "System" ], "summary": "LockApiKey", "description": "Locks an API key \r\n(this can be checked by other web service functions)\r\nSoap API equivalent is 'LockApiKey'", "operationId": "RestApi_LockApiKey", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "apiKeyToLock", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/requestheaderswithcred": { "put": { "tags": [ "System" ], "summary": "ApiKeySetRequestWithCredentialsForDomain", "description": "Specify if client side requests to a domain needs to use the available credentials or not.\r\nYou can use wildcards for the domain. Be sure to first add the wildcards, adn then the specific ones.\r\nSoap API equivalent is 'ApiKeySetRequestWithCredentialsForDomain'", "operationId": "RestApi_ApiKeySetRequestWithCredentialsForDomain", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "domain", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "requestWithCredentials", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/requestheaders": { "put": { "tags": [ "System" ], "summary": "ApiKeySetRequestHeaderForDomain", "description": "Add HTTP header key/value pairs for a domain on the apiKey. When that API key is used to generate a PDF of a document that contains external assets, those key/value pairs are sent along in the header of the http request to download the high res assets.\r\nYou can use wildcards for the domain. Be sure to first add the wildcards, adn then the specific ones.\r\nSoap API equivalent is 'ApiKeySetRequestHeaderForDomain'", "operationId": "RestApi_ApiKeySetRequestHeaderForDomain", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "headerFieldKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "headerFieldValue", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "domain", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey": { "post": { "tags": [ "System" ], "summary": "GenerateApiKey", "description": "Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments. Date formatting was changed from version 1.2. The timezone can be checked by calling GetServerDate api method.\r\nSoap API equivalent is 'GenerateApiKey'\r\nSoap API equivalent is 'GenerateApiKey'", "operationId": "RestApi_GenerateApiKey", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentNameOrURL", "in": "query", "description": "The identifier for the environment in which to log in\r\n \r\n This can be:\r\n - the name of the environment\r\n - one of the values entered in the URLs setting of the environment\r\n - the full URL to the backoffice (eg: http://www.domain.com/CHILI/ENVIRONMENT_NAME/interface.aspx)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GenerateApiKeyBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/oauth": { "post": { "tags": [ "System" ], "summary": "GenerateApiKeyOauth", "description": "Generates an apiKey for subsequent calls to the other webservice functions. Date formatting was changed from version 1.2. The timezone can be checked by calling GetServerDate api method.", "operationId": "RestApi_GenerateApiKeyOauth", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentNameOrURL", "in": "query", "description": "The identifier for the environment in which to log in\r\n \r\n This can be:\r\n - the name of the environment\r\n - one of the values entered in the URLs setting of the environment\r\n - the full URL to the backoffice (eg: http://www.domain.com/CHILI/ENVIRONMENT_NAME/interface.aspx)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/GenerateApiKeyOAuthBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/workingenvironment": { "put": { "tags": [ "System" ], "summary": "SetWorkingEnvironment", "description": "Sets the working environment as a property of the generated apiKey.\r\nAll subsequent calls to the WebServices will operate inside that environment.\r\nThis function can only be called if the user you have logged in with (using GenerateApiKey) is part of the top-level \"Admin\" environment.\r\nSoap API equivalent is 'SetWorkingEnvironment'", "operationId": "RestApi_SetWorkingEnvironment", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentName", "in": "query", "description": "The name of the new environment in which to operate for all subsequent calls.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/workspaceadministration": { "put": { "tags": [ "System" ], "summary": "SetWorkspaceAdministration", "description": "Toggles workspace administration privileges for the current apiKey.\r\nThis privilege influences the possibility to manage the workspace in the CHILI Editor. Inside the editor, various items have settings referencing \"Administrators\". This means a user which has workspace administration privileges.\r\nBy toggling the privilege, you can have a single CHILI user (potentially with \"Environment Administrator\" privileges) to log in the webservices (using GenerateApiKey) for all of your own users.\r\nNOTE: for backward compatibility, setting workspace administration to false also sets content administration to false. This can be switched on again using the SetContentAdministration function if applicable.\r\nSoap API equivalent is 'SetWorkspaceAdministration'", "operationId": "RestApi_SetWorkspaceAdministration", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "allowWorkspaceAdministration", "in": "query", "description": "Set workspace administration to true or false", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/userlanguage": { "put": { "tags": [ "System" ], "summary": "SetUserLanguage", "description": "Applies a language for the editor to the current apiKey session\r\nSoap API equivalent is 'SetUserLanguage'", "operationId": "RestApi_SetUserLanguage", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageIdOrName", "in": "query", "description": "Either the ID of the language, or the name (EN, NL, ...)", "required": true, "type": "string" }, { "name": "ignoreWorkSpaceLanguage", "in": "query", "description": "If true, the configured language of a workspace is ignored, and the current language is used always. If false, the configured user language is used before the language configured on the Environment level", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/assetdirectories": { "put": { "tags": [ "System" ], "summary": "SetAssetDirectories", "description": "Applies values to the Asset Directories which can be entered also per document in the Document Settings panel. These values are applied to the apiKey, and override any values entered manually inside a document.\r\nTo clear an existing value, provide the string 'empty'. An empty string ('') indicates that nothing changes for that argument.\r\nSoap API equivalent is 'SetAssetDirectories'", "operationId": "RestApi_SetAssetDirectories", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "userAssetDirectory", "in": "query", "description": "The new value for userAssetDirectory", "required": false, "type": "string" }, { "name": "userGroupAssetDirectory", "in": "query", "description": "The new value for userGroupAssetDirectory", "required": false, "type": "string" }, { "name": "documentAssetDirectory", "in": "query", "description": "The new value for documentAssetDirectory", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/headerfields": { "put": { "tags": [ "System" ], "summary": "ApiKeySetHeaderFieldForServerDownloads", "description": "Add HTTP header key/value pairs for apiKey. When that API key is used to generate a PDF of a document that contains external assets, those key/value pairs are sent along in the header of the http request to download the high res assets.\r\nSoap API equivalent is 'ApiKeySetHeaderFieldForServerDownloads'", "operationId": "RestApi_ApiKeySetHeaderFieldForServerDownloads", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "headerFieldKey", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "headerFieldValue", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "delete": { "tags": [ "System" ], "summary": "ApiKeyClearHeaderFieldsForServerDownloads", "description": "Clear HTTP header key/value pairs for apiKey.\r\nSoap API equivalent is 'ApiKeyClearHeaderFieldsForServerDownloads'", "operationId": "RestApi_ApiKeyClearHeaderFieldsForServerDownloads", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/keepalive": { "put": { "tags": [ "System" ], "summary": "ApiKeyKeepAlive", "description": "Call to keep the current apiKey alive (slide expiration back)\r\nSoap API equivalent is 'ApiKeyKeepAlive'", "operationId": "RestApi_ApiKeyKeepAlive", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/apikey/verify": { "put": { "tags": [ "System" ], "summary": "ApiKeyVerify", "description": "Soap API equivalent is 'ApiKeyVerify'", "operationId": "RestApi_ApiKeyVerify", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ApiKeyVerifyBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/assets/external": { "post": { "tags": [ "Resources" ], "summary": "UploadExternalAsset", "description": "Adds an asset to an External Asset Library\r\nSoap API equivalent is 'UploadExternalAsset'", "operationId": "RestApi_UploadExternalAsset", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "url", "in": "query", "description": "The URL to post the asset to", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "description": "The name of the uploaded file", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/UploadExternalAssetBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/assets/{assetID}/imageinfo": { "get": { "tags": [ "Resources" ], "summary": "AssetGetImageInfo", "description": "Returns information about the underlying image\r\nSoap API equivalent is 'AssetGetImageInfo'", "operationId": "RestApi_AssetGetImageInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "assetID", "in": "path", "description": "The asset ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/assets/{assetID}/subjectinfo": { "get": { "tags": [ "Resources" ], "summary": "AssetGetSubjectInfo", "description": "Returns the subject info from the asset on the server\r\nSoap API equivalent is 'AssetGetSubjectInfo'", "operationId": "RestApi_AssetGetSubjectInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "assetID", "in": "path", "description": "The asset ID", "required": true, "type": "string" } ], "responses": { "201": { "description": "CustomRestOnly", "schema": { "type": "object" } } } }, "post": { "tags": [ "Resources" ], "summary": "AssetAddOrUpdateSubjectInfo", "description": "Updates the subject info from the asset on the server\r\nSoap API equivalent is 'AssetAddOrUpdateSubjectInfo'", "operationId": "RestApi_AssetAddOrUpdateSubjectInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "assetID", "in": "path", "description": "The asset ID", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/AssetAddOrUpdateSubjectInfoBodyWrapper" } } ], "responses": { "201": { "description": "CustomRestOnly", "schema": { "type": "object" } } } }, "delete": { "tags": [ "Resources" ], "summary": "AssetDeleteSubjectInfo", "description": "Deletes the subject info from the asset on the server\r\nSoap API equivalent is 'AssetDeleteSubjectInfo'", "operationId": "RestApi_AssetDeleteSubjectInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "assetID", "in": "path", "description": "The asset ID", "required": true, "type": "string" } ], "responses": { "201": { "description": "CustomRestOnly", "schema": { "type": "object" } } } } }, "/rest-api/v1/spelling/check/{language}": { "post": { "tags": [ "Spelling" ], "summary": "SpellingCheck", "description": "Request a check on the provided text for spelling errors, and returns a list of the tokens if such error found.\r\nSoap API equivalent is 'SpellingCheck'", "operationId": "RestApi_SpellingCheck", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "language", "in": "path", "description": "The language localization (IETF)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/SpellingCheckBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/spreadsheets": { "get": { "tags": [ "Settings" ], "summary": "DataSourceDownloadSpreadsheets", "description": "Downloads a list of spreadsheets for a datasource (if its type = 'google')\r\nSoap API equivalent is 'DataSourceDownloadSpreadsheets'", "operationId": "RestApi_DataSourceDownloadSpreadsheets", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The ID for the datasource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/spreadsheets/{spreadsheetID}": { "post": { "tags": [ "Settings" ], "summary": "DataSourceSpreadsheetGetXML", "description": "Downloads an XML representation of the selected spreadsheet\r\nSoap API equivalent is 'DataSourceSpreadsheetGetXML'", "operationId": "RestApi_DataSourceSpreadsheetGetXML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The ID for the datasource", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DataSourceSpreadsheetGetXMLBodyWrapper" } }, { "name": "spreadsheetID", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/salesforce": { "get": { "tags": [ "Settings" ], "summary": "DataSourceSalesForceGetXML", "description": "Downloads an XML representation of the selected salesforce Query\r\nSoap API equivalent is 'DataSourceSalesForceGetXML'", "operationId": "RestApi_DataSourceSalesForceGetXML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The ID for the datasource", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/xmlconverter": { "put": { "tags": [ "Settings" ], "summary": "DataSourceFileGetXML", "description": "Converts an uploaded file to generic XML using the settings of a DataSource\r\nSoap API equivalent is 'DataSourceFileGetXML'", "operationId": "RestApi_DataSourceFileGetXML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The DataSource for which the settings are used", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DataSourceFileGetXMLBodyWrapper" } }, { "name": "fileExtension", "in": "query", "description": "The extension (csv, txt, ...) of the file to convert. If a file path is provided, this argument is optional", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/downloadurl": { "get": { "tags": [ "Settings" ], "summary": "DataSourceDownloadURL", "description": "Returns the result of one of the external URLs for a DataSource\r\nSoap API equivalent is 'DataSourceDownloadURL'", "operationId": "RestApi_DataSourceDownloadURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "ID of the DataSource ResourceItem", "required": true, "type": "string" }, { "name": "urlType", "in": "query", "description": "The type of url to download ('main' or 'query')", "required": true, "type": "string" }, { "name": "query", "in": "query", "description": "If urlType is 'main', the query will be replaced in the main URL (based on the pattern '%QUERY%')", "required": false, "type": "string" }, { "name": "forDocumentID", "in": "query", "description": "Document ID for which the download takes place (used to replace the %doc_id% pattern in the URL)", "required": false, "type": "string" }, { "name": "editorQueryString", "in": "query", "description": "The querystring for the Editor (used to replace variables in the external URL)", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/samplefiles": { "get": { "tags": [ "Settings" ], "summary": "DataSourceListSampleFiles", "description": "Get a list of the sample files assigned to a DataSource\r\nSoap API equivalent is 'DataSourceListSampleFiles'", "operationId": "RestApi_DataSourceListSampleFiles", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The DataSource for which to return the sample files", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/files": { "post": { "tags": [ "Settings" ], "summary": "DataSourceAddSampleFile", "description": "Adds a new sample file to a DataSource\r\nSoap API equivalent is 'DataSourceAddSampleFile'", "operationId": "RestApi_DataSourceAddSampleFile", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The DataSource for which to return the sample files", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "description": "The name of the new file", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DataSourceAddSampleFileBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/datasources/{dataSourceID}/samplefiles/{fileName}": { "delete": { "tags": [ "Settings" ], "summary": "DataSourceDeleteSampleFile", "description": "Deletes a sample files assigned to a DataSource\r\nSoap API equivalent is 'DataSourceDeleteSampleFile'", "operationId": "RestApi_DataSourceDeleteSampleFile", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dataSourceID", "in": "path", "description": "The DataSource for which to return the sample files", "required": true, "type": "string" }, { "name": "fileName", "in": "path", "description": "The name of the file to delete", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/DatasourceSample/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadDatasourceSample", "description": "Download a Datasource from the server\r\nSoap API equivalent is 'DownloadDatasourceSample'", "operationId": "RestApi_DownloadDatasourceSample", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "name", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/package": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreatePackage", "description": "Generates a CHILI Package of the document.\r\nSoap API equivalent is 'DocumentCreatePackage'", "operationId": "RestApi_DocumentCreatePackage", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The ID of the document for which to create the Package", "required": true, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/package": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempPackage", "description": "Generates a CHILI Package of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempPackage'", "operationId": "RestApi_DocumentCreateTempPackage", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempPackageBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "The ID of the document for which to create the Package", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{toItemID}/documenteventactions/copy": { "put": { "tags": [ "Resources" ], "summary": "DocumentCopyDocumentEventActions", "description": "Duplicates Document Event Actions from one document to another\r\nSoap API equivalent is 'DocumentCopyDocumentEventActions'", "operationId": "RestApi_DocumentCopyDocumentEventActions", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "fromItemID", "in": "query", "description": "The original document's ID", "required": true, "type": "string" }, { "name": "toItemID", "in": "path", "description": "The new document's ID", "required": true, "type": "string" }, { "name": "replaceExistingActions", "in": "query", "description": "If true, all existing actions are first removed from the target document", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/eventactions": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetDocumentEventActions", "description": "Returns the definitions of the Document Event Actions contained in a document\r\nSoap API equivalent is 'DocumentGetDocumentEventActions'", "operationId": "RestApi_DocumentGetDocumentEventActions", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "post": { "tags": [ "Resources" ], "summary": "DocumentSetDocumentEventActions", "description": "Applies Document Event Action definitions to a document\r\nSoap API equivalent is 'DocumentSetDocumentEventActions'", "operationId": "RestApi_DocumentSetDocumentEventActions", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentSetDocumentEventActionsBodyWrapper" } }, { "name": "replaceExistingActions", "in": "query", "description": "If true, all existing actions will be removed from the target document before insertion of the new ones", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/folding": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempFolding", "description": "Generates Temp Folding output XML\r\nSoap API equivalent is 'DocumentCreateTempFolding'", "operationId": "RestApi_DocumentCreateTempFolding", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempFoldingBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/urls/foldingviewer": { "post": { "tags": [ "Resources" ], "summary": "DocumentGetFoldingViewerURL", "description": "Returns a URL for viewing of a document's Folding representation\r\nSoap API equivalent is 'DocumentGetFoldingViewerURL'", "operationId": "RestApi_DocumentGetFoldingViewerURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentGetFoldingViewerURLBodyWrapper" } }, { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "foldingSettingsID", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/imagesandpdf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateImagesAndPDF", "description": "Generates a zip containing the PDF and images of all the pages in the document.\r\nSoap API equivalent is 'DocumentCreateImagesAndPDF'", "operationId": "RestApi_DocumentCreateImagesAndPDF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The ID of the document for which to create the PDF", "required": true, "type": "string" }, { "name": "imageConversionProfileID", "in": "query", "description": "The ID of the image conversion profile", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateImagesAndPDFBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/imagesandpdf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempImagesAndPDF", "description": "Generates a zip file with PDF and images of all the pages in the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempImagesAndPDF'", "operationId": "RestApi_DocumentCreateTempImagesAndPDF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "imageConversionProfileID", "in": "query", "description": "The ID of the image conversion profile", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempImagesAndPDFBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "The ID of the document for which to create the PDF", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/datasource": { "post": { "tags": [ "Resources" ], "summary": "DocumentSetDataSource", "description": "Sets a datasource on a document\r\nSoap API equivalent is 'DocumentSetDataSource'", "operationId": "RestApi_DocumentSetDataSource", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentSetDataSourceBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/fromodt": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateFromODT", "description": "Creates a new document based on a Open Document Text file.\r\nSoap API equivalent is 'DocumentCreateFromODT'", "operationId": "RestApi_DocumentCreateFromODT", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "documentName", "in": "query", "description": "The name for the new document", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The path for the new document", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateFromODTBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/urls/threedmodelviewer": { "post": { "tags": [ "Resources" ], "summary": "DocumentGetThreeDModelViewerURL", "description": "Returns a URL for viewing of a document's ThreeDModel representation\r\nSoap API equivalent is 'DocumentGetThreeDModelViewerURL'", "operationId": "RestApi_DocumentGetThreeDModelViewerURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentGetThreeDModelViewerURLBodyWrapper" } }, { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "threeDModelID", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/urls/editor": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetHTMLEditorURL", "description": "Returns a URL for editing (or viewing) of the specified document, with arguments to determine how the interface will be constructed\r\nSoap API equivalent is 'DocumentGetHTMLEditorURL'", "operationId": "RestApi_DocumentGetHTMLEditorURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "workSpaceID", "in": "query", "description": "The (optional) WorkSpace ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "viewPrefsID", "in": "query", "description": "The (optional) ViewPreferences ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "constraintsID", "in": "query", "description": "The (optional) Constraints ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "viewerOnly", "in": "query", "description": "The (optional) DocumentConstraints ID for the Editor (emtpy string to use the default)", "required": false, "type": "boolean" }, { "name": "forAnonymousUser", "in": "query", "description": "If true, the anonymous user's apiKey will be appended. This does require the anonymous user to have view or edit privileges on the Documents resource", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/urls/htmlpreload": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetHTMLPreloadURL", "description": "Returns a URL for preloading the specified document, with arguments to determine how the interface will be constructed\r\nSoap API equivalent is 'DocumentGetHTMLPreloadURL'", "operationId": "RestApi_DocumentGetHTMLPreloadURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The (optional) document's ID use 'none' in REST API", "required": true, "type": "string" }, { "name": "workSpaceID", "in": "query", "description": "The (optional) WorkSpace ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "viewPrefsID", "in": "query", "description": "The (optional) ViewPreferences ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "constraintsID", "in": "query", "description": "The (optional) Constraints ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/urls/htmlfoldingviewer": { "post": { "tags": [ "Resources" ], "summary": "DocumentGetHTMLFoldingViewerURL", "description": "Returns a URL for viewing of a document's Folding representation\r\nSoap API equivalent is 'DocumentGetHTMLFoldingViewerURL'", "operationId": "RestApi_DocumentGetHTMLFoldingViewerURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentGetHTMLFoldingViewerURLBodyWrapper" } }, { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "foldingSettingsID", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/htmlpreload": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetHTMLPreload", "description": "Returns an XML representation of the resources that need to be preloaded\r\nSoap API equivalent is 'DocumentGetHTMLPreload'", "operationId": "RestApi_DocumentGetHTMLPreload", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The (optional) document's ID use 'none' for REST API", "required": true, "type": "string" }, { "name": "workSpaceID", "in": "query", "description": "The (optional) WorkSpace ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "viewPrefsID", "in": "query", "description": "The (optional) ViewPreferences ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" }, { "name": "constraintsID", "in": "query", "description": "The (optional) Constraints ID for the Editor (emtpy string to use the default)", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/urls/htmlthreedmodelviewer": { "post": { "tags": [ "Resources" ], "summary": "DocumentGetHTMLThreeDModelViewerURL", "description": "Returns a URL for viewing of a document's ThreeDModel representation\r\nSoap API equivalent is 'DocumentGetHTMLThreeDModelViewerURL'", "operationId": "RestApi_DocumentGetHTMLThreeDModelViewerURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentGetHTMLThreeDModelViewerURLBodyWrapper" } }, { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "threeDModelID", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/documentprocessor": { "put": { "tags": [ "Resources" ], "summary": "DocumentProcessServerSide", "description": "Processes the document server-side.\r\nEither an itemID or resourceXML need to be provided. If an itemID (document ID) is provided, the CLI reads the document from the CHILI DAM and saves it to the CHILI DAM.\r\nIf a resourceXML is provided, the provided XML is loaded by the CLI. The result is saved to the temp folder.\r\n\r\nSoap API equivalent is 'DocumentProcessServerSide'", "operationId": "RestApi_DocumentProcessServerSide", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentProcessServerSideBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/frompackage": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateFromChiliPackage", "description": "Creates a new document based on a zip file containing a CHILI package (usually generated by the InDesign Extension).\r\nSoap API equivalent is 'DocumentCreateFromChiliPackage'", "operationId": "RestApi_DocumentCreateFromChiliPackage", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "documentName", "in": "query", "description": "The name for the new document", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The path for the new document", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateFromChiliPackageBodyWrapper" } }, { "name": "newAssetLocation", "in": "query", "description": "Optional new location for the assets in the package. When creating the package, the user can choose a location for the assets. If a newAssetLocation is provided, this location will be modified", "required": false, "type": "string" }, { "name": "newFontLocation", "in": "query", "description": "Optional new location for the fonts in the package. When creating the package, the user can choose a location for the fonts. If a newFontLocation is provided, this location will be modified", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/fromtemplate": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateFromBlankDocTemplate", "description": "Creates a new document based on the settings in the \"DocumentTemplates\" resource. This resource contains such settings as number of pages, dimensions, etc.\r\nSoap API equivalent is 'DocumentCreateFromBlankDocTemplate'", "operationId": "RestApi_DocumentCreateFromBlankDocTemplate", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "documentName", "in": "query", "description": "The name of the new document", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The path for the new document", "required": true, "type": "string" }, { "name": "blankDocTemplateID", "in": "query", "description": "The ID of the BlankDocumentTemplates resource item", "required": true, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/variabledefinitions": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetVariableDefinitions", "description": "Returns the definitions of the variables contained in a document\r\nSoap API equivalent is 'DocumentGetVariableDefinitions'", "operationId": "RestApi_DocumentGetVariableDefinitions", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "post": { "tags": [ "Resources" ], "summary": "DocumentSetVariableDefinitions", "description": "Applies variable definitions to a document\r\nSoap API equivalent is 'DocumentSetVariableDefinitions'", "operationId": "RestApi_DocumentSetVariableDefinitions", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentSetVariableDefinitionsBodyWrapper" } }, { "name": "replaceExistingVariables", "in": "query", "description": "If true, all existing variables will be removed from the target document before insertion of the new ones", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/variablevalues": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetVariableValues", "description": "Returns the values of the variables contained in a document\r\nSoap API equivalent is 'DocumentGetVariableValues'", "operationId": "RestApi_DocumentGetVariableValues", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "post": { "tags": [ "Resources" ], "summary": "DocumentSetVariableValues", "description": "Sets the values of variables in a document\r\nSoap API equivalent is 'DocumentSetVariableValues'", "operationId": "RestApi_DocumentSetVariableValues", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentSetVariableValuesBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{toItemID}/variabledefinitions/copy": { "put": { "tags": [ "Resources" ], "summary": "DocumentCopyVariableDefinitions", "description": "Duplicates variable definitions from one document to another\r\nSoap API equivalent is 'DocumentCopyVariableDefinitions'", "operationId": "RestApi_DocumentCopyVariableDefinitions", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "fromItemID", "in": "query", "description": "The ID of the document from which the variables will be copied", "required": true, "type": "string" }, { "name": "toItemID", "in": "path", "description": "The id of the document to which the variables need to be copied", "required": true, "type": "string" }, { "name": "replaceExistingVariables", "in": "query", "description": "If true, all previously existing variables are first removed in the target document", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/info": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetInfo", "description": "Returns general information on a document in an XML format which is easier to parse than the full document XML.\r\nSoap API equivalent is 'DocumentGetInfo'", "operationId": "RestApi_DocumentGetInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "extended", "in": "query", "description": "If true, additional information is returned", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/idml": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateIDML", "description": "Generates the IDML package of the document.\r\nSoap API equivalent is 'DocumentCreateIDML'", "operationId": "RestApi_DocumentCreateIDML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateIDMLBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/preflightresults": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetPreflightResults", "description": "Returns information on the preflight results which were present in the document on the last save\r\nSoap API equivalent is 'DocumentGetPreflightResults'", "operationId": "RestApi_DocumentGetPreflightResults", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/html": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateHTML", "description": "Generates the HTML package of the document.\r\nSoap API equivalent is 'DocumentCreateHTML'", "operationId": "RestApi_DocumentCreateHTML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateHTMLBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/idml": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempIDML", "description": "Generates the IDML package of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempIDML'", "operationId": "RestApi_DocumentCreateTempIDML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempIDMLBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/odf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateODF", "description": "Generates the ODF package of the document.\r\nSoap API equivalent is 'DocumentCreateODF'", "operationId": "RestApi_DocumentCreateODF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateODFBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/html": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempHTML", "description": "Generates the HTML package of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempHTML'", "operationId": "RestApi_DocumentCreateTempHTML", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempHTMLBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/usedassets": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetUsedAssets", "description": "Returns information on the assets contained in a document\r\nSoap API equivalent is 'DocumentGetUsedAssets'", "operationId": "RestApi_DocumentGetUsedAssets", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/odf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempODF", "description": "Generates the ODF package of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempODF'", "operationId": "RestApi_DocumentCreateTempODF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempODFBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/annotations": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetAnnotations", "description": "Returns information on the annotations contained in a document\r\nSoap API equivalent is 'DocumentGetAnnotations'", "operationId": "RestApi_DocumentGetAnnotations", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The ID of the document for which to return the placed annotations", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "post": { "tags": [ "Resources" ], "summary": "DocumentSetAnnotations", "description": "Inserts annotations into a document\r\nSoap API equivalent is 'DocumentSetAnnotations'", "operationId": "RestApi_DocumentSetAnnotations", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentSetAnnotationsBodyWrapper" } }, { "name": "replaceExistingAnnotations", "in": "query", "description": "If true, all existing annotations will be removed from the target document before the insertion", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{toItemID}/annotations/copy": { "put": { "tags": [ "Resources" ], "summary": "DocumentCopyAnnotations", "description": "Duplicates annotations from one document to another\r\nSoap API equivalent is 'DocumentCopyAnnotations'", "operationId": "RestApi_DocumentCopyAnnotations", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "fromItemID", "in": "query", "description": "The original document's ID", "required": true, "type": "string" }, { "name": "toItemID", "in": "path", "description": "The new document's ID", "required": true, "type": "string" }, { "name": "replaceExistingAnnotations", "in": "query", "description": "If true, all existing annotations are first removed from the target document", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/constraints": { "post": { "tags": [ "Resources" ], "summary": "DocumentSetConstraints", "description": "Applies constraints to a document.\r\nThe constraints are configured in the \"DocumentConstraints\" Resource (usually through the backoffice). These contain settings to configure naming conventions (and general settings) for the application of constraints.\r\nThe naming conventions are used to update the document (you will see the constraints in the DocumentConstraints, Page Settings, Layer Settings and Frame Constraints panel items in CHILI Editor)\r\nSoap API equivalent is 'DocumentSetConstraints'", "operationId": "RestApi_DocumentSetConstraints", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The document's ID", "required": true, "type": "string" }, { "name": "constraintsID", "in": "query", "description": "The ID of the DocumentConstraints resource item", "required": true, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/defaultsettings": { "get": { "tags": [ "Resources" ], "summary": "DocumentGetDefaultSettings", "description": "Returns default settings for an editor session. This function is used by CHILI Editor to retrieve a series of informations in one call.\r\nSoap API equivalent is 'DocumentGetDefaultSettings'", "operationId": "RestApi_DocumentGetDefaultSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "query", "description": "The document's ID", "required": false, "type": "string" }, { "name": "viewType", "in": "query", "description": "If 'view', the settings required for a Viewer are returned", "required": false, "type": "string" }, { "name": "viewPrefsID", "in": "query", "description": "Optional ID for the viewpreferences to be loaded (if not present, the default will be used)", "required": false, "type": "string" }, { "name": "constraintID", "in": "query", "description": "Optional ID for the constraints to apply to the document (if not provided, the default will be used)", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/pdf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreatePDF", "description": "Generates a PDF of the document.\r\nSoap API equivalent is 'DocumentCreatePDF'", "operationId": "RestApi_DocumentCreatePDF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The ID of the document for which to create the PDF", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreatePDFBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/pdf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempPDF", "description": "Generates a PDF of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempPDF'", "operationId": "RestApi_DocumentCreateTempPDF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempPDFBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "The ID of the document for which to create the PDF", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{documentID}/assetdirectories": { "post": { "tags": [ "Resources" ], "summary": "DocumentSetAssetDirectories", "description": "Save new Asset Directory locations (doc., user, user group) for the document. Empty strings will be ignored (so the existing value will be retained). To clear an asset directory, provide the string 'empty' as the argument\r\nSoap API equivalent is 'DocumentSetAssetDirectories'", "operationId": "RestApi_DocumentSetAssetDirectories", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "documentID", "in": "path", "description": "The ID of the document to modify", "required": true, "type": "string" }, { "name": "userAssetDirectory", "in": "query", "description": "The user asset directory", "required": false, "type": "string" }, { "name": "userGroupAssetDirectory", "in": "query", "description": "The user group asset directory", "required": false, "type": "string" }, { "name": "documentAssetDirectory", "in": "query", "description": "The document asset directory", "required": false, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/frompdf": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateFromPDF", "description": "Creates a new document based on a PDF file\r\nSoap API equivalent is 'DocumentCreateFromPDF'", "operationId": "RestApi_DocumentCreateFromPDF", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "documentName", "in": "query", "description": "The name for the new document", "required": true, "type": "string" }, { "name": "folderPath", "in": "query", "description": "The path for the new document", "required": true, "type": "string" }, { "name": "backgroundAssetLocation", "in": "query", "description": "Location for the PDF pages used as backgrounds for the document", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateFromPDFBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/{itemID}/representations/images": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateImages", "description": "Generates a zip containing images of all the pages in the document.\r\nSoap API equivalent is 'DocumentCreateImages'", "operationId": "RestApi_DocumentCreateImages", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "itemID", "in": "path", "description": "The ID of the document for which to create the PDF", "required": true, "type": "string" }, { "name": "imageConversionProfileID", "in": "query", "description": "The ID of the image conversion profile", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateImagesBodyWrapper" } }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/documents/tempxml/images": { "post": { "tags": [ "Resources" ], "summary": "DocumentCreateTempImages", "description": "Generates Images of all the pages in the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)\r\nSoap API equivalent is 'DocumentCreateTempImages'", "operationId": "RestApi_DocumentCreateTempImages", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "imageConversionProfileID", "in": "query", "description": "The ID of the image conversion profile", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DocumentCreateTempImagesBodyWrapper" } }, { "name": "itemID", "in": "query", "description": "The ID of the document for which to create the PDF", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "The priority (1-10) of the task", "required": false, "type": "integer", "format": "int32" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/dynamicassetproviders/{dynamicAssetProviderID}/tempasset": { "post": { "tags": [ "Settings" ], "summary": "DynamicAssetProviderGetTempAsset", "description": "Soap API equivalent is 'DynamicAssetProviderGetTempAsset'", "operationId": "RestApi_DynamicAssetProviderGetTempAsset", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "dynamicAssetProviderID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/DynamicAssetProviderGetTempAssetBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/reflectionmaps": { "get": { "tags": [ "System" ], "summary": "EnvironmentGetReflectionMaps", "description": "Returns a list of the Reflection Masks in the enviroment\r\nSoap API equivalent is 'EnvironmentGetReflectionMaps'", "operationId": "RestApi_EnvironmentGetReflectionMaps", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/interfaceinitialsettings": { "get": { "tags": [ "System" ], "summary": "InterfaceGetInitialSettings", "description": "Function used by CHILI Editor to retrieve a number of settings of the current Environment in one call.\r\nSoap API equivalent is 'InterfaceGetInitialSettings'", "operationId": "RestApi_InterfaceGetInitialSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "forEditor", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments": { "get": { "tags": [ "System" ], "summary": "EnvironmentList", "description": "Returns a list of available environments for the current user\r\nSoap API equivalent is 'EnvironmentList'", "operationId": "RestApi_EnvironmentList", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "post": { "tags": [ "System" ], "summary": "EnvironmentAdd", "description": "Creates a new environment, with the specified name\r\nSoap API equivalent is 'EnvironmentAdd'", "operationId": "RestApi_EnvironmentAdd", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "newName", "in": "query", "description": "The name for the new environment.", "required": true, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/current": { "get": { "tags": [ "System" ], "summary": "EnvironmentGetCurrent", "description": "Returns a description of the current environment\r\nSoap API equivalent is 'EnvironmentGetCurrent'", "operationId": "RestApi_EnvironmentGetCurrent", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/{environmentName}": { "put": { "tags": [ "System" ], "summary": "EnvironmentSaveSettings", "description": "Saves the settings of an environment\r\nSoap API equivalent is 'EnvironmentSaveSettings'", "operationId": "RestApi_EnvironmentSaveSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentName", "in": "path", "description": "The name of the environment", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EnvironmentSaveSettingsBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "delete": { "tags": [ "System" ], "summary": "EnvironmentDelete", "description": "Deletes a complete environment, including it's files on disk\r\nSoap API equivalent is 'EnvironmentDelete'", "operationId": "RestApi_EnvironmentDelete", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentName", "in": "path", "description": "The name of the environment to delete", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/colorprofiles": { "get": { "tags": [ "System" ], "summary": "EnvironmentGetColorProfiles", "description": "Returns a list of the Color Profiles available for the environment.\r\nSoap API equivalent is 'EnvironmentGetColorProfiles'", "operationId": "RestApi_EnvironmentGetColorProfiles", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/{environmentNameOrURL}/loginsettings": { "get": { "tags": [ "System" ], "summary": "EnvironmentGetLoginSettings", "description": "Gets initial settings for the specified environment. This function is called before the user has logged in, so it does not require an API Key (and therefore also only returns the most basic information required for a login screen)\r\nSoap API equivalent is 'EnvironmentGetLoginSettings'", "operationId": "RestApi_EnvironmentGetLoginSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentNameOrURL", "in": "path", "description": "The name or URL (eg: http://www.domain.com/CHILI/ENVIRONMENT_NAME/interface.aspx) by which CHILI can identify the environment", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/{environmentName}/settings": { "get": { "tags": [ "System" ], "summary": "EnvironmentGetSettings", "description": "Returns the settings of the specified environment\r\nSoap API equivalent is 'EnvironmentGetSettings'", "operationId": "RestApi_EnvironmentGetSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentName", "in": "path", "description": "The name of the environment", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/environments/{environmentName}/copy": { "post": { "tags": [ "System" ], "summary": "EnvironmentCopy", "description": "Copies an existing environment. A new environment is created and all files are copied\r\nSoap API equivalent is 'EnvironmentCopy'", "operationId": "RestApi_EnvironmentCopy", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environmentName", "in": "path", "description": "The name of the the environment to copy", "required": true, "type": "string" }, { "name": "newName", "in": "query", "description": "The name of the new environment. The new environment cannot exist when copying", "required": true, "type": "string" } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/External/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadExternal", "description": "Download an external resource\r\nSoap API equivalent is 'DownloadExternal'", "operationId": "RestApi_DownloadExternal", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "path", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/Folding/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadFolding", "description": "Download a Folding from the server\r\nSoap API equivalent is 'DownloadFolding'", "operationId": "RestApi_DownloadFolding", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "id", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "type", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "foldingId", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/foldingsettings/{foldingSettingId}/package": { "get": { "tags": [ "Settings" ], "summary": "FoldingSettingCreatePackage", "description": "Returns a ZIP with all the needed recources and the settings file with fixed references.\r\nSoap API equivalent is 'FoldingSettingCreatePackage'", "operationId": "RestApi_FoldingSettingCreatePackage", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "foldingSettingId", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/font/{language}": { "get": { "tags": [ "System" ], "summary": "GetFontURL", "description": "Request an URL to download font for specific language's character set.\r\nSoap API equivalent is 'GetFontURL'", "operationId": "RestApi_GetFontURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "language", "in": "path", "description": "The language localization (IETF)", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/fonts/{fontID}/includedglyphs": { "get": { "tags": [ "Resources" ], "summary": "FontGetIncludedGlyphs", "description": "Returns an XML document containing ranges of glyphs (and their availibility) in the font\r\nSoap API equivalent is 'FontGetIncludedGlyphs'", "operationId": "RestApi_FontGetIncludedGlyphs", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "fontID", "in": "path", "description": "The ID of the font", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/Fonts/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadFontPreview", "description": "Download a Font Preview from the server\r\nSoap API equivalent is 'DownloadFontPreview'", "operationId": "RestApi_DownloadFontPreview", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "type", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "width", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "height", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "alphabet", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "id", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "name", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "taskId", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "taskPriority", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "async", "in": "query", "description": "", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/Icons/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadIcons", "description": "Download Icons from the server\r\nSoap API equivalent is 'DownloadIcons'", "operationId": "RestApi_DownloadIcons", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "environment", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "set", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "icon", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "preferSvg", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "isCursor", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "tempPath", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/spelling/langs": { "get": { "tags": [ "Spelling" ], "summary": "SpellingGetSupportedLanguages", "description": "Soap API equivalent is 'SpellingGetSupportedLanguages'", "operationId": "RestApi_SpellingGetSupportedLanguages", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages/{languageID}/urls/unicodetext": { "get": { "tags": [ "System" ], "summary": "LanguageGetUnicodeTextURL", "description": "Returns a urlInfo XML for the txt file (tab-delimited) of the language (which is created on the fly)\r\nSoap API equivalent is 'LanguageGetUnicodeTextURL'", "operationId": "RestApi_LanguageGetUnicodeTextURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageID", "in": "path", "description": "The ID of the Language", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages/{languageID}/unicodetext": { "post": { "tags": [ "System" ], "summary": "LanguageImportUnicodeText", "description": "Uploads a txt file (tab-delimited, of the same format as exported using LanguageGetUnicodeTextURL) and imports it into a language.\r\nStrings outside of the 'Custom' section are not created, only updated.\r\nSoap API equivalent is 'LanguageImportUnicodeText'", "operationId": "RestApi_LanguageImportUnicodeText", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageID", "in": "path", "description": "The ID of the language", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/LanguageImportUnicodeTextBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages/{languageID}/combinedstrings": { "get": { "tags": [ "System" ], "summary": "LanguageGetCombinedStrings", "description": "Get the (combined) strings for a Language. This includes the values of the parent language for non-translated strings.\r\nSoap API equivalent is 'LanguageGetCombinedStrings'", "operationId": "RestApi_LanguageGetCombinedStrings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageID", "in": "path", "description": "The ID of the Language", "required": true, "type": "string" }, { "name": "overrideBasedOn", "in": "query", "description": "if provided (not an empty string), the returned list contains a list merged with an alternate parent language", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages/{languageID}": { "put": { "tags": [ "System" ], "summary": "LanguageSaveStrings", "description": "Saves the string library for a language\r\nSoap API equivalent is 'LanguageSaveStrings'", "operationId": "RestApi_LanguageSaveStrings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageID", "in": "path", "description": "The ID of the language", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/LanguageSaveStringsBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages": { "get": { "tags": [ "System" ], "summary": "LanguagesGetList", "description": "Returns a list of the available languages in the environment (optionally including system languages, on which environment languages can be based)\r\nSoap API equivalent is 'LanguagesGetList'", "operationId": "RestApi_LanguagesGetList", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "includeSystemLanguages", "in": "query", "description": "If true, system languages (such as \"[EN]\") are included in the result", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages/{languageID}/urls/csv": { "get": { "tags": [ "System" ], "summary": "LanguageGetCsvURL", "description": "Returns a urlInfo XML for the CSV file of the language (which is created on the fly)\r\nSoap API equivalent is 'LanguageGetCsvURL'", "operationId": "RestApi_LanguageGetCsvURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageID", "in": "path", "description": "The ID of the Language", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/languages/{languageID}/csv": { "post": { "tags": [ "System" ], "summary": "LanguageImportCsv", "description": "Uploads a CSV file (of the same format as exported using LanguageGetCsvURL) and imports it into a language.\r\nStrings outside of the 'Custom' section are not created, only updated.\r\nSoap API equivalent is 'LanguageImportCsv'", "operationId": "RestApi_LanguageImportCsv", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "languageID", "in": "path", "description": "The ID of the language", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/LanguageImportCsvBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/Login/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadLoginBackground", "description": "Download a Login Background from the server\r\nSoap API equivalent is 'DownloadLoginBackground'", "operationId": "RestApi_DownloadLoginBackground", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "env", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "type", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/odt/styles": { "post": { "tags": [ "Settings" ], "summary": "ODTGetStyles", "description": "Returns an XML description of the styles contained in the ODT. Used for parsing an ODT document and create the style conversion table.\r\nSoap API equivalent is 'ODTGetStyles'", "operationId": "RestApi_ODTGetStyles", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ODTGetStylesBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/odt/textflow": { "post": { "tags": [ "Settings" ], "summary": "ODTGetTextFlow", "description": "Returns an XML description of the styles contained in the ODT. Used for parsing an ODT document and create the style conversion table.\r\nSoap API equivalent is 'ODTGetTextFlow'", "operationId": "RestApi_ODTGetTextFlow", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ODTGetTextFlowBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources/ReflectionMap/download": { "get": { "tags": [ "Resources" ], "summary": "DownloadReflectionMap", "description": "Download a Reflection Map from the server\r\nSoap API equivalent is 'DownloadReflectionMap'", "operationId": "RestApi_DownloadReflectionMap", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "name", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "side", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "201": { "description": "Custom", "schema": { "type": "object" } } } } }, "/rest-api/v1/resources": { "get": { "tags": [ "Resources" ], "summary": "ResourceList", "description": "Returns a list of the available Resources.\r\nSoap API equivalent is 'ResourceList'", "operationId": "RestApi_ResourceList", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/loggingsettings": { "get": { "tags": [ "System" ], "summary": "ServerGetLoggingSettings", "description": "Returns the server logging settings\r\nSoap API equivalent is 'ServerGetLoggingSettings'", "operationId": "RestApi_ServerGetLoggingSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "put": { "tags": [ "System" ], "summary": "ServerSaveLoggingSettings", "description": "Saves the server logging settings\r\nSoap API equivalent is 'ServerSaveLoggingSettings'", "operationId": "RestApi_ServerSaveLoggingSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ServerSaveLoggingSettingsBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/logs": { "delete": { "tags": [ "System" ], "summary": "ServerLogClear", "description": "Removes all current log files\r\nSoap API equivalent is 'ServerLogClear'", "operationId": "RestApi_ServerLogClear", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/licenseinfo": { "get": { "tags": [ "System" ], "summary": "ServerGetLicenseInfo", "description": "Soap API equivalent is 'ServerGetLicenseInfo'", "operationId": "RestApi_ServerGetLicenseInfo", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/licenserequest": { "post": { "tags": [ "System" ], "summary": "ServerLicenseRequest", "description": "Handles server licensing requests\r\nSoap API equivalent is 'ServerLicenseRequest'", "operationId": "RestApi_ServerLicenseRequest", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "remoteFunction", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ServerLicenseRequestBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/googleauthurl": { "get": { "tags": [ "System" ], "summary": "GoogleCreateAuthorizationUrl", "description": "Returns an URL so Google OAuth 2.0 can be performed.\r\nSoap API equivalent is 'GoogleCreateAuthorizationUrl'", "operationId": "RestApi_GoogleCreateAuthorizationUrl", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "clientID", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "dataSourceId", "in": "query", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/googleauthcode": { "get": { "tags": [ "System" ], "summary": "GoogleGetAuthorizationCode", "description": "Receive response from google authorization server.\r\nSoap API equivalent is 'GoogleGetAuthorizationCode'", "operationId": "RestApi_GoogleGetAuthorizationCode", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "code", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "state", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "scope", "in": "query", "description": "", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/date": { "get": { "tags": [ "System" ], "summary": "GetServerDate", "description": "Returns the date of the server. The formatting was changed from version 1.2\r\nSoap API equivalent is 'GetServerDate'", "operationId": "RestApi_GetServerDate", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/server/settings": { "get": { "tags": [ "System" ], "summary": "ServerGetSettings", "description": "Returns the server settings\r\nSoap API equivalent is 'ServerGetSettings'", "operationId": "RestApi_ServerGetSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "put": { "tags": [ "System" ], "summary": "ServerSaveSettings", "description": "Saves the server settings\r\nSoap API equivalent is 'ServerSaveSettings'", "operationId": "RestApi_ServerSaveSettings", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/ServerSaveSettingsBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/spelling/suggest/{language}": { "post": { "tags": [ "Spelling" ], "summary": "SpellingSuggest", "description": "Request a suggestions for the provided word, and returns a list of the suggestions if such.\r\nSoap API equivalent is 'SpellingSuggest'", "operationId": "RestApi_SpellingSuggest", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "language", "in": "path", "description": "The language localization (IETF)", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/SpellingSuggestBodyWrapper" } } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/testconnection": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerTestConnection", "description": "Tests whether a connection can be made to the Switch application located at 'url'\r\nSoap API equivalent is 'SwitchServerTestConnection'", "operationId": "RestApi_SwitchServerTestConnection", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "url", "in": "query", "description": "URL to the Switch Server (eg: https://localhost:51008/ )", "required": true, "type": "string" }, { "name": "userName", "in": "query", "description": "User name to log in with", "required": true, "type": "string" }, { "name": "userPW", "in": "query", "description": "user password to log in with", "required": false, "type": "string" }, { "name": "oemKey", "in": "query", "description": "OEM key for SDK", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerGetFlowList", "description": "Returns a list of the Flows available in a Switch Server\r\nSoap API equivalent is 'SwitchServerGetFlowList'", "operationId": "RestApi_SwitchServerGetFlowList", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/submitpoints": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerFlowGetSubmitPoints", "description": "Returns a list of the submit points of a flow\r\nSoap API equivalent is 'SwitchServerFlowGetSubmitPoints'", "operationId": "RestApi_SwitchServerFlowGetSubmitPoints", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/checkpoints": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerFlowGetCheckPoints", "description": "Returns a list of the submit points of a flow\r\nSoap API equivalent is 'SwitchServerFlowGetCheckPoints'", "operationId": "RestApi_SwitchServerFlowGetCheckPoints", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/jobs": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerFlowGetJobs", "description": "Returns a list of the submit points of a flow\r\nSoap API equivalent is 'SwitchServerFlowGetJobs'", "operationId": "RestApi_SwitchServerFlowGetJobs", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/fullconfig": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerFlowGetFullConfig", "description": "Returns the full configuration of the Flow\r\nSoap API equivalent is 'SwitchServerFlowGetFullConfig'", "operationId": "RestApi_SwitchServerFlowGetFullConfig", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/elementsjobcount": { "get": { "tags": [ "Settings" ], "summary": "SwitchServerFlowGetElementsJobCount", "description": "Returns a list of the jobs existing inside a Switch FLow\r\nSoap API equivalent is 'SwitchServerFlowGetElementsJobCount'", "operationId": "RestApi_SwitchServerFlowGetElementsJobCount", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/folder/{elementID}": { "post": { "tags": [ "Settings" ], "summary": "SwitchServerFlowSubmitFileToFolder", "description": "Submit a file to an input folder of a Switch Flow\r\nSoap API equivalent is 'SwitchServerFlowSubmitFileToFolder'", "operationId": "RestApi_SwitchServerFlowSubmitFileToFolder", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "elementID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/SwitchServerFlowSubmitFileToFolderBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/switchservers/{switchServerID}/flows/{flowID}/submitpoint/{elementID}": { "post": { "tags": [ "Settings" ], "summary": "SwitchServerFlowSubmitFileToSubmitPoint", "description": "Submit a file to a Submit Point in a Switch Flow\r\nSoap API equivalent is 'SwitchServerFlowSubmitFileToSubmitPoint'", "operationId": "RestApi_SwitchServerFlowSubmitFileToSubmitPoint", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "switchServerID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "flowID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "elementID", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/SwitchServerFlowSubmitFileToSubmitPointBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/tasks/{taskID}/editorclilog": { "get": { "tags": [ "System" ], "summary": "TaskGetEditorCliLog", "description": "Returns the current log of Editor_CLI (for tasks of type documentSaveXml)\r\nSoap API equivalent is 'TaskGetEditorCliLog'", "operationId": "RestApi_TaskGetEditorCliLog", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "taskID", "in": "path", "description": "The ID of the task", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/tasks/{taskID}/status": { "get": { "tags": [ "System" ], "summary": "TaskGetStatus", "description": "Returns an XML description of the status of a task\r\nSoap API equivalent is 'TaskGetStatus'", "operationId": "RestApi_TaskGetStatus", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "taskID", "in": "path", "description": "The ID of the task", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } }, "put": { "tags": [ "System" ], "summary": "TaskGetStatusAndRemoveIfCompleted", "description": "Returns an XML description of the status of a task. If the task has completed, it will be removed from the Log directory of the Queue\r\nSoap API equivalent is 'TaskGetStatusAndRemoveIfCompleted'", "operationId": "RestApi_TaskGetStatusAndRemoveIfCompleted", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "taskID", "in": "path", "description": "The ID of the task", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/tasks/{taskID}": { "delete": { "tags": [ "System" ], "summary": "TaskRemoveFromLog", "description": "Removes (deletes) a Task file from the Log directory\r\nSoap API equivalent is 'TaskRemoveFromLog'", "operationId": "RestApi_TaskRemoveFromLog", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "taskID", "in": "path", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/tasks/queue": { "get": { "tags": [ "System" ], "summary": "TasksGetQueueOverview", "description": "Returns an overview of the status of the various Windows Services which are monitoring the Queue\r\nSoap API equivalent is 'TasksGetQueueOverview'", "operationId": "RestApi_TasksGetQueueOverview", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/tasks": { "get": { "tags": [ "System" ], "summary": "TasksGetList", "description": "Returns a list of tasks\r\nSoap API equivalent is 'TasksGetList'", "operationId": "RestApi_TasksGetList", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "includeRunningTasks", "in": "query", "description": "If true, running tasks are included", "required": false, "type": "boolean" }, { "name": "includeWaitingTasks", "in": "query", "description": "If true, waiting tasks are included", "required": false, "type": "boolean" }, { "name": "includeFinishedTasks", "in": "query", "description": "If true, finished tasks are included (older tasks are cleaned out after a few hours, though)", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/tasks/statuses": { "get": { "tags": [ "System" ], "summary": "TasksGetStatusses", "description": "Returns the status of multiple tasks simultaneously\r\nSoap API equivalent is 'TasksGetStatusses'", "operationId": "RestApi_TasksGetStatusses", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "body.taskXML", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/urldownload": { "get": { "tags": [ "System" ], "summary": "DownloadURL", "description": "Download a URL from the server. This function is used by CHILI Editor to prevent security issues (eg: crossdomain.xml files which aren't present on the target server)\r\nSoap API equivalent is 'DownloadURL'", "operationId": "RestApi_DownloadURL", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "url", "in": "query", "description": "URL to download, which needs to be accessible from the CHILI server", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/xinetservers/{xinetServerID}/calls/{callID}": { "put": { "tags": [ "Settings" ], "summary": "XinetExecutePortalDICall", "description": "Executes a command by calling the specified Xinet Server's portalDI application\r\nSoap API equivalent is 'XinetExecutePortalDICall'", "operationId": "RestApi_XinetExecutePortalDICall", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "xinetServerID", "in": "path", "description": "The ID of the server settings", "required": true, "type": "string" }, { "name": "callID", "in": "path", "description": "Multiple calls can be made at the same time in the Editor. The callID is returned in the result so the editor knows which Callback to call", "required": true, "type": "string" }, { "name": "arguments", "in": "query", "description": "The arguments to the portalDI application (eg: \"action=showkywdperms\")", "required": false, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/xinetservers/currentcredentials": { "put": { "tags": [ "Settings" ], "summary": "XinetSetCurrentCredentials", "description": "All calls to Xinet WebNative are called from a XinetSetting object, which includes user credentials. If you want to simulate being another user, though, you can call the XinetSetCurrentCredentials function. This applies a new user/pw, and saves it in the apiKey. All subsequent calls to Xinet performed under this apiKey will run under this Xinet User Account. Set the userName to an empty string to re-use the global setting.\r\nSoap API equivalent is 'XinetSetCurrentCredentials'", "operationId": "RestApi_XinetSetCurrentCredentials", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "userName", "in": "query", "description": "The name of the user to simulate", "required": true, "type": "string" }, { "name": "userPW", "in": "query", "description": "The password to log in with", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/settings/xinetservers/testconnection": { "get": { "tags": [ "Settings" ], "summary": "XinetTestConnection", "description": "Tests whether a connection can be made to the portalDI application located at 'url'\r\nSoap API equivalent is 'XinetTestConnection'", "operationId": "RestApi_XinetTestConnection", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "url", "in": "query", "description": "URL to the Xinet server's portalDI application", "required": true, "type": "string" }, { "name": "userName", "in": "query", "description": "User name to log in with", "required": true, "type": "string" }, { "name": "userPW", "in": "query", "description": "user password to log in with", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } } } } }, "/rest-api/v1/system/xmlcsvconverter": { "post": { "tags": [ "System" ], "summary": "CsvFileCreate", "description": "Converts an XML to CSV format, and returns a download link\r\nSoap API equivalent is 'CsvFileCreate'", "operationId": "RestApi_CsvFileCreate", "consumes": [ "application/xml", "application/json" ], "produces": [ "application/xml" ], "parameters": [ { "name": "fileName", "in": "query", "description": "Name of the CSV file to create", "required": true, "type": "string" }, { "name": "body", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/CsvFileCreateBodyWrapper" } } ], "responses": { "201": { "description": "Created", "schema": { "type": "object" } } } } } }, "definitions": { "DocumentCreateTempPackageBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempPackage", "type": "object", "properties": { "docXML": { "type": "string" } } }, "ResourceItemAddBodyWrapper": { "description": "Body parameter class for API method ResourceItemAdd", "type": "object", "properties": { "xml": { "type": "string" }, "fileData": { "type": "string" } } }, "DocumentSetDocumentEventActionsBodyWrapper": { "description": "Body parameter class for API method DocumentSetDocumentEventActions", "type": "object", "properties": { "definitionXML": { "type": "string" } } }, "UploadExternalAssetBodyWrapper": { "description": "Body parameter class for API method UploadExternalAsset", "type": "object", "properties": { "fileData": { "type": "string" } } }, "ResourceItemsAddFromZipBodyWrapper": { "description": "Body parameter class for API method ResourceItemsAddFromZip", "type": "object", "properties": { "fileData": { "type": "string" } } }, "ResourceItemAddFromURLWithModificationDateBodyWrapper": { "description": "Body parameter class for API method ResourceItemAddFromURLWithModificationDate", "type": "object", "properties": { "fileInfoXmlElementContent": { "type": "string" } } }, "DocumentCreateTempFoldingBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempFolding", "type": "object", "properties": { "docXML": { "type": "string" } } }, "DocumentGetFoldingViewerURLBodyWrapper": { "description": "Body parameter class for API method DocumentGetFoldingViewerURL", "type": "object", "properties": { "modXML": { "type": "string" } } }, "DocumentCreateImagesAndPDFBodyWrapper": { "description": "Body parameter class for API method DocumentCreateImagesAndPDF", "type": "object", "properties": { "settingsXML": { "type": "string" } } }, "DocumentCreateTempImagesAndPDFBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempImagesAndPDF", "type": "object", "properties": { "settingsXML": { "type": "string" }, "docXML": { "type": "string" } } }, "DocumentSetDataSourceBodyWrapper": { "description": "Body parameter class for API method DocumentSetDataSource", "type": "object", "properties": { "datasourceXML": { "type": "string" } } }, "DocumentCreateFromODTBodyWrapper": { "description": "Body parameter class for API method DocumentCreateFromODT", "type": "object", "properties": { "odtPathOrData": { "type": "string" }, "settingsXML": { "type": "string" } } }, "DocumentGetThreeDModelViewerURLBodyWrapper": { "description": "Body parameter class for API method DocumentGetThreeDModelViewerURL", "type": "object", "properties": { "modXML": { "type": "string" } } }, "ResourceItemSaveCustomMetaDataBodyWrapper": { "description": "Body parameter class for API method ResourceItemSaveCustomMetaData", "type": "object", "properties": { "xml": { "type": "string" } } }, "DocumentGetHTMLFoldingViewerURLBodyWrapper": { "description": "Body parameter class for API method DocumentGetHTMLFoldingViewerURL", "type": "object", "properties": { "modXML": { "type": "string" } } }, "DocumentGetHTMLThreeDModelViewerURLBodyWrapper": { "description": "Body parameter class for API method DocumentGetHTMLThreeDModelViewerURL", "type": "object", "properties": { "modXML": { "type": "string" } } }, "DocumentProcessServerSideBodyWrapper": { "description": "Body parameter class for API method DocumentProcessServerSide", "type": "object", "properties": { "itemID": { "type": "string" }, "resourceXML": { "type": "string" } } }, "ResourceItemAddPreviewOverrideBodyWrapper": { "description": "Body parameter class for API method ResourceItemAddPreviewOverride", "type": "object", "properties": { "previewFileData": { "type": "string" } } }, "ResourceItemAddWithPreviewBodyWrapper": { "description": "Body parameter class for API method ResourceItemAddWithPreview", "type": "object", "properties": { "xml": { "type": "string" }, "fileData": { "type": "string" }, "previewFileData": { "type": "string" } } }, "ResourceLibrarySaveSettingsBodyWrapper": { "description": "Body parameter class for API method ResourceLibrarySaveSettings", "type": "object", "properties": { "xml": { "type": "string" } } }, "ResourceItemSaveBodyWrapper": { "description": "Body parameter class for API method ResourceItemSave", "type": "object", "properties": { "xml": { "type": "string" } } }, "DocumentCreateFromChiliPackageBodyWrapper": { "description": "Body parameter class for API method DocumentCreateFromChiliPackage", "type": "object", "properties": { "packagePathOrData": { "type": "string" } } }, "DocumentSetVariableDefinitionsBodyWrapper": { "description": "Body parameter class for API method DocumentSetVariableDefinitions", "type": "object", "properties": { "definitionXML": { "type": "string" } } }, "DocumentSetVariableValuesBodyWrapper": { "description": "Body parameter class for API method DocumentSetVariableValues", "type": "object", "properties": { "varXML": { "type": "string" } } }, "DocumentCreateIDMLBodyWrapper": { "description": "Body parameter class for API method DocumentCreateIDML", "type": "object", "properties": { "settingsXML": { "type": "string" } } }, "DocumentCreateHTMLBodyWrapper": { "description": "Body parameter class for API method DocumentCreateHTML", "type": "object", "properties": { "settingsXML": { "type": "string" } } }, "DocumentCreateTempIDMLBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempIDML", "type": "object", "properties": { "docXML": { "type": "string" }, "settingsXML": { "type": "string" } } }, "DocumentCreateODFBodyWrapper": { "description": "Body parameter class for API method DocumentCreateODF", "type": "object", "properties": { "settingsXML": { "type": "string" } } }, "DocumentCreateTempHTMLBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempHTML", "type": "object", "properties": { "docXML": { "type": "string" }, "settingsXML": { "type": "string" } } }, "DocumentCreateTempODFBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempODF", "type": "object", "properties": { "docXML": { "type": "string" }, "settingsXML": { "type": "string" } } }, "DocumentSetAnnotationsBodyWrapper": { "description": "Body parameter class for API method DocumentSetAnnotations", "type": "object", "properties": { "annotationXML": { "type": "string" } } }, "DocumentCreatePDFBodyWrapper": { "description": "Body parameter class for API method DocumentCreatePDF", "type": "object", "properties": { "settingsXML": { "type": "string" } } }, "DocumentCreateTempPDFBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempPDF", "type": "object", "properties": { "settingsXML": { "type": "string" }, "docXML": { "type": "string" } } }, "ResourceItemReplaceFileWithPreviewOverrideBodyWrapper": { "description": "Body parameter class for API method ResourceItemReplaceFileWithPreviewOverride", "type": "object", "properties": { "fileData": { "type": "string" }, "previewFileData": { "type": "string" } } }, "ResourceItemReplaceFileBodyWrapper": { "description": "Body parameter class for API method ResourceItemReplaceFile", "type": "object", "properties": { "fileData": { "type": "string" } } }, "AssetAddOrUpdateSubjectInfoBodyWrapper": { "description": "Body parameter class for API method AssetAddOrUpdateSubjectInfo", "type": "object", "properties": { "asaX": { "format": "double", "type": "number" }, "asaY": { "format": "double", "type": "number" }, "asaWidth": { "format": "double", "type": "number" }, "asaHeight": { "format": "double", "type": "number" }, "poiX": { "format": "double", "type": "number" }, "poiY": { "format": "double", "type": "number" } } }, "DocumentCreateFromPDFBodyWrapper": { "description": "Body parameter class for API method DocumentCreateFromPDF", "type": "object", "properties": { "pdfPathOrData": { "type": "string" } } }, "DocumentCreateImagesBodyWrapper": { "description": "Body parameter class for API method DocumentCreateImages", "type": "object", "properties": { "settingsXML": { "type": "string" } } }, "DocumentCreateTempImagesBodyWrapper": { "description": "Body parameter class for API method DocumentCreateTempImages", "type": "object", "properties": { "settingsXML": { "type": "string" }, "docXML": { "type": "string" } } }, "DataSourceSpreadsheetGetXMLBodyWrapper": { "description": "Body parameter class for API method DataSourceSpreadsheetGetXML", "type": "object", "properties": { "spreadsheetID": { "type": "string" } } }, "SwitchServerFlowSubmitFileToFolderBodyWrapper": { "description": "Body parameter class for API method SwitchServerFlowSubmitFileToFolder", "type": "object", "properties": { "filePathOrData": { "type": "string" } } }, "SwitchServerFlowSubmitFileToSubmitPointBodyWrapper": { "description": "Body parameter class for API method SwitchServerFlowSubmitFileToSubmitPoint", "type": "object", "properties": { "filePathOrData": { "type": "string" }, "metaXML": { "type": "string" } } }, "DynamicAssetProviderGetTempAssetBodyWrapper": { "description": "Body parameter class for API method DynamicAssetProviderGetTempAsset", "type": "object", "properties": { "data": { "type": "string" } } }, "ODTGetStylesBodyWrapper": { "description": "Body parameter class for API method ODTGetStyles", "type": "object", "properties": { "fileData": { "type": "string" } } }, "ODTGetTextFlowBodyWrapper": { "description": "Body parameter class for API method ODTGetTextFlow", "type": "object", "properties": { "fileData": { "type": "string" }, "stylesMapping": { "type": "string" } } }, "DataSourceFileGetXMLBodyWrapper": { "description": "Body parameter class for API method DataSourceFileGetXML", "type": "object", "properties": { "fileDataOrPath": { "type": "string" } } }, "DataSourceAddSampleFileBodyWrapper": { "description": "Body parameter class for API method DataSourceAddSampleFile", "type": "object", "properties": { "fileOrData": { "type": "string" } } }, "SpellingCheckBodyWrapper": { "description": "Body parameter class for API method SpellingCheck", "type": "object", "properties": { "text": { "type": "string" }, "configurationFlags": { "format": "int32", "type": "integer" } } }, "SpellingSuggestBodyWrapper": { "description": "Body parameter class for API method SpellingSuggest", "type": "object", "properties": { "word": { "type": "string" }, "configurationFlags": { "format": "int32", "type": "integer" } } }, "GenerateApiKeyWithSettingsBodyWrapper": { "description": "Body parameter class for API method GenerateApiKeyWithSettings", "type": "object", "properties": { "userName": { "type": "string" }, "password": { "type": "string" }, "settingsXML": { "type": "string" } } }, "LanguageImportUnicodeTextBodyWrapper": { "description": "Body parameter class for API method LanguageImportUnicodeText", "type": "object", "properties": { "filePathOrData": { "type": "string" } } }, "ServerSaveLoggingSettingsBodyWrapper": { "description": "Body parameter class for API method ServerSaveLoggingSettings", "type": "object", "properties": { "xml": { "type": "string" } } }, "ServerLicenseRequestBodyWrapper": { "description": "Body parameter class for API method ServerLicenseRequest", "type": "object", "properties": { "argumentsXML": { "type": "string" } } }, "GenerateApiKeyBodyWrapper": { "description": "Body parameter class for API method GenerateApiKey", "type": "object", "properties": { "userName": { "type": "string" }, "password": { "type": "string" } } }, "GenerateApiKeyOAuthBodyWrapper": { "description": "Body parameter class for API method GenerateApiKeyOAuth", "type": "object", "properties": { "oauth": { "type": "string" } } }, "TasksGetStatussesBodyWrapper": { "description": "Body parameter class for API method TasksGetStatusses", "type": "object", "properties": { "taskXML": { "type": "string" } } }, "EnvironmentSaveSettingsBodyWrapper": { "description": "Body parameter class for API method EnvironmentSaveSettings", "type": "object", "properties": { "xml": { "type": "string" } } }, "ServerSaveSettingsBodyWrapper": { "description": "Body parameter class for API method ServerSaveSettings", "type": "object", "properties": { "xml": { "type": "string" } } }, "LanguageSaveStringsBodyWrapper": { "description": "Body parameter class for API method LanguageSaveStrings", "type": "object", "properties": { "stringXML": { "type": "string" } } }, "LanguageImportCsvBodyWrapper": { "description": "Body parameter class for API method LanguageImportCsv", "type": "object", "properties": { "filePathOrData": { "type": "string" } } }, "CsvFileCreateBodyWrapper": { "description": "Body parameter class for API method CsvFileCreate", "type": "object", "properties": { "xmlData": { "type": "string" } } }, "ApiKeyVerifyBodyWrapper": { "description": "Body parameter class for API method ApiKeyVerify", "type": "object", "properties": { "apiKey": { "type": "string" } } } } }