SingleEntryTables Parameter (Connect-Workday Cmdlet)
A list of tables for which SOAP API collections are displayed as one row entry per collection entry.
Syntax
Connect-Workday -SingleEntryTables string
Data Type
cstr
Default Value
"Payments"
Remarks
This connection property applies when the ConnectionType connection property is set to SOAP.
When tools like the cmdlet request certain data from the Workday SOAP API, the API returns this data in the form of a multi-valued collection, rather than returning individual values.
By default, the cmdlet displays each entry in the collection as a separate row and ignores the reference ID(s) that associate the collection entry with the collection it belongs to.
For example, these are the columns visible in the CommitteeDefinition table by default:
- Included: ID, Private_Committee, Include_Code_In_Name, ...
- Excluded: Committee_Definition_Reference_ID_WID, Committee_Definition_Reference_ID_CommitteeObjectID
However, the Workday SOAP API sometimes lists data as a collection even when only one value is actually allowed inside the collection.
When this happens, you can add the table to this connection property. The cmdlet then treats the collection as if it only has one value:
- Any tables specified in this connection property include the reference ID(s) in each row.
- The cmdlet marks the reference ID as the primary key of the table.
- The cmdlet marks the reference ID as the foreign key of any child tables.
There are three ways to set this property:
- As a comma-separated list of tables to include. For example, setting this connection property to "Payments,CommitteeDefinition" converts collection entries to rows for just those two tables.
- As a comma-separated list of tables to exclude, with each table starting with a "-". For example, setting this connection property to "-SupplierInvoices,-CommitteeDefinition" converts collection entries to rows for every table except those two tables.
- Setting this connection property to "*" converts collection entries to rows for every table whose data is returned by the API as a collection.