POST /buckets/{id}/files

The buckets/Files resource represents a single file you can upload to the bucket. Use version 2 of the REST API to associate the bucket with a table, and use version 1 of the REST API to associate the bucket with a dataset. You can only upload files to a bucket permitted by the security profile of the current user.

Use this method to upload a single file to a bucket for a particular table or dataset. The bucket state must be New. You must supply a file in the body with your request. The file must be delimited and gzip compressed.

Secured by

When you use the REST API to create tables or datasets, you upload 1 or more data source files to Workday. Workday uses the data in these files to populate the table or dataset. Workday supports delimited files that are RFC 4180-compliant. For more information, see RFC 4180.

Consider these guidelines and requirements: - You can upload 1 file in each POST request. To upload multiple files into the bucket, create multiple POST requests either sequentially or concurrently. - Files must be gzip compressed. - Each filename in a bucket must be unique. - The schema of the files you upload must match the schema defined in the bucket. - The maximum number of concurrent uploads is 10. - The files must be delimited, such as a comma-delimited file. - If the file contains any empty lines, Workday: - Ignores the empty lines. - The files must be gzip compressed. - Each record must be delimited by a newline character, and must be either CR (\r), LF (\n), or CRLF (\r\n). - If a field value contains the field delimiter, new line character, or double quotes, then the field value must be enclosed in a quote character, such as double quotes. - If the field value contains a quote character, then it must be escaped by: - The escape character (fieldsEnclosingCharacterEscapedBy parameter). - Workday doesn't trim leading or trailing spaces in field values. Any spaces before or after the field delimiter or inside the quote characters are part of the field value. Example: This text includes a leading space in the second field: Tom Smith, Marge Smith - Numeric field values can only contain numerals and a period as the decimal point in order to be recognized as a numeric value. - Date field values must match a supported date format in order to be recognized as a date value. - The number of fields in the files must match the number of fields in the bucket fields parameter. - The maximum number of fields is 1,000. - The maximum length of a field value is 32,000 characters. - The maximum length of a row in the data source file is 500,000 characters.

Servers

Path parameters

Name Type Required Description
id String Yes

A reference to a Prism Analytics table. Example: The ID of the table.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.