The following are Postman Collections (v2.1) that can be imported into Postman for testing the Wdata API. To import, click the "Import" button in Postman and either copy and save the following Collection(s) as a .json file or import as raw text.

Last updated: 06/08/2023

Identity and Access Management (IAM) API

Documentation: https://developers.workiva.com/workiva-iam/reference

{ "info": { "name": "Identity and Access Management (IAM) API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Retrieve a token (perferred)", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{client_secret}}", "type": "string" }, { "key": "username", "value": "{{client_id}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" } ] }, "url": { "raw": "https://api.{{environment}}.wdesk.com/iam/v1/oauth2/token", "protocol": "https", "host": [ "api", "{{environment}}", "wdesk", "com" ], "path": [ "iam", "v1", "oauth2", "token" ] }, "description": "[https://developers.workiva.com/workiva-iam/reference/iam-tokenrequest](https://developers.workiva.com/workiva-iam/reference/iam-tokenrequest)" }, "response": [] }, { "name": "Retrieve a token (alternative)", "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "client_id", "value": "{{client_id}}", "type": "text" }, { "key": "client_secret", "value": "{{client_secret}}", "type": "text" }, { "key": "grant_type", "value": "client_credentials", "type": "text" }, { "key": "scope", "value": "", "type": "text" } ] }, "url": { "raw": "https://api.{{environment}}.wdesk.com/iam/v1/oauth2/token", "protocol": "https", "host": [ "api", "{{environment}}", "wdesk", "com" ], "path": [ "iam", "v1", "oauth2", "token" ] }, "description": "[https://developers.workiva.com/workiva-iam/reference/iam-tokenrequest](https://developers.workiva.com/workiva-iam/reference/iam-tokenrequest)" }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "environment", "value": "app", "type": "string" }, { "key": "client_id", "value": "Retrieve from OAuth2 Grant", "type": "string" }, { "key": "client_secret", "value": "Retrieve from OAuth2 Grant", "type": "string" } ]}

Setup: After the collection is imported into Postman, select the "Identify and Access Management (IAM) API" collection. Click on the "Variables" tab. In the "Current value" column, enter the values for each row. The value for "environment" may be 'app', 'eu', or 'apac'. Review Manage and add API grants documentation for generating a Client ID and Client Secret. Click "Save" when complete.

Wdata API

Documentation: https://developers.workiva.com/workiva-wdata/reference

{ "info": { "name": "Wdata API", "description": "Connect, curate, and explore data within Wdata\n\n[https://developers.workiva.com/workiva-wdata/reference](https://developers.workiva.com/workiva-wdata/reference)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Administrative Tasks", "item": [ { "name": "Delete a single workspace", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/account", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "account" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deleteworkspaceusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deleteworkspaceusingdelete)" }, "response": [] }, { "name": "Export a single workspace", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/export", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "export" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-exportworkspaceusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-exportworkspaceusingget)" }, "response": [] }, { "name": "Import data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [] } ] }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/import", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "import" ], "query": [ { "key": "wipe", "value": "", "description": "wipe", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-importdatausingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-importdatausingpost)" }, "response": [] }, { "name": "Retrieve workspace files by size", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/usage/filesBySize", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "usage", "filesBySize" ], "query": [ { "key": "limit", "value": null, "description": "The number of file meta objects to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-findworkspacefilesbysizeusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-findworkspacefilesbysizeusingget)" }, "response": [] }, { "name": "Retrieve workspace query usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/usage/query", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "usage", "query" ], "query": [ { "key": "startDate", "value": null, "description": "The earliest date of usage to consider", "disabled": true }, { "key": "stopDate", "value": null, "description": "The end date of usage to consider", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getworkspacequeryusageusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getworkspacequeryusageusingget)" }, "response": [] }, { "name": "Retrieve workspace upload usage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/usage/upload", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "usage", "upload" ], "query": [ { "key": "startDate", "value": null, "description": "The starting point to begin considering usage", "disabled": true }, { "key": "StopDate", "value": null, "description": "The ending point when considering usage", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getworkspaceuploadusageusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getworkspaceuploadusageusingget)" }, "response": [] }, { "name": "Validate files", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"tableId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/validation/files", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "validation", "files" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-validatefilesusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-validatefilesusingpost)" }, "response": [] }, { "name": "Validate tables", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/admin/validation/tables", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "admin", "validation", "tables" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-validatetablesusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-validatetablesusingpost)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-administrativetasks](https://developers.workiva.com/workiva-wdata/reference/wdata-administrativetasks)" }, { "name": "API Health", "item": [ { "name": "Health check", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/health", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "health" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-healthcheckusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-healthcheckusingget)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-apihealth](https://developers.workiva.com/workiva-wdata/reference/wdata-apihealth)" }, { "name": "Connection Management", "item": [ { "name": "List connections", "request": { "method": "GET", "header": [ { "key": "Acc", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/connections", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "connections" ], "query": [ { "key": "sourceType", "value": null, "description": "The type of file or item the connection pulls data from", "disabled": true }, { "key": "destinationType", "value": null, "description": "The type of file or item the connection sends data to", "disabled": true }, { "key": "sourceId", "value": null, "description": "The ID of the file or item the connection pulls data from", "disabled": true }, { "key": "destinationId", "value": null, "description": "The ID of the file or item the connection sends data to", "disabled": true }, { "key": "limit", "value": null, "description": "The number of connections to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listconnectionsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listconnectionsusingget)" }, "response": [] }, { "name": "Refresh bathc of connections", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"connectionId\": \"string\",\r\n \"destinationParameters\": {},\r\n \"sourceParameters\": {},\r\n \"usePreviousDestinationParameters\": false,\r\n \"usePreviousSourceParameters\": false,\r\n \"workspaceId\": \"string\"\r\n }\r\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/connections/batch/refresh", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "connections", "batch", "refresh" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-refreshbatchusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-refreshbatchusingpost)" }, "response": [] }, { "name": "Gets the status of a batch refresh", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/connections/batch/refresh/:batchId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "connections", "batch", "refresh", ":batchId" ], "query": [ { "key": "workspaceId", "value": null, "description": "workspaceId", "disabled": true } ], "variable": [ { "key": "batchId", "value": null, "description": "The ID of the batch to return details about" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getrefreshbatchstatususingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getrefreshbatchstatususingget)" }, "response": [] }, { "name": "Get connection details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/connections/:connectionId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "connections", ":connectionId" ], "query": [ { "key": "workspaceId", "value": null, "description": "workspaceId", "disabled": true } ], "variable": [ { "key": "connectionId", "value": null, "description": "The ID of the connection to return details about" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getconnectionusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getconnectionusingget)" }, "response": [] }, { "name": "Refresh connection", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "applicaiton/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"connectionId\": \"string\",\r\n \"destinationParameters\": {},\r\n \"sourceParameters\": {},\r\n \"usePreviousDestinationParameters\": false,\r\n \"usePreviousSourceParameters\": false,\r\n \"workspaceId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/connections/:connectionId/refresh", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "connections", ":connectionId", "refresh" ], "variable": [ { "key": "connectionId", "value": null, "description": "The ID of the connection to refresh" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-refreshconnectionusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-refreshconnectionusingpost)" }, "response": [] }, { "name": "Get connection refresh status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/connections/:connectionId/status", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "connections", ":connectionId", "status" ], "query": [ { "key": "workspaceId", "value": null, "description": "workspaceId", "disabled": true }, { "key": "jobId", "value": null, "description": "The ID of the job running for a connection", "disabled": true } ], "variable": [ { "key": "connectionId", "value": null, "description": "The ID of the connection to return details about" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getrefreshstatususingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getrefreshstatususingget)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-connectionmanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-connectionmanagement)" }, { "name": "File Management", "item": [ { "name": "Retrieve a list of files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/file?tableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file" ], "query": [ { "key": "tableId", "value": null, "description": "The unique table identifier associated with this file" }, { "key": "limit", "value": "", "description": "The number of files to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": "", "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": "", "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true }, { "key": "sortOrder", "value": "", "description": "The sort order for the files being returned", "disabled": true }, { "key": "sortBy", "value": "", "description": "The column to use the sort order on", "disabled": true }, { "key": "searchText", "value": null, "description": "The text to filter the results upon; matching the file name", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getfilesusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getfilesusingget)" }, "response": [] }, { "name": "Upload a single file", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "formdata", "formdata": [ { "key": "tableId", "value": "", "description": "The unique table identifier associated with this file", "type": "text" }, { "key": "file", "description": "The physical file to upload", "type": "file", "src": [] }, { "key": "delimiter", "value": "", "description": "The character to use as a delimiter within the file to separate one field from another. The default is comma", "type": "text", "disabled": true }, { "key": "source", "value": "", "description": "The data source to associate with the file, no more than 255 characters. This field is not in use; it only keeps track of the source", "type": "text", "disabled": true } ] }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/file", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-uploadfileusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-uploadfileusingpost)" }, "response": [] }, { "name": "Validate whether a file with the filename can be uploaded to the table", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/file/validateName?tableId=&filename=", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file", "validateName" ], "query": [ { "key": "tableId", "value": "", "description": "The ID of the table to upload the file to" }, { "key": "filename", "value": "", "description": "The name of the file to upload" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-validatefilenameusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-validatefilenameusingget)" }, "response": [] }, { "name": "Delete a single file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/file/:fileId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file", ":fileId" ], "variable": [ { "key": "fileId", "value": "", "description": "The unique identifier of the file" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletefileusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletefileusingdelete)" }, "response": [] }, { "name": "Retrieve a single file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.app.wdesk.com/s/wdata/prep/api/v1/file/:fileId", "protocol": "https", "host": [ "h", "app", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file", ":fileId" ], "variable": [ { "key": "fileId", "value": "", "description": "The unique identifier of the file" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getfileusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getfileusingget)" }, "response": [] }, { "name": "Download a single file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/file/:fileId/download", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file", ":fileId", "download" ], "variable": [ { "key": "fileId", "value": "", "description": "The unique identifier of the file" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-downloadfileusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-downloadfileusingget)" }, "response": [] }, { "name": "Retrieve errors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "applicaiton/json", "type": "text" } ], "url": { "raw": "https://h.app.wdesk.com/s/wdata/prep/api/v1/file/:fileId/error", "protocol": "https", "host": [ "h", "app", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file", ":fileId", "error" ], "query": [ { "key": "limit", "value": null, "description": "The number of errors to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ], "variable": [ { "key": "fileId", "value": "", "description": "The unique identifier of the file" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-geterrorsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-geterrorsusingget)" }, "response": [] }, { "name": "Export a file to spreadsheets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"url\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/file/:fileId/export", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "file", ":fileId", "export" ], "variable": [ { "key": "fileId", "value": "", "description": "The unique identifier of the file" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-exportfiletospreadsheetsusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-exportfiletospreadsheetsusingpost)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-filemanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-filemanagement)" }, { "name": "Folder Management", "item": [ { "name": "Search", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/entity?name", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "entity" ], "query": [ { "key": "name", "value": null, "description": "The name to use when fuzzy-matching entities" }, { "key": "description", "value": null, "description": "The description to use when fuzzy-matching entities", "disabled": true }, { "key": "type", "value": null, "description": "To limit the scope, the type of entity to return in the results", "disabled": true }, { "key": "limit", "value": null, "description": "The number of folders to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-searchusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-searchusingget)" }, "response": [] }, { "name": "Retrieve a list of folders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/folder", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder" ], "query": [ { "key": "limit", "value": null, "description": "The number of folders to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listfoldersusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listfoldersusingget)" }, "response": [] }, { "name": "Create a new folder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"string\",\r\n \"name\": \"string\",\r\n \"parentId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/folder", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createfolderusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createfolderusingpost)" }, "response": [] }, { "name": "Delete a single folder", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/folder/:folderId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder", ":folderId" ], "variable": [ { "key": "folderId", "value": "", "description": "The unique identifier of the folder" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletefolderusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletefolderusingdelete)" }, "response": [] }, { "name": "Retrieve a single folder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.app.wdesk.com/s/wdata/prep/api/v1/folder/:folderId", "protocol": "https", "host": [ "h", "app", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder", ":folderId" ], "variable": [ { "key": "folderId", "value": "", "description": "The unique identifier of the folder" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getfolderusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getfolderusingget)" }, "response": [] }, { "name": "Update a single folder", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"string\",\r\n \"name\": \"string\",\r\n \"parentId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/folder/:folderId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder", ":folderId" ], "variable": [ { "key": "folderId", "value": "", "description": "The unique identifier of the folder" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updatefolderusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updatefolderusingput)" }, "response": [] }, { "name": "Retrieve list of folder contents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/folder/:folderId/children", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder", ":folderId", "children" ], "query": [ { "key": "limit", "value": null, "description": "The number of folders to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ], "variable": [ { "key": "folderId", "value": "", "description": "The unique identifier of the folder" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listchildrenusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listchildrenusingget)" }, "response": [] }, { "name": "Move content into a folder", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"id\": \"string\",\r\n \"type\": 0\r\n }\r\n]" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/folder/:folderId/children", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "folder", ":folderId", "children" ], "variable": [ { "key": "folderId", "value": "", "description": "The unique identifier of the folder" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-setchildrenusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-setchildrenusingpost)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-foldermanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-foldermanagement)", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Parameter Management", "item": [ { "name": "Get Parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/parameter", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "parameter" ], "query": [ { "key": "limit", "value": null, "description": "The number of parameters to return, must be between 1 and 1000, will default to 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included the limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, must be greater than or equal to 0, will default to 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listparametersusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listparametersusingget)" }, "response": [] }, { "name": "Create Parameter", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"string\",\r\n \"label\": \"string\",\r\n \"mode\": \"scalar\",\r\n \"name\": \"string\",\r\n \"overridable\": false,\r\n \"selectListId\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": {}\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/parameter", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "parameter" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createparameterusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createparameterusingpost)" }, "response": [] }, { "name": "Delete Parameter", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/parameter/:parameterId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "parameter", ":parameterId" ], "variable": [ { "key": "parameterId", "value": null, "description": "The unique identifier of the parameter" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deleteparameterusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deleteparameterusingdelete)" }, "response": [] }, { "name": "Get Parameter", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/parameter/:parameterId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "parameter", ":parameterId" ], "variable": [ { "key": "parameterId", "value": null, "description": "The unique identifier of the parameter" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getparameterusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getparameterusingget)" }, "response": [] }, { "name": "Update Parameter", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"string\",\r\n \"label\": \"string\",\r\n \"mode\": \"scalar\",\r\n \"name\": \"string\",\r\n \"overridable\": false,\r\n \"selectListId\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": {}\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/parameter/:parameterId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "parameter", ":parameterId" ], "variable": [ { "key": "parameterId", "value": null, "description": "The unique identifier of the parameter" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updateparameterusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updateparameterusingput)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-parametermanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-parametermanagement)" }, { "name": "Pivot View Management", "item": [ { "name": "Retrieve a list of pivot views", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/pivotview?queryId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "pivotview" ], "query": [ { "key": "queryId", "value": null, "description": "The unique query identifier to filter the views" }, { "key": "limit", "value": null, "description": "The number of views to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listpivotviewsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listpivotviewsusingget)" }, "response": [] }, { "name": "Create a new pivot view", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"additionalMeta\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"description\": \"string\",\r\n \"name\": \"string\",\r\n \"queryId\": \"string\",\r\n \"queryResultId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/pivotview", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "pivotview" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createpivotviewusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createpivotviewusingpost)" }, "response": [] }, { "name": "Delete a single pivot view", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/pivotview/:pivotViewId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "pivotview", ":pivotViewId" ], "variable": [ { "key": "pivotViewId", "value": "", "description": "The unique identifier of the pivot view" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletepivotviewusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletepivotviewusingdelete)" }, "response": [] }, { "name": "Retrieve a single pivot view", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/pivotview/:pivotViewId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "pivotview", ":pivotViewId" ], "variable": [ { "key": "pivotViewId", "value": "", "description": "The unique identifier of the pivot view" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getpivotviewusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getpivotviewusingget)" }, "response": [] }, { "name": "Update a single pivot view", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"additionalMeta\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"description\": \"string\",\r\n \"name\": \"string\",\r\n \"queryId\": \"string\",\r\n \"queryResultId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/pivotview/:pivotViewId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "pivotview", ":pivotViewId" ], "variable": [ { "key": "pivotViewId", "value": "", "description": "The unique identifier of the pivot view" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updatepivotviewusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updatepivotviewusingput)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-pivotviewmanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-pivotviewmanagement)" }, { "name": "Query Management", "item": [ { "name": "Retrieve list of queries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query" ], "query": [ { "key": "limit", "value": "", "description": "The number of queries to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": "", "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": "", "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true }, { "key": "ids", "value": null, "description": "A list of ids to filter the returned list by", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listqueriesusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listqueriesusingget)" }, "response": [] }, { "name": "Create a new query", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"definition\": {\r\n \"columns\": [\r\n {\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ],\r\n \"decimalPlaces\": 16,\r\n \"filters\": [\r\n {\r\n \"betweenValue\": \"string\",\r\n \"columnType\": \"integer\",\r\n \"exclude\": false,\r\n \"filter\": \"EQUAL\",\r\n \"filterValues\": [\r\n \"string\"\r\n ],\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"grandTotalEnabled\": \"ENABLED\",\r\n \"id\": \"string\",\r\n \"multipleHeaders\": false,\r\n \"pivotViewType\": \"CLASSIC\",\r\n \"rows\": [\r\n {\r\n \"name\": \"string\",\r\n \"type\": \"integer\"\r\n }\r\n ],\r\n \"sortColumns\": [\r\n \"string\"\r\n ],\r\n \"subtotalEnabled\": \"ENABLED\",\r\n \"values\": [\r\n {\r\n \"active\": true,\r\n \"aggregation\": \"sum\",\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ]\r\n },\r\n \"description\": \"string\",\r\n \"historyRevision\": 0,\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"parameters\": [\r\n {\r\n \"alias\": \"string\",\r\n \"id\": \"string\",\r\n \"label\": \"string\",\r\n \"mode\": \"scalar\",\r\n \"name\": \"string\",\r\n \"selectListId\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": {}\r\n }\r\n ],\r\n \"primaryQueryResultId\": \"string\",\r\n \"queryText\": \"string\",\r\n \"temporary\": false,\r\n \"type\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createqueryusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createqueryusingpost)" }, "response": [] }, { "name": "Retrieve query column data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"queryText\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/data", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", "data" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getquerycolumndatausingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-getquerycolumndatausingpost)" }, "response": [] }, { "name": "Preview a query", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/preview/:tableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", "preview", ":tableId" ], "query": [ { "key": "limit", "value": null, "description": "The number of rows to return", "disabled": true }, { "key": "fileName", "value": null, "description": "The name of the file to create", "disabled": true } ], "variable": [ { "key": "tableId", "value": "", "description": "The identifier of the table to query" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-previewqueryusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-previewqueryusingpost)" }, "response": [] }, { "name": "Parses the query to determine if it is valid", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"definition\": {\r\n \"columns\": [\r\n {\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ],\r\n \"decimalPlaces\": 16,\r\n \"filters\": [\r\n {\r\n \"betweenValue\": \"string\",\r\n \"columnType\": \"integer\",\r\n \"exclude\": false,\r\n \"filter\": \"EQUAL\",\r\n \"filterValues\": [\r\n \"string\"\r\n ],\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"grandTotalEnabled\": \"ENABLED\",\r\n \"id\": \"string\",\r\n \"multipleHeaders\": false,\r\n \"pivotViewType\": \"CLASSIC\",\r\n \"rows\": [\r\n {\r\n \"name\": \"string\",\r\n \"type\": \"integer\"\r\n }\r\n ],\r\n \"sortColumns\": [\r\n \"string\"\r\n ],\r\n \"subtotalEnabled\": \"ENABLED\",\r\n \"values\": [\r\n {\r\n \"active\": true,\r\n \"aggregation\": \"sum\",\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ]\r\n },\r\n \"description\": \"string\",\r\n \"historyRevision\": 0,\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"parameters\": [\r\n {\r\n \"alias\": \"string\",\r\n \"id\": \"string\",\r\n \"label\": \"string\",\r\n \"mode\": \"scalar\",\r\n \"name\": \"string\",\r\n \"selectListId\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": {}\r\n }\r\n ],\r\n \"primaryQueryResultId\": \"string\",\r\n \"queryText\": \"string\",\r\n \"temporary\": false,\r\n \"type\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/validation", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", "validation" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-isqueryvalidusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-isqueryvalidusingpost)" }, "response": [] }, { "name": "Delete a single query", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/:queryId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", ":queryId" ], "variable": [ { "key": "queryId", "value": "", "description": "The unique identifier of the query" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletequeryusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletequeryusingdelete)" }, "response": [] }, { "name": "Retrieve a single query", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/:queryId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", ":queryId" ], "variable": [ { "key": "queryId", "value": "", "description": "The unique identifier of the query" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getqueryusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getqueryusingget)" }, "response": [] }, { "name": "Update a single query", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"definition\": {\r\n \"columns\": [\r\n {\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ],\r\n \"decimalPlaces\": 16,\r\n \"filters\": [\r\n {\r\n \"betweenValue\": \"string\",\r\n \"columnType\": \"integer\",\r\n \"exclude\": false,\r\n \"filter\": \"EQUAL\",\r\n \"filterValues\": [\r\n \"string\"\r\n ],\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"grandTotalEnabled\": \"ENABLED\",\r\n \"id\": \"string\",\r\n \"multipleHeaders\": false,\r\n \"pivotViewType\": \"CLASSIC\",\r\n \"rows\": [\r\n {\r\n \"name\": \"string\",\r\n \"type\": \"integer\"\r\n }\r\n ],\r\n \"sortColumns\": [\r\n \"string\"\r\n ],\r\n \"subtotalEnabled\": \"ENABLED\",\r\n \"values\": [\r\n {\r\n \"active\": true,\r\n \"aggregation\": \"sum\",\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ]\r\n },\r\n \"description\": \"string\",\r\n \"historyRevision\": 0,\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"parameters\": [\r\n {\r\n \"alias\": \"string\",\r\n \"id\": \"string\",\r\n \"label\": \"string\",\r\n \"mode\": \"scalar\",\r\n \"name\": \"string\",\r\n \"selectListId\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": {}\r\n }\r\n ],\r\n \"primaryQueryResultId\": \"string\",\r\n \"queryText\": \"string\",\r\n \"temporary\": false,\r\n \"type\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/:queryId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", ":queryId" ], "variable": [ { "key": "queryId", "value": "", "description": "The unique identifier of the query" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updatequeryusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updatequeryusingput)" }, "response": [] }, { "name": "Retrieve dependencies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/:queryId/dependencies", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", ":queryId", "dependencies" ], "query": [ { "key": "limit", "value": null, "description": "The number of dependencies to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ], "variable": [ { "key": "queryId", "value": "", "description": "The unique identifier of the query" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getdependenciesusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getdependenciesusingget)" }, "response": [] }, { "name": "Retrieve a list of dependents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/query/:queryId/dependents", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "query", ":queryId", "dependents" ], "query": [ { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "limit", "value": null, "description": "The number of query results to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ], "variable": [ { "key": "queryId", "value": null, "description": "The unique identifier of the query" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-gettablesdependentonqueryusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-gettablesdependentonqueryusingget)" }, "response": [] }, { "name": "Retrieve a list of query results", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/queryresult?queryId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "queryresult" ], "query": [ { "key": "queryId", "value": null, "description": "The unique identifier of the query" }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "limit", "value": null, "description": "The number of query results to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listqueryresultsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listqueryresultsusingget)" }, "response": [] }, { "name": "Execute a query", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"isExplain\": false,\r\n \"parameters\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"queryDto\": {\r\n \"definition\": {\r\n \"columns\": [\r\n {\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ],\r\n \"decimalPlaces\": 16,\r\n \"filters\": [\r\n {\r\n \"betweenValue\": \"string\",\r\n \"columnType\": \"integer\",\r\n \"exclude\": false,\r\n \"filter\": \"EQUAL\",\r\n \"filterValues\": [\r\n \"string\"\r\n ],\r\n \"name\": \"string\",\r\n \"value\": \"string\"\r\n }\r\n ],\r\n \"grandTotalEnabled\": \"ENABLED\",\r\n \"id\": \"string\",\r\n \"multipleHeaders\": false,\r\n \"pivotViewType\": \"CLASSIC\",\r\n \"rows\": [\r\n {\r\n \"name\": \"string\",\r\n \"type\": \"integer\"\r\n }\r\n ],\r\n \"sortColumns\": [\r\n \"string\"\r\n ],\r\n \"subtotalEnabled\": \"ENABLED\",\r\n \"values\": [\r\n {\r\n \"active\": true,\r\n \"aggregation\": \"sum\",\r\n \"columnType\": \"integer\",\r\n \"name\": \"string\"\r\n }\r\n ]\r\n },\r\n \"description\": \"string\",\r\n \"historyRevision\": 0,\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"parameters\": [\r\n {\r\n \"alias\": \"string\",\r\n \"id\": \"string\",\r\n \"label\": \"string\",\r\n \"mode\": \"scalar\",\r\n \"name\": \"string\",\r\n \"selectListId\": \"string\",\r\n \"type\": \"string\",\r\n \"value\": {}\r\n }\r\n ],\r\n \"primaryQueryResultId\": \"string\",\r\n \"queryText\": \"string\",\r\n \"temporary\": false,\r\n \"type\": \"string\"\r\n },\r\n \"queryId\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/queryresult", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "queryresult" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-runqueryusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-runqueryusingpost)" }, "response": [] }, { "name": "Cancel a running query", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.app.wdesk.com/s/wdata/prep/api/v1/queryresult/:queryResultId", "protocol": "https", "host": [ "h", "app", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "queryresult", ":queryResultId" ], "variable": [ { "key": "queryResultId", "value": "", "description": "The unique identifier of the query result" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-cancelqueryusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-cancelqueryusingdelete)" }, "response": [] }, { "name": "Retrieve a single query result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.app.wdesk.com/s/wdata/prep/api/v1/queryresult/:queryResultId", "protocol": "https", "host": [ "h", "app", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "queryresult", ":queryResultId" ], "variable": [ { "key": "queryResultId", "value": "", "description": "The unique identifier of the query result" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getqueryresultusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getqueryresultusingget)" }, "response": [] }, { "name": "Download a query result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/queryresult/:queryResultId/download", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "queryresult", ":queryResultId", "download" ], "variable": [ { "key": "queryResultId", "value": "", "description": "The unique identifier of the query result" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-downloadqueryresultusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-downloadqueryresultusingget)" }, "response": [] }, { "name": "Export query result to spreadsheets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"exportAsDataset\": false,\r\n \"url\": \"string\",\r\n \"useFlatKey\": false\r\n}" }, "url": { "raw": "https://h.app.wdesk.com/s/wdata/prep/api/v1/queryresult/:queryResultId/export", "protocol": "https", "host": [ "h", "app", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "queryresult", ":queryResultId", "export" ], "variable": [ { "key": "queryResultId", "value": "", "description": "The unique identifier of the query result" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-exportqueryresulttospreadsheetsusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-exportqueryresulttospreadsheetsusingpost)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-querymanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-querymanagement)" }, { "name": "Select List Management", "item": [ { "name": "Retrieve a list of select lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/selectlist", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "selectlist" ], "query": [ { "key": "limit", "value": null, "description": "The number of select lists to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listselectlistsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listselectlistsusingget)" }, "response": [] }, { "name": "Create a new select list", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"string\",\r\n \"name\": \"string\",\r\n \"valueType\": \"string\",\r\n \"values\": [\r\n {}\r\n ]\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/selectlist", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "selectlist" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createselectlistusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createselectlistusingpost)" }, "response": [] }, { "name": "Delete a single select list", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/selectlist/:selectListId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "selectlist", ":selectListId" ], "variable": [ { "key": "selectListId", "value": "", "description": "The unique identifier of the select list" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deleteusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deleteusingdelete)" }, "response": [] }, { "name": "Retrieve a single select list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/selectlist/:selectListId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "selectlist", ":selectListId" ], "variable": [ { "key": "selectListId", "value": "", "description": "The unique identifier of the select list" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getselectlistusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getselectlistusingget)" }, "response": [] }, { "name": "Update a single select list", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"description\": \"string\",\r\n \"name\": \"string\",\r\n \"valueType\": \"string\",\r\n \"values\": [\r\n {}\r\n ]\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/selectlist/:selectListId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "selectlist", ":selectListId" ], "variable": [ { "key": "selectListId", "value": "", "description": "The unique identifier of the select list" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updateselectlistusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updateselectlistusingput)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-selectlistmanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-selectlistmanagement)" }, { "name": "Shared Table Management", "item": [ { "name": "Retrieve a list of shared tables", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "applicaiton/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/sharedtable?tableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "sharedtable" ], "query": [ { "key": "tableId", "value": null, "description": "The unique table identifier associated with the shared table" }, { "key": "sharedWithMe", "value": null, "description": "If true, returns a list of tables that have been shared to it rather than from it. The entities contain both the shared table entity and the table being shared. If true, tableId is ignored.", "disabled": true }, { "key": "limit", "value": null, "description": "The number of shared files to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listsharedtablesusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listsharedtablesusingget)" }, "response": [] }, { "name": "Create a new shared table", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"destinationWorkspaceId\": \"string\",\r\n \"sourceTableId\": \"string\",\r\n \"table\": {\r\n \"datasetUpdated\": \"2019-08-24T14:15:22Z\",\r\n \"description\": \"string\",\r\n \"hierarchyMetadata\": {\r\n \"childColumnId\": \"string\",\r\n \"parentColumnId\": \"string\"\r\n },\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"tableSchema\": {\r\n \"columns\": [\r\n {\r\n \"alias\": \"string\",\r\n \"description\": \"string\",\r\n \"metadata\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"mode\": \"nullable\",\r\n \"name\": \"string\",\r\n \"type\": \"string\"\r\n }\r\n ]\r\n },\r\n \"type\": \"data\",\r\n \"uniqueTableConstraints\": [\r\n {\r\n \"description\": \"string\",\r\n \"id\": \"string\",\r\n \"name\": \"key_columns\",\r\n \"tableId\": \"string\",\r\n \"values\": [\r\n \"string\"\r\n ]\r\n }\r\n ]\r\n }\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/sharedtable", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "sharedtable" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createsharedtableusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createsharedtableusingpost)" }, "response": [] }, { "name": "Delete a single shared table", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/sharedtable/:sharedTableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "sharedtable", ":sharedTableId" ], "variable": [ { "key": "sharedTableId", "value": "", "description": "The unique identifier of the shared table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletesharedtableusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletesharedtableusingdelete)" }, "response": [] }, { "name": "Retrieve a single shared table", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/sharedtable/:sharedTableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "sharedtable", ":sharedTableId" ], "query": [ { "key": "sharedWithMe", "value": null, "description": "If true, returns a shared table with the provided ID that has been shared to—rather than from—the workspace of the request.", "disabled": true } ], "variable": [ { "key": "sharedTableId", "value": "", "description": "The unique identifier of the shared table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getsharedtableusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getsharedtableusingget)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-sharedtablemanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-sharedtablemanagement)" }, { "name": "Table Management", "item": [ { "name": "Retrieve a list of tables", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table" ], "query": [ { "key": "includeShared", "value": null, "description": "If true, returns all tables shared with the workspace associated with the request. If false, returns only tables the workspace owns.\n", "disabled": true }, { "key": "limit", "value": null, "description": "the number of folders to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, must be greater than or equal to 0, will default to 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-gettablesusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-gettablesusingget)" }, "response": [] }, { "name": "Create a new table", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"datasetUpdated\": \"2019-08-24T14:15:22Z\",\r\n \"description\": \"string\",\r\n \"hierarchyMetadata\": {\r\n \"childColumnId\": \"string\",\r\n \"parentColumnId\": \"string\"\r\n },\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"tableSchema\": {\r\n \"columns\": [\r\n {\r\n \"alias\": \"string\",\r\n \"description\": \"string\",\r\n \"metadata\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"mode\": \"nullable\",\r\n \"name\": \"string\",\r\n \"type\": \"string\"\r\n }\r\n ]\r\n },\r\n \"type\": \"data\",\r\n \"uniqueTableConstraints\": [\r\n {\r\n \"description\": \"string\",\r\n \"id\": \"string\",\r\n \"name\": \"key_columns\",\r\n \"tableId\": \"string\",\r\n \"values\": [\r\n \"string\"\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createtableusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createtableusingpost)" }, "response": [] }, { "name": "Delete a single table", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId" ], "variable": [ { "key": "tableId", "value": "", "description": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletetableusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletetableusingdelete)" }, "response": [] }, { "name": "Retriee a single table", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId" ], "variable": [ { "key": "tableId", "value": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-gettableusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-gettableusingget)" }, "response": [] }, { "name": "Update a single table", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"datasetUpdated\": \"2019-08-24T14:15:22Z\",\r\n \"description\": \"string\",\r\n \"hierarchyMetadata\": {\r\n \"childColumnId\": \"string\",\r\n \"parentColumnId\": \"string\"\r\n },\r\n \"isShared\": false,\r\n \"name\": \"string\",\r\n \"tableSchema\": {\r\n \"columns\": [\r\n {\r\n \"alias\": \"string\",\r\n \"description\": \"string\",\r\n \"metadata\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"mode\": \"nullable\",\r\n \"name\": \"string\",\r\n \"type\": \"string\"\r\n }\r\n ]\r\n },\r\n \"type\": \"data\",\r\n \"uniqueTableConstraints\": [\r\n {\r\n \"description\": \"string\",\r\n \"id\": \"string\",\r\n \"name\": \"key_columns\",\r\n \"tableId\": \"string\",\r\n \"values\": [\r\n \"string\"\r\n ]\r\n }\r\n ]\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId" ], "variable": [ { "key": "tableId", "value": "", "description": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updatetableusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updatetableusingput)" }, "response": [] }, { "name": "Retrieve a list of dependents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId/dependents", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId", "dependents" ], "query": [ { "key": "limit", "value": null, "description": "The number of folders to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ], "variable": [ { "key": "tableId", "value": "", "description": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getdependentsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getdependentsusingget)" }, "response": [] }, { "name": "Import a single file", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"columnMappings\": \"{\\\"import column id\\\":\\\"table column id\\\"}\",\r\n \"delimiter\": \"string\",\r\n \"fileId\": \"string\",\r\n \"metadata\": {\r\n \"property1\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n },\r\n \"property2\": {\r\n \"property1\": {},\r\n \"property2\": {}\r\n }\r\n },\r\n \"tags\": \"{\\\"key\\\": \\\"value\\\"}\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId/import", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId", "import" ], "variable": [ { "key": "tableId", "value": "", "description": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-importfileusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-importfileusingpost)" }, "response": [] }, { "name": "Unimport a single file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId/import/:fileId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId", "import", ":fileId" ], "query": [ { "key": "force", "value": null, "description": "If true, unimports and deletes file from the table", "disabled": true } ], "variable": [ { "key": "tableId", "value": "", "description": "The unique identifier of the table\n" }, { "key": "fileId", "value": "", "description": "The unique identifier of the file\n" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-unimportfileusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-unimportfileusingdelete)" }, "response": [] }, { "name": "Retrieve import information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId/importInfo", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId", "importInfo" ], "variable": [ { "key": "tableId", "value": null, "description": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-getimportinfousingget](https://developers.workiva.com/workiva-wdata/reference/wdata-getimportinfousingget)" }, "response": [] }, { "name": "Import from spreadsheets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"fileId\": \"string\",\r\n \"name\": \"string\",\r\n \"tags\": {\r\n \"property1\": \"string\",\r\n \"property2\": \"string\"\r\n },\r\n \"url\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/table/:tableId/spreadsheet/import", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "table", ":tableId", "spreadsheet", "import" ], "variable": [ { "key": "tableId", "value": "", "description": "The unique identifier of the table" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-importfromspreadsheetsusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-importfromspreadsheetsusingpost)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-tablemanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-tablemanagement)" }, { "name": "Tag Management", "item": [ { "name": "Retrieve a list of tags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/tag", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "tag" ], "query": [ { "key": "limit", "value": null, "description": "The number of tags to return, from 1 to 1000; by default, 1000", "disabled": true }, { "key": "cursor", "value": null, "description": "A paging cursor; if included, limit is ignored", "disabled": true }, { "key": "offset", "value": null, "description": "The item to start with on the page, greater than or equal to 0; by default, 0", "disabled": true } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-listtagsusingget](https://developers.workiva.com/workiva-wdata/reference/wdata-listtagsusingget)" }, "response": [] }, { "name": "Create a new tag", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"key\": \"string\",\r\n \"values\": [\r\n \"string\"\r\n ]\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/tag", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "tag" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createtagusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createtagusingpost)" }, "response": [] }, { "name": "Delete a single tag", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/tag/:tagId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "tag", ":tagId" ], "variable": [ { "key": "tagId", "value": "", "description": "The unique identifier of the tag\n" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-deletetagusingdelete](https://developers.workiva.com/workiva-wdata/reference/wdata-deletetagusingdelete)" }, "response": [] }, { "name": "Update a single tag", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"key\": \"string\",\r\n \"values\": [\r\n \"string\"\r\n ]\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/tag/:tagId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "tag", ":tagId" ], "variable": [ { "key": "tagId", "value": "", "description": "The unique identifier of the tag" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-updatetagusingput](https://developers.workiva.com/workiva-wdata/reference/wdata-updatetagusingput)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-tagmanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-tagmanagement)" }, { "name": "Token Management", "item": [ { "name": "Create a new token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"objectId\": \"string\",\r\n \"useFlatKey\": false\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/token", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "token" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-createtokenusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-createtokenusingpost)" }, "response": [] }, { "name": "Download a single file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*", "type": "text" } ], "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/token/:tokenId", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "token", ":tokenId" ], "query": [ { "key": "filename", "value": null, "description": "A filename for the download; if included, the default filename is overridden", "disabled": true } ], "variable": [ { "key": "tokenId", "value": "", "description": "The unique identifier of the token" } ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-downloadfileusingget_1](https://developers.workiva.com/workiva-wdata/reference/wdata-downloadfileusingget_1)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-tokenmanagement](https://developers.workiva.com/workiva-wdata/reference/wdata-tokenmanagement)" }, { "name": "Utilities", "item": [ { "name": "Parse a date", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\r\n \"candidate\": \"string\",\r\n \"dateFormat\": \"string\"\r\n}" }, "url": { "raw": "https://h.{{environment}}.wdesk.com/s/wdata/prep/api/v1/util/datetime", "protocol": "https", "host": [ "h", "{{environment}}", "wdesk", "com" ], "path": [ "s", "wdata", "prep", "api", "v1", "util", "datetime" ] }, "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-parsedateusingpost](https://developers.workiva.com/workiva-wdata/reference/wdata-parsedateusingpost)" }, "response": [] } ], "description": "[https://developers.workiva.com/workiva-wdata/reference/wdata-utilities](https://developers.workiva.com/workiva-wdata/reference/wdata-utilities)" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "client_authentication", "value": "header", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "tokenRequestParams", "value": [], "type": "any" }, { "key": "refreshTokenUrl", "value": "https://api.{{environment}}.wdesk.com/iam/v1/oauth2/token", "type": "string" }, { "key": "tokenName", "value": "Wdata Bearer Token", "type": "string" }, { "key": "refreshRequestParams", "value": [], "type": "any" }, { "key": "authRequestParams", "value": [], "type": "any" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "clientSecret", "value": "{{client_secret}}", "type": "string" }, { "key": "clientId", "value": "{{client_id}}", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "accessTokenUrl", "value": "https://api.{{environment}}.wdesk.com/iam/v1/oauth2/token", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "environment", "value": "app" }, { "key": "client_id", "value": "Retrieve from OAuth2 Grant" }, { "key": "client_secret", "value": "Retrieve from OAuth2 Grant" } ]}

Setup: After the collection is imported into Postman, select the "Wdata API" collection. Click on the "Variables" tab. In the "Current value" column, enter the values for each row. The value for "environment" may be 'app', 'eu', or 'apac'. Review Manage and add API grants documentation for generating a Client ID and Client Secret. Click "Save" when complete.

Click on the "Authorization" tab. At the bottom, click the "Get New Access Token" button.

On success, you will receive an 'Authentication complete' prompt that will allow you to click the "Proceed" button.

On the Manage Access Tokens window, click the "Use Token" button next to the valid token that was generated.

This token is valid for 10 minutes. At the end of 10 minutes, repeat the steps above in the Authorization tab to generate a new token. You can manage your token(s) in the "Current Token" section by clicking on the Token drop down menu.