---
category: [Administration & Integrations, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions, Platform and Product Extensions/Integration]
keyword: [Integrate, Workday Integration, Orchestrate for Integrations, Orchestration, Orchestration Builder]
nav: wcp_docs
parent_url: /wcp_docs/
title: >- 
  Reference: Send Workday API Request
layout: subsection
---

## Purpose

Use this component to make requests to Workday APIs.

## <a id="d371e112"></a>Template Availability

This component is available in these orchestration templates:

-   Synchronous
-   Asynchronous
-   Business Process
-   Home Card
-   Integration System
-   Custom Agent Action


## Properties

Provide a meaningful <b>Reference Name</b> for the step as it will appear in your orchestration.

Select a method alongside the prepopulated Workday API address. The component supports these methods:

-   DELETE
-   GET
-   OPTIONS
-   PATCH
-   POST
-   PUT
-   HEAD


<b>The Auth Tab</b>

Use this tab to specify the type of authentication your request uses. You can create authentication types on the <b>Credentials</b> tab in your orchestration's <b>Settings</b>. Types you create there are available from the drop-down menu here.

<b>The Body Tab</b>

Use this tab to specify the data sent along with each request. There are 3 ways to specify data:

-   <b>Reference Existing Data</b>: In the <b>Select Data</b> field, use Expression Builder to specify the data. Use the <b>Content Type</b> drop-down menu to specify the data's type.
-   <b>Create Text Template</b>: Use the <b>Content Type</b> drop-down menu to specify the data's type. Compose the <b>Message</b>.
-   <b>Form Multipart Body</b>: In a multipart body, add as many parts as are required and configure each individually. Parts are indexed, beginning at zero. Use Expression Builder to name each one. For each part:

    -   In the <b>Select Data</b> field, use Expression Builder to specify the part's data.
    -   Select the <b>Content Type</b>:

        -   application/json
        -   application/octet-stream
        -   application/x-ww-form-urlencoded
        -   application/xml
        -   text/csv
        -   text/html
        -   text/plain
        -   text/xml

    -   Use Expression Builder to optionally add <b>Content Disposition Parameters</b> and <b>Headers</b>. A Content Disposition Parameter provides information about the field to which the part applies. The part is defined by the boundary set in the `Content-Type` header.



<b>The Headers Tab</b>

Use this tab to add HTTP headers, providing a name and value for each.

<b>The Query Parameters Tab</b>

Use this tab to add URL query parameters in the form of key/value pairs.

Parameters are appended to the end of the URL request following `?` and separated by `&`.

<b>The Settings Tab</b>

Use this tab to configure these request and response details:

-   Overall Timeout: the total time allowed for the operation.
-   Connect Timeout: the time allowed for a client-server connection to establish.
-   Response Timeout: the time allowed for establishing a connection.
-   Response Type: the type of response requested.
-   Retry Settings: select a predefined Retry policy. You can create Retry policies on the HTTP Retries tab of your orchestration's <b>Settings</b>.


Select the <b>Advanced Mode</b> check box to reveal these additional settings:

-   <b>Enable Wait for Long Running Response</b>: Switch this toggle on to have Orchestrate wait up to 1 hour for REST API responses and up to 6 hours for SOAP API responses. Note that when you use this feature in a loop, loop iterations are processed sequentially to ensure stability. This increases overall processing time. Only enable this feature if your use case requires it.
-   <b>Transfer-Encoding Settings</b>: Select the <b>Chunk encoding</b> check box to send the request in multiple segments rather than as a single entity. Ensure that your target API supports this configuration before enabling the setting. Although some APIs actively require chunked transfer encoding, not all APIs support it.


