PUT /tables/{id}

Use this method to edit an existing table with the specified name. You must supply a JSON formatted body with your request. | Secured by | | ---------- |

Servers

Path parameters

Name Type Required Description
id String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
id String No
documentation String No

A long string field you can use to include more detailed information about this object for internal documentation purposes. The documentation must contain less than 32,000 characters.

name String No
description String No

The description of the object. The description must contain less than 1,000 characters.

tags[] Array No

Analytic tags

tags[].id String No
tags[].name String No
displayName String No

The display name for the object. You can change this name at any time. If you don't include this parameter, Workday sets it to the same value in the name parameter.

enableForAnalysis Boolean No

Creates a Prism data source using the data in this table that can be used for querying.

fields[] Array No
fields[].fieldId String No

Readonly attribute included in the response.

fields[].parseFormat String No

Required for Date fields. The Date format that the values in this field must match to be recognized as a Date field.

fields[].description String No

The description of the field. The description must contain less than 1,000 characters.

fields[].required Boolean No

Required when field is set as the external ID (primary key). Specifies that the field must contain data. Make a field required to ensure it doesn’t contain a NULL value when you insert or update data in the table. When you insert or update data in a table and this field is NULL, Workday rejects the row and instead includes it in the error file.

fields[].ordinal Integer No

The order of the field in the file (index). The ordinal values:

  • Must start with 1.
  • Must be contiguous.
  • Can't skip any number.
  • Have a maximum of 1,000.
fields[].displayName String No

The display name for the object. You can change this name at any time. If you don't include this parameter, Workday sets it to the same value in the name parameter.

fields[].precision Integer No

Required for Numeric fields. The maximum number of digits in a Numeric field. This value includes all digits to the left and right of the decimal point. The maximum value is 38.

fields[].id String No
fields[].name String No
fields[].context Object No
fields[].context.id String No
fields[].context.descriptor String No
fields[].defaultValue String No

Specifies a value for a field if the uploaded source file schema doesn't include that field. When the source file schema doesn't include a field, Workday uses the default value for all rows in the source file.

Note: The Default Value is only used when the source file schema is missing a field, not when a particular field value is NULL.

fields[].externalId Boolean No

Required when the target operation is update, upsert, or delete. Specifies the field in a table to use as a key. Specify a field as the external ID when the values in the field uniquely identify each row from its source.

Set a field as the external ID if you want to update or delete data in the table based on data in an external file. This parameter is similar to a primary key in a relational database.

When using this parameter, consider:

  • You can only define 1 field in a table as the external ID field.
  • Ensure that each field value in the external ID field is unique. If the field values aren’t unique, you'll get unexpected results. Workday doesn’t enforce the uniqueness.
  • You can’t define a default value for fields used as an external ID. The field value must come from the external source and can’t be NULL.
  • You must set the external ID field as required.
fields[].type Object No
fields[].type.id String No

Valid values:

  • "Schema_Field_Type=Date"
  • "Schema_Field_Type=Currency"
  • "Schema_Field_Type=Multi_Instance"
  • "Schema_Field_Type=Text"
  • "Schema_Field_Type=Numeric"
  • "Schema_Field_Type=Integer"
  • "Schema_Field_Type=Boolean"
  • "<id>"
  • "Schema_Field_Type=Decimal"
  • "Schema_Field_Type=Instance"
  • "Schema_Field_Type=Long"
fields[].type.name String No
  • Boolean - True/False value
  • Numeric - Numeric
  • Text - String
  • Date - Datetime
  • Currency - Currency
  • Instance - ID of an instance
  • Multi_Instance - List of IDs of instances. Use this format: "type": { "id": "Schema_Field_Type=type" }

Valid values:

  • "Date"
  • "Instance"
  • "Numeric"
  • "Text"
  • "Multi_Instance"
  • "Currency"
  • "Boolean"
fields[].scale Integer No

Required for Numeric fields. The maximum number of digits to the right of the decimal point in a Numeric field. This value must be less than the precision value.

fields[].businessObject Object No
fields[].businessObject.id String No
fields[].businessObject.descriptor String No

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.