LegacySpreadsheetsAsync

Use these endpoints to asynchronously write data to spreadsheets in the Workiva platform. All calls to the Workiva Spreadsheets API may return a message and request_id as part of the JSON response. If present, message contains a human readable descriptions of the response condition. request_id is a unique identifier for the request.

Job

Properties

Name	Type	Description	Restrictions
created	string(date-time)	Date-time (UTC) corresponding to the creation of the job
finished	string(date-time)	Date-time (UTC) corresponding to the creation of the spreadsheet
id	string	Unique identifier for the Job
next_url	string	A fully qualified URL, including required query parameters, to query for the job output results. If the job status is not SUCCESSFUL, this will be empty.
status	string	Current status of the job. PENDING, RUNNING, FAILED, SUCCESSFUL

Example

{
  "created": "2020-04-30T14:23:21.690124Z",
  "finished": "2020-04-30T14:23:22.413304132Z",
  "id": "bd9iOjhlYmViZDY2YjdkYzQzMHU5NmU5MWQ4YzRjMTNiOWYwOjI",
  "next_url": "https://api.app.wdesk.com/spreadsheets/v1/queue-jobs/bd9iOjhlYmViZDY2YjdkYzQzMHU5NmU5MWQ4YzRjMTNiOWYwOjI",
  "status": "SUCCESSFUL"
}

JobCreatedResponse

Properties

Name	Type	Description	Restrictions
data	object¦null
data.id	string	Unique identifier for the Job
next_url	string	A fully qualified URL, including required query parameters, to query for the job status. If there is no next page to query for, this will be empty.
request_id	string	A unique identifier for the request

Example

{
  "data": {
    "id": "bd9iOjhlYmViZDY2YjdkYzQzMHU5NmU5MWQ4YzRjMTNiOWYwOjI"
  },
  "next_url": "https://api.app.wdesk.com/spreadsheets/v1/queue-jobs/bd9iOjhlYmViZDY2YjdkYzQzMHU5NmU5MWQ4YzRjMTNiOWYwOjI",
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c"
}

JobDataResponse

Properties

Name	Type	Description	Restrictions
data	Job
request_id	string	A unique identifier for the request

Example

{
  "data": {
    "created": "2020-04-30T14:23:21.690124Z",
    "finished": "2020-04-30T14:23:22.413304132Z",
    "id": "bd9iOjhlYmViZDY2YjdkYzQzMHU5NmU5MWQ4YzRjMTNiOWYwOjI",
    "next_url": "https://api.app.wdesk.com/spreadsheets/v1/queue-jobs/bd9iOjhlYmViZDY2YjdkYzQzMHU5NmU5MWQ4YzRjMTNiOWYwOjI",
    "status": "SUCCESSFUL"
  },
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c"
}