{ "opencollection": "1.0.0", "info": { "name": "DocuSign Admin AccountBrands WorkspaceItems API", "version": "v2.1" }, "items": [ { "info": { "name": "WorkspaceItems", "type": "folder" }, "items": [ { "info": { "name": "Docusign List Workspace Folder Contents", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "folderId", "value": "", "type": "path", "description": "The ID of the folder being accessed." }, { "name": "workspaceId", "value": "", "type": "path", "description": "Specifies the workspace ID GUID." }, { "name": "count", "value": "", "type": "query", "description": "The maximum number of results to be returned by this request." }, { "name": "include_files", "value": "", "type": "query", "description": "When set to **true**, file information is returned in the response along with folder information. The default is **false**." }, { "name": "include_sub_folders", "value": "", "type": "query", "description": "When set to **true**, information about the sub-folders of the current folder is returned. The default is **false**." }, { "name": "include_thumbnails", "value": "", "type": "query", "description": "When set to **true**, thumbnails are returned as part of the response. The default is **false**." }, { "name": "include_user_detail", "value": "", "type": "query", "description": "Set to **true** to return extended details about the user. The default is **false**." }, { "name": "start_position", "value": "", "type": "query", "description": "The position within the total result set from which to start returning values." }, { "name": "workspace_user_id", "value": "", "type": "query", "description": "If set, then the results are filtered to those associated with the specified userId." } ] }, "docs": "Retrieves workspace folder contents, which can include sub folders and files." }, { "info": { "name": "Docusign Deletes workspace one or more specific files/folders from the given folder or root.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "folderId", "value": "", "type": "path", "description": "The ID of the folder being accessed." }, { "name": "workspaceId", "value": "", "type": "path", "description": "Specifies the workspace ID GUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Docusign Deletes workspace one or more specific files/folders from the given folder or root." }, { "info": { "name": "Docusign Creates a workspace file.", "type": "http" }, "http": { "method": "POST", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "folderId", "value": "", "type": "path", "description": "The ID of the folder being accessed." }, { "name": "workspaceId", "value": "", "type": "path", "description": "Specifies the workspace ID GUID." } ] }, "docs": "Docusign Creates a workspace file." }, { "info": { "name": "Docusign Get Workspace File", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files/:fileId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "fileId", "value": "", "type": "path", "description": "Specifies the room file ID GUID." }, { "name": "folderId", "value": "", "type": "path", "description": "The ID of the folder being accessed." }, { "name": "workspaceId", "value": "", "type": "path", "description": "Specifies the workspace ID GUID." }, { "name": "is_download", "value": "", "type": "query", "description": "When set to **true**, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. Default is **false**." }, { "name": "pdf_version", "value": "", "type": "query", "description": "When set to **true** the file returned as a PDF." } ] }, "docs": "Retrieves a workspace file (the binary)." }, { "info": { "name": "Docusign Update Workspace File Metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files/:fileId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "fileId", "value": "", "type": "path", "description": "Specifies the room file ID GUID." }, { "name": "folderId", "value": "", "type": "path", "description": "The ID of the folder being accessed." }, { "name": "workspaceId", "value": "", "type": "path", "description": "Specifies the workspace ID GUID." } ] }, "docs": "Updates workspace item metadata for one or more specific files/folders." }, { "info": { "name": "Docusign List File Pages", "type": "http" }, "http": { "method": "GET", "url": "https://api.docusign.net/Management/v2/accounts/:accountId/workspaces/:workspaceId/folders/:folderId/files/:fileId/pages", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The external account number (int) or account id GUID." }, { "name": "fileId", "value": "", "type": "path", "description": "Specifies the room file ID GUID." }, { "name": "folderId", "value": "", "type": "path", "description": "The ID of the folder being accessed." }, { "name": "workspaceId", "value": "", "type": "path", "description": "Specifies the workspace ID GUID." }, { "name": "count", "value": "", "type": "query", "description": "The maximum number of results to be returned by this request." }, { "name": "dpi", "value": "", "type": "query", "description": "Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310." }, { "name": "max_height", "value": "", "type": "query", "description": "Sets the maximum height (in pixels) of the returned image." }, { "name": "max_width", "value": "", "type": "query", "description": "Sets the maximum width (in pixels) of the returned image." }, { "name": "start_position", "value": "", "type": "query", "description": "The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image." } ] }, "docs": "Retrieves a workspace file as rasterized pages." } ] } ], "bundled": true }