API docs by Redocly

Workday Strategic Sourcing Awards API (1.0)

Download OpenAPI specification:

Customer Support

We've provided detailed documentation below to guide you. However, if you need additional assistance, here's how you can get the support you need:

  • Community Discussions: Join the conversation on our Workday Community Discussion Boards (found under the "Collaborate" section in community). Connect with other users, share best practices, and get answers to your configuration questions.
  • Expert Configuration Assistance (Professional Services): For tailored, hands-on support with your specific project, our Professional Services team is available.
    • Looking for personalized guidance? Workday Success Plan customers can submit an "Ask" for expert insights on configuration and best practices.
    • Need custom solutions? Consider Expert Assist, our consulting service for detailed changes and project support.
  • Reporting System Issues: If you suspect a problem with the Workday system itself, please connect with our dedicated support team. Your company's Named Support Contact (NSC) can log a Product Support Defect case. We'll review the issue based on its impact and Workday's service level agreement (SLA).

API Specification

The API conforms to the JSON API Specification.

The current version of this service is indicated by the X-Api-Version header.

Sample version header: X-Api-Version: 1.0.

Date and Time Fields

Our API adheres to the ISO 8601 standard when accepting and formatting Date and Time fields. All Date and Time fields returned by this API will be in the UTC timezone.

Date and Time fields sent to this API can be in any timezone, provided they adhere to the ISO 8601 standard.

Authentication

The Workday Strategic Sourcing API uses API keys to authenticate requests. Every request will require all 3 HTTP headers:

HTTP Header Description
X-Api-Key a company-wide API key
X-User-Token a user-specific API token
X-User-Email user email

You can generate all of those from the API tokens section of your Profile page.

Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Rate Limiting

Rate limit windows are per second and are shared by all API Keys for a company.

The rate limit is 5 requests per second.

When request submissions exceed the limits, the limit-exceeding requests return 429 Too Many Requests error responses to the client.

Upon receiving a 429 response, it is recommended to retry the request in compliance with the rate limit. One example would be to add a sleep function for 1 second and retry.

External Identifiers (IDs)

The external_id field exists on many of the Workday Strategic Sourcing resources. This optional and mutable extension is intended to store foreign keys of the corresponding resource from a third party system. These IDs are not considered Sourcing Data and may be logged in external systems. Do not include any sensitive or personal data in IDs.

The purpose of external IDs is to:

  • Prevent duplicate record creation
  • Allow resources in Workday Strategic Sourcing and a third party system to share the same identifier
  • Allow for records to be queried or updated without requiring knowledge of the Workday Strategic Sourcing generated IDs

Pagination

Paginated endpoints may return a subset of the total results for a GET request that returns multiple resources. Endpoints that support pagination will include usage details in the Query Parameters section for the resource.

The paginated results can be configured using the page query parameter to configure the number of returned results. The default pagination size is 10 results and the maximum pagination size is 100 results per request.

Endpoints that support pagination may return "self" and "next" sections within the "links" section that navigate to the current and next pages respectively.

Example Paginated Request

Request Query Parameter Format

/projects?page[size]=25

Response Schema

The paginated response will also include the following schema

object

Result set metadata.

object (PaginationLinks)

List of related links.

{}

Filters

The results can be filtered to a subset of the total set of results using filter query parameters.

Endpoints that support filtering will include usage details in the Query Parameters section for the resource.

Most filters that end in equals support a Query Parameter array format to filter by multiple values.

Example:

?filter[status_equals][]=submitted&filter[status_equals][]=resubmitted

Awards

Use the Awards API to query the Awards in Workday Strategic Sourcing.

Awards are used for procurement.

Award Object

type
required
string (AwardType)

Object type, should always be awards.

id
required
integer (AwardId)

Award identifier string.

object (AwardAttributes)

Award attributes.

object (AwardRelationship)

Award relationships.

object (ResourceLinks)

List of related links.

{
  • "type": "awards",
  • "id": 1,
  • "attributes": {
    },
  • "relationships": {
    },
  • "links": {
    }
}

List Awards

Returns a list of awards.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (AwardInputFilter)

Filter awards by multiple criteria.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/awards/v1/awards"

Response samples

Content type
application/vnd.api+json
{}

Award Line Items

Use the Award Line Items API to query the Award Line Items in Workday Strategic Sourcing.

Award Line Items are used for procurement.

Award Line Item Object

type
required
string (AwardLineItemType)

Object type, should always be award_line_items.

id
required
integer (AwardLineItemId)

Award line items identifier string.

object (AwardLineItemAttributes)

Award line item attributes.

object (AwardLineItemRelationship)

Award line item relationships.

{
  • "type": "award_line_items",
  • "id": "1_5",
  • "attributes": {
    },
  • "relationships": {
    }
}

List Award Line Items

Returns a list of line items for a specific award.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
award_id
required
integer
Example: 1

Award identifier.

query Parameters
object (AwardLineItemInputFilter)

Filter awards line items by multiple criteria.

include
string (AwardLineItemRelatedResources)
Enum: "supplier_company" "worksheet"

Use the include parameter to request related resources along with the primary resource.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/awards/v1/awards/1/award_line_items"

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get an Award Line Item

Retrieves the details of an existing award line items. You need to supply the unique award line items identifier.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
id
required
string
Example: 15

Unique Award Line Items identifier.

query Parameters
include
string (AwardLineItemRelatedResources)
Enum: "supplier_company" "worksheet"

Use the include parameter to request related resources along with the primary resource.

Responses

Request samples 

curl -H "X-Api-Key: ${COMPANY_KEY}" \
     -H "X-User-Token: ${USER_TOKEN}" \
     -H "X-User-Email: ${USER_EMAIL}" \
     -H "Content-Type: application/vnd.api+json" \
     "https://api.us.workdayspend.com/services/awards/v1/award_line_items/1_5"

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}