Attachment Objects

What additional fields does Workday automatically generate when you create an attachment object?

Workday automatically generates four fields: file, fileName, fileLength, and contentType.

What is the purpose of the automatically generated attachment fields?

They enable you to associate file data with instances of the attachment object.

What does the file field store?

It stores the attached file or image as a base64-encoded string.

What does the fileName field store?

It stores the name of the attached file.

How can you write to the fileName field?

By calling the POST or PUT methods of the attachment object API.

Can you write directly to fileLength or contentType?

No. These fields are derived and cannot be written to directly.

How can you read fileLength and contentType?

By using the GET method of the attachment object API.

What is the Workday File Size report field used for?

It can be used to validate the amount of disk space used by a single attachment in an Extend app.

Where is the File Size report field secured?

It is secured to the Public Reporting Items domain.

In which functional area is the File Size report field secured?

Tenant Non-Configurable.

What content type must be used when writing both file data and additional attachment fields in the same API request?

multipart/form-data

When is multipart/form-data required for an attachment object API request?

When an attachment object contains additional fields and you want to write both the file data and field data in the same request.

What does the file value look like in a multipart request?

The JSON data references the uploaded file using a content ID, for example: "file": "cid: filedata".

How is the actual file supplied in a multipart request?

It is supplied as a separate multipart form-data part, such as filedata=@/path/to/image. jpg.

Can an attachment object contain additional custom fields?

Yes. You can define additional fields on the attachment object.

Does the order of multipart form data matter for attachment uploads?

Yes. The JSON data must be provided before the filedata.

What happens if JSON data is sent after filedata?

The request returns a 500 Internal Server Error.

What is the correct order in the example multipart request?

First the data part, then the filedata part.

What header is required when a GET request asks only for attachment field data and not file data?

Accept: application/json

What happens if Accept: application/json is omitted when requesting only field data?

The request returns the file data without the field data.

Why should you use Accept: application/json for field-only GET requests?

To ensure the API returns the attachment's field data rather than the file data.

Does the DELETE operation on attachment objects support bulk=true?

No. Attachment object DELETE operations do not support bulk=true.

What should you remember about deleting attachment objects?

DELETE is supported, but bulk=true is not supported.

Can you upload multiple files to an attachment object in a single API request?

Yes

How do you upload multiple files in one request?

Append Collection to the attachment object endpoint.

What endpoint pattern is used to upload multiple attachment objects?

POST /{attachmentObjectName} Collection

What example endpoint is used for uploading multiple charity images?

POST https://api. workday.com/apps/charitableDonations_nkzjqw/v1/charityImagesCollection

Where do you provide the individual files when uploading multiple files?

In an array in the request body.

What must the name of the array be when uploading multiple files?

It must match the name of the attachment object's defaultCollection

What is the relationship between defaultCollection. name and the collection endpoint?

The collection endpoint uses the attachment object's collection, and the request body's array name must match defaultCollection. name

How should file data be specified when using the fileUploader widget?

In the metadata attribute.

hat should the singular attribute be when using fileUploader to upload multiple files?

It should be set to false.

What is the default value of the singular attribute in fileUploader?

false

How do you specify that a value is multipart in a PMD's valueOutBinding?

Use Colons: to delimit/seperate the value out. The Format is outboundEndpointName +: + partName +: + data

How can you write to the metadata (additional information) of an Attachment Object from a PMD? (Select all that apply.)

In a ValueOUTBinding on a widget, in An onMultiPartSend() script, in the metadata attribute of a fileUploader

How CAN't you write to the metadata (additional information) of an Attachment Object from a PMD? (Select all that apply.)

in a valuesOut[] array on an Outbound Endpoint, in an on Send() script. Do not mix using a valueOutBinding on a hidden widget to do this and using the metadata attribute or onMultiPartSend().

What “type” is used to reference to another “target” object?

"SINGLE_INSTANCE", The target attribute is a reference to the name of another concurrently defined business object or a reference to a Workday-delivered business object. This attribute is available on SINGLE_INSTANCE field types of a business object.

Why do you need a multipart request to upload Attachments? (Select all that apply.)

Attachment Object API requests send multiple kinds of data in a single request, To allow for both file binary and JSON metadata (fields on the attachment) to be uploaded together

To support the Attachment Object, what PMD tag is used to enable uploads into a Business Object.

fileUploader

How many parts does an Attachment Object always have?

A data part containing JSON metadata and a file part containing the binary file data.

What format is used for the metadata part?

JSON.

How can you retrieve only the file from an Attachment Object?

Remove the Accept: application/json header from the request.

What happens when the Accept: application/json header is omitted?

The file itself is retrieved instead of the JSON field data.

Why should you use onMultiPartSend instead of onSend for multipart requests?

Because onMultiPartSend is designed for multipart requests and allows you to update the data part with field information.

Can onSend add information to the data part of a multipart request?

No. For multipart requests, use onMultiPartSend instead.

What does onMultiPartSend do in a fileUploader scenario?

It passes data from the fileUploader to the outbound endpoint and can update multipart metadata before the request is sent.

What HTTP method does the fileUploader widget support for submitting file attachments?

POST only.

Does fileUploader support PUT for submitting file attachments?

No

What is the consequence of fileUploader not supporting PUT?

Uploading a new file does not automatically overwrite the previous file.

How can you replace an existing file uploaded through fileUploader?

Add a DELETE outbound endpoint to remove the existing file before or when a replacement is uploaded.

When should the existing file be deleted in the described Event Image scenario?

Only when a new file has been uploaded.

What information can be used directly by the metadata attribute?

Information from endpoint calls, flow variables, query parameters, or an onLoad script.

When is the metadata attribute sufficient?

When the metadata depends only on values available before the widgets render, such as endpoint results, flow variables, query parameters, or onLoad.

When should onMultiPartSend() be used instead of only metadata?

When the metadata depends on user interaction or widget values.

What is the key difference between metadata and onMultiPartSend()?

metadata handles information available before rendering, while onMultiPartSend() can update metadata based on runtime user/widget values.

What is the minimum required value for the metadata attribute when sending multipart data?

At least an empty map {}

Why must metadata contain at least {}?

Without it, fileUploader cannot send multipart data to the outbound endpoint.

What does valueOutBinding do in a fileUploader when using the Attachment API?

It specifies which outbound endpoint receives the file and creates the multipart part that contains the file binary.

What should the multipart file part be named when using fileUploader with the Attachment API?

It should use the name of the Attachment Object's defaultCollection.

What two things are specified by valueOutBinding?

The outbound endpoint and the multipart part name for the file.

What does the first part of attachmentEndpointName: defaultCollectionName represent?

The outbound endpoint name.

What does the second part represent?

The default collection name of the Attachment Object.

What are the two multipart sections you should remember?

data = JSON field information and defaultCollectionName = binary file data.

What is the purpose of hidden widgets in an Attachment Object scenario?

They can be used to populate the Attachment Object's metadata fields.

What does valueOutBinding do in a hidden widget?

It points to the JSON fields on the Attachment Object.

What is the difference between valueOutBinding in a hidden widget and in fileUploader?

The hidden widget's binding points to object fields/metadata, while fileUploader's binding points to the file binary multipart part.

What type of relationship can exist between two Model Business Objects?

A one-way relationship can exist between them.

What is the problem with adding a single Attachment Object field to a Business Object when multiple attachments are required?

A single field can reference only one attachment instance at a time.

What happens when a Business Object points to a new attachment through a single-instance field?

The relationship to the previous attachment is broken.

Why is a single Attachment Object field insufficient for multiple attachments?

Because the field can hold only one Attachment Object instance, not a collection of attachments.

How should you model multiple attachments for one Business Object?

Make the Attachment Object the primary object and have it reference the Business Object.

Why should the Attachment Object be the primary object when multiple attachments are needed?

Because many Attachment Object instances can then reference the same Business Object instance without breaking existing relationships.

What is the key advantage of the one-to-many attachment design?

One Business Object can be associated with many independent attachment instances.