API docs by Redocly

Workday Strategic Sourcing Projects 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.

null

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

Projects

Use the projects API to create, update, and query the projects in Workday Strategic Sourcing.

Project Object

type
required
string (ProjectType)

Object type, should always be projects.

id
required
integer (ProjectId)

Project identifier string.

object (ProjectAttributes)

Project attributes.

object (ProjectRelationship)

Project relationships.

object (ResourceLinks)

List of related links.

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

List Projects

Returns a list of projects for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (ProjectInputFilter)

Filter projects by multiple criteria. Only one filter per attribute is supported. For best performance, we recommend 5 or less filters.

object (PageInput)

Customize pagination results with size.

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/projects/v1/projects"

Response samples

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

Create a Project

Create a project with given attributes.

Authorizations:
(api_keyuser_tokenuser_email)
Request Body schema: application/vnd.api+json
object (ProjectCreate)

Responses

Request samples

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

Response samples

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

Get a Project

Retrieves the details of an existing project. You need to supply the unique project identifier that was returned upon project creation.

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

Unique Project identifier.

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/projects/v1/projects/1"

Response samples

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

Update a Project

Updates the details of an existing project. You need to supply the unique supplier project that was returned upon project creation.

Please note, that request body must include an id attribute with the value of your project unique identifier (the same one you passed in the URL).

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

Unique Project identifier.

Request Body schema: application/vnd.api+json
object (ProjectUpdate)

Responses

Request samples

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

Response samples

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

Delete a Project

Deletes a project. You need to supply the unique project identifier that was returned upon project creation.

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

Unique Project identifier.

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" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/projects/v1/projects/1"

Get a Project by External ID

Retrieves the details of an existing project. You need to supply the unique project external identifier (the one you used when created the project).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Project external identifier.

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/projects/v1/projects/SUP-1234/external_id"

Response samples

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

Update a Project by External ID

Updates the details of an existing project. You need to supply the unique project external identifier (the one you used when created the project).

Please note, that request body must include an id attribute with the value of your project external identifier (the same one you passed in the URL).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Project external identifier.

Request Body schema: application/vnd.api+json
object (ProjectUpdate)

Responses

Request samples

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

Response samples

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

Delete a Project by External ID

Deletes a project. You need to supply the unique project external identifier (the one you used when created the project).

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: 1234-5678-abcd-efgh

Project external identifier.

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" \
     -X DELETE \
     "https://api.us.workdayspend.com/services/projects/v1/projects/SUP-1234/external_id"

Describe Project object

Returns a list of fields for the project object.

Authorizations:
(api_keyuser_tokenuser_email)

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/projects/v1/projects/describe"

Response samples

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

Project Types

Use the project types API to query the project types in Workday Strategic Sourcing.

Project Types are used in the project resource. On POST and PATCH related endpoints for this resource a project_type_id can be added to set the project type. The project_type_id is a foreign key for the project_types resource's id.

Project Type Object

type
required
string (ProjectTypeType)

Object type, should always be project_types.

id
required
integer (ProjectTypeId)

Project type identifier string.

object (ProjectTypeAttributes)

Project type attributes.

object (ResourceLinks)

List of related links.

{
  • "type": "project_types",
  • "id": 1,
  • "attributes": {
    },
  • "links": {
    }
}

List Project Types

Returns a list of all project types.

Authorizations:
(api_keyuser_tokenuser_email)

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/projects/v1/project_types"

Response samples

Content type
application/vnd.api+json
{}

Get a Project Type

Retrieves the details of an existing project type.

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

Unique project type identifier.

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/projects/v1/project_types/1"

Response samples

Content type
application/vnd.api+json
{}

Project Supplier Companies

Use the project supplier companies API to manage project suppliers.

Add Suppliers

Add suppliers to a project.

For best performance, we recommend inviting 10 or less suppliers in a single request.

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

Project identifier.

Request Body schema: application/vnd.api+json
Array of objects (SupplierCompany)

Responses

Request samples

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

Remove Suppliers

Remove suppliers from a project.

For best performance, we recommend removing 10 or less suppliers in a single request.

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

Project identifier.

Request Body schema: application/vnd.api+json
object (SupplierCompany)

Responses

Request samples

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

Add Suppliers using External IDs

Add suppliers to a project.

You must supply the unique project external identifier (the one you used when created the project).

You must supply the external identifiers of the supplier companies too.

For best performance, we recommend inviting 10 or less suppliers in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
project_external_id
required
string
Example: PRJ1

Project external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierCompany)

Responses

Request samples

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

Remove Suppliers using External IDs

Remove suppliers from a project.

You must supply the unique project external identifier (the one you used when created the project).

You must supply the external identifiers of the supplier companies too.

For best performance, we recommend removing 10 or less suppliers in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
project_external_id
required
string
Example: PRJ1

Project external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierCompany)

Responses

Request samples

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

Project Supplier Contacts

Use the project supplier contacts API to manage project suppliers. This API provides 2 advantages over the project supplier companies APIs:

  • It allows specifying the supplier contact to be associated/removed from a project.
  • It allows specifying multiple contacts for a given supplier.

Add Suppliers using Contacts

Add suppliers to a project using supplier contacts.

For best performance, we recommend inviting 10 or less supplier contacts in a single request.

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

Project identifier.

Request Body schema: application/vnd.api+json
Array of objects (SupplierContact)

Responses

Request samples

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

Remove Suppliers using Contacts

Remove suppliers from a project using supplier contacts.

For best performance, we recommend removing 10 or less supplier contacts in a single request.

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

Project identifier.

Request Body schema: application/vnd.api+json
Array of objects (SupplierContact)

Responses

Request samples

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

Add Suppliers using Contacts External IDs

Add suppliers to a project using supplier contacts.

You must supply the unique project external identifier (the one you used when created the project).

You must supply the external identifiers of the supplier contacts too.

For best performance, we recommend inviting 10 or less supplier contacts in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
project_external_id
required
string
Example: PRJ1

Project external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierContact)

Responses

Request samples

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

Remove Suppliers using Contacts External IDs

Remove suppliers from a project using supplier contacts.

You must supply the unique project external identifier (the one you used when created the project).

You must supply the external identifiers of the supplier contacts too.

For best performance, we recommend removing 10 or less supplier contacts in a single request.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
project_external_id
required
string
Example: PRJ1

Project external identifier.

Request Body schema: application/vnd.api+json
Array of objects (ExternalSupplierContact)

Responses

Request samples

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