{ "opencollection": "1.0.0", "info": { "name": "Kiteworks API Documentation activities sources API", "version": "28" }, "items": [ { "info": { "name": "sources", "type": "folder" }, "items": [ { "info": { "name": "Return user's sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources", "params": [ { "name": "include_kw", "value": "", "type": "query", "description": "If true, includes Kiteworks native sources in the results." }, { "name": "include_container", "value": "", "type": "query", "description": "If true, includes container-type sources (e.g. SharePoint document libraries) in the results." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return." }, { "name": "offset", "value": "", "type": "query", "description": "Number of results to skip before returning results, for pagination." }, { "name": "query", "value": "", "type": "query", "description": "Search query string to filter sources or sites by name." }, { "name": "search_type", "value": "", "type": "query", "description": "Type of search to perform against the source." } ] }, "docs": "### Description:\n Returns a list of sources available to the current user, such as external cloud storage or SharePoint connections.\n### Precondition:\n User must be authenticated and have access to at least one source.\n### Response:\n A list of the user's sources is returned.\n" }, { "info": { "name": "Add user ECM source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rest/sources", "params": [ { "name": "returnEntity", "value": "", "type": "query", "description": "If set to `true`, returns information about the newly created entity." }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new ECM source for the current user with the provided name, URL, and source type. Returns 422 if a source with the same name or URL already exists for this user." }, { "info": { "name": "Lock Repositories Gateway files", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/rest/sources/actions/lock", "params": [ { "name": "id:in", "value": "", "type": "query", "description": "A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed." }, { "name": "partialSuccess", "value": "", "type": "query", "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure." }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Locks one or more Repositories Gateway files. Supports partial success — if some files cannot be locked, the operation continues for the remaining files." }, { "info": { "name": "Unlock Repositories Gateway files", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/rest/sources/actions/unlock", "params": [ { "name": "id:in", "value": "", "type": "query", "description": "A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed." }, { "name": "partialSuccess", "value": "", "type": "query", "description": "If set to `true`, the operation will continue for the valid items even if some items result in failure." }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Unlocks one or more Repositories Gateway files. Supports partial success — if some files cannot be unlocked, the operation continues for the remaining files." }, { "info": { "name": "Login to cloud source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rest/sources/auth", "body": { "type": "json", "data": "{}" } }, "docs": "Completes the cloud ECM authentication flow by submitting the code and state values returned by the ECM provider's redirect URL. Returns 200 on success or an error if the credentials are invalid." }, { "info": { "name": "Get kp transfer status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/files/actions/transferStatus", "params": [ { "name": "transactionId", "value": "", "type": "query", "description": "Transaction ID of download" }, { "name": "transactionId:in", "value": "", "type": "query", "description": "Transaction ID of download. Search for results that match any of the specified values for this parameter." }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns the status of one or more file transfer operations to Repositories Gateway, including transaction ID, file name, user ID, error code, transfer status, and AV/DLP scan results." }, { "info": { "name": "Get info of an Repositories Gateway file.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of Repositories Gateway file" }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns the details of the specified Repositories Gateway file, including its name, parent ID, type, timestamps, and the current user's permissions on it." }, { "info": { "name": "Delete an Repositories Gateway file.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rest/sources/files/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of Repositories Gateway file" }, { "name": "forceDelete", "value": "", "type": "query", "description": "If set to true, allows the user to delete a file that is only in their own use." }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Permanently deletes the specified Repositories Gateway file. When the `forceDelete` query parameter is set to true, the file can be deleted even if it is currently in use by the requesting user. Deleting a file in use by another user is not permitted." }, { "info": { "name": "Get info of an Repositories Gateway folder.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/folders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of Repositories Gateway folder" }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns the details of the specified Repositories Gateway folder, including its name, parent, type, timestamps, and child counts." }, { "info": { "name": "Delete an Repositories Gateway folder.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rest/sources/folders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of Repositories Gateway folder" } ] }, "docs": "Permanently deletes the specified Repositories Gateway folder." }, { "info": { "name": "Returns requested ECM source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the source to be retrieved" }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns the details of the specified ECM source, including its name, description, URL, source type, pinned status, and the current user's permissions on it." }, { "info": { "name": "Deletes specified source", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rest/sources/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the source to be deleted." } ] }, "docs": "Removes the specified ECM source from the current user's source list." }, { "info": { "name": "Get url with redirect to cloud ECM auth", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id/auth", "params": [ { "name": "id", "value": "", "type": "path", "description": "The source ID" } ] }, "docs": "Returns the authentication redirect URL and client ID for the specified cloud ECM source. The caller should redirect the user to the returned URL to complete the authentication flow with the ECM provider." }, { "info": { "name": "Login to on-premise source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rest/sources/:id/auth", "params": [ { "name": "id", "value": "", "type": "path", "description": "The source ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Authenticates the current user to the specified on-premise ECM source using a login and password. Returns 200 on success or an error if the credentials are invalid." }, { "info": { "name": "Get cloud ECM auth status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id/authStatus", "params": [ { "name": "id", "value": "", "type": "path", "description": "The source ID" } ] }, "docs": "Checks whether the current user is authenticated to the specified cloud ECM source by attempting to list its contents. Returns HTTP 200 if authenticated, or an error if authentication is required." }, { "info": { "name": "Returns the content of the specified ECM source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id/children", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the source folder to be retrieved" }, { "name": "name", "value": "", "type": "query", "description": "Object name" }, { "name": "name:contains", "value": "", "type": "query", "description": "Object name. Search for results that contain the specified characters in this parameter." }, { "name": "description", "value": "", "type": "query", "description": "Object description" }, { "name": "description:contains", "value": "", "type": "query", "description": "Object description. Search for results that contain the specified characters in this parameter." }, { "name": "created", "value": "", "type": "query", "description": "Object creation date" }, { "name": "created:gt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than the specified value." }, { "name": "created:gte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "created:lt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than the specified value." }, { "name": "created:lte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "modified", "value": "", "type": "query", "description": "Object modification date" }, { "name": "modified:gt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than the specified value." }, { "name": "modified:gte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "modified:lt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than the specified value." }, { "name": "modified:lte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "deleted", "value": "", "type": "query", "description": "Indicates that object is deleted" }, { "name": "type", "value": "", "type": "query", "description": "Filter by object type. Accepted values: `f`, `d`." }, { "name": "orderBy", "value": "", "type": "query", "description": "Sorting options" }, { "name": "offset", "value": "", "type": "query", "description": "Offset" }, { "name": "limit", "value": "", "type": "query", "description": "Limit" }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns a paginated list of both files and subfolders within the specified ECM source folder, including each item's name, parent ID, type, timestamps, and permissions." }, { "info": { "name": "Get access token for external file edit.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id/externalEdit", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the file" }, { "name": "name", "value": "", "type": "query", "description": "Object name" }, { "name": "name:contains", "value": "", "type": "query", "description": "Object name. Search for results that contain the specified characters in this parameter." }, { "name": "userId", "value": "", "type": "query", "description": "Unique identifier of Object creator" }, { "name": "userId:in", "value": "", "type": "query", "description": "Unique identifier of Object creator. Search for results that match any of the specified values for this parameter." }, { "name": "created", "value": "", "type": "query", "description": "Object creation date" }, { "name": "created:gt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than the specified value." }, { "name": "created:gte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "created:lt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than the specified value." }, { "name": "created:lte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "modified", "value": "", "type": "query", "description": "Object modification date" }, { "name": "modified:gt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than the specified value." }, { "name": "modified:gte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "modified:lt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than the specified value." }, { "name": "modified:lte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "deleted", "value": "", "type": "query", "description": "Indicates whether the object is deleted." }, { "name": "expire", "value": "", "type": "query", "description": "Expiration date" }, { "name": "expire:gt", "value": "", "type": "query", "description": "Expiration date. Search for results where this parameter value is greater than the specified value." }, { "name": "expire:gte", "value": "", "type": "query", "description": "Expiration date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "expire:lt", "value": "", "type": "query", "description": "Expiration date. Search for results where this parameter value is less than the specified value." }, { "name": "expire:lte", "value": "", "type": "query", "description": "Expiration date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "isPushed", "value": "", "type": "query", "description": "Whether the file is pushed" }, { "name": "orderBy", "value": "", "type": "query", "description": "Sorting options" }, { "name": "offset", "value": "", "type": "query", "description": "Offset" }, { "name": "limit", "value": "", "type": "query", "description": "Limit" }, { "name": "locate_id", "value": "", "type": "query", "description": "If specified, \"offset\" parameter will be ignored\n and the page containing entity with this Id will be returned." }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns a short-lived refresh token (expires after 300 seconds) scoped to the specified Repositories Gateway file, enabling an external editor to download and re-upload the file." }, { "info": { "name": "Returns the list of folders of the specified ECM folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id/folders", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the source folder to be retrieved" }, { "name": "name", "value": "", "type": "query", "description": "Object name" }, { "name": "name:contains", "value": "", "type": "query", "description": "Object name. Search for results that contain the specified characters in this parameter." }, { "name": "description", "value": "", "type": "query", "description": "Object description" }, { "name": "description:contains", "value": "", "type": "query", "description": "Object description. Search for results that contain the specified characters in this parameter." }, { "name": "created", "value": "", "type": "query", "description": "Object creation date" }, { "name": "created:gt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than the specified value." }, { "name": "created:gte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "created:lt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than the specified value." }, { "name": "created:lte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "modified", "value": "", "type": "query", "description": "Object modification date" }, { "name": "modified:gt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than the specified value." }, { "name": "modified:gte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "modified:lt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than the specified value." }, { "name": "modified:lte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "deleted", "value": "", "type": "query", "description": "Indicates that object is deleted" }, { "name": "orderBy", "value": "", "type": "query", "description": "Sorting options" }, { "name": "offset", "value": "", "type": "query", "description": "Offset" }, { "name": "limit", "value": "", "type": "query", "description": "Limit" }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns a paginated list of subfolders within the specified ECM source folder, including each folder's name, parent ID, type, timestamps, and permissions." }, { "info": { "name": "Get file preview metadata for a file in Repositories Gateway source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:id/preview", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the file from Repositories Gateway Source." } ] }, "docs": "Gets the current preview generation status for the specified file in a Repositories Gateway\n source. When the preview is ready, the response includes the MIME type and a link to retrieve\n it. If the file is empty, infected, or DLP-locked, an appropriate error status is returned\n instead.\\n\\n**Requires `view` permission on the file.**" }, { "info": { "name": "Returns the list of files of the specified ECM folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rest/sources/:parent/files", "params": [ { "name": "parent", "value": "", "type": "path", "description": "ID of the source folder to be retrieved" }, { "name": "name", "value": "", "type": "query", "description": "Object name" }, { "name": "name:contains", "value": "", "type": "query", "description": "Object name. Search for results that contain the specified characters in this parameter." }, { "name": "description", "value": "", "type": "query", "description": "Object description" }, { "name": "description:contains", "value": "", "type": "query", "description": "Object description. Search for results that contain the specified characters in this parameter." }, { "name": "created", "value": "", "type": "query", "description": "Object creation date" }, { "name": "created:gt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than the specified value." }, { "name": "created:gte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "created:lt", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than the specified value." }, { "name": "created:lte", "value": "", "type": "query", "description": "Object creation date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "modified", "value": "", "type": "query", "description": "Object modification date" }, { "name": "modified:gt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than the specified value." }, { "name": "modified:gte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is greater than or equal to the specified value." }, { "name": "modified:lt", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than the specified value." }, { "name": "modified:lte", "value": "", "type": "query", "description": "Object modification date. Search for results where this parameter value is less than or equal to the specified value." }, { "name": "deleted", "value": "", "type": "query", "description": "Indicates that object is deleted" }, { "name": "orderBy", "value": "", "type": "query", "description": "Sorting options" }, { "name": "offset", "value": "", "type": "query", "description": "Offset" }, { "name": "limit", "value": "", "type": "query", "description": "Limit" }, { "name": "with", "value": "", "type": "query", "description": "With parameters" }, { "name": "mode", "value": "", "type": "query", "description": "Determines the detail level of the response body." } ] }, "docs": "Returns a paginated list of files within the specified ECM source folder, including each file's name, parent ID, type, timestamps, and permissions." } ] } ], "bundled": true }