API Version 3.0 is deprecated. Please migrate to our new API services by April 18, 2025.

API docs by Redocly

Workday Strategic Sourcing API (Deprecated) (3.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).

Servers

US Region

Environment US region Base URI Base URI deprecated. Available until April, 2025
Production https://api.us.workdayspend.com/v3 https://api.scoutrfp.com/v3
Sandbox https://api.sandbox.us.workdayspend.com/v3 https://api.sandbox.scoutrfp.com/v3

EU Region

Environment EU region Base URI
Production https://api.eu.workdayspend.com/v3
Sandbox https://api.sandbox.eu.workdayspend.com/v3

CA Region

Environment CA region Base URI
Production https://api.ca.workdayspend.com/v3
Sandbox https://api.sandbox.ca.workdayspend.com/v3

API Specification

The API conforms to the JSON API Specification.

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

Supplier Companies

Use the supplier companies API to create, update, and query the suppliers in Workday Strategic Sourcing.

Supplier Company Object

type
required
string (SupplierCompanyType)

Object type, should always be supplier_companies.

id
required
integer (SupplierCompanyId)

Supplier company identifier string.

object (SupplierCompanyAttributes)

Supplier company attributes.

object (SupplierCompanyRelationship)

Supplier company relationships.

object (ResourceLinks)

List of related links.

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

Supplier Classification Value Object

type
required
string (SupplierClassificationValueType)

Object type, should always be supplier_classification_values.

id
required
string (SupplierClassificationValueId)

A composite identifier for a virtual object created from the id of the supplier and the id of the classification in the response. Id or the external Id of a classification in the request.

object (SupplierClassificationValueAttributes)

SupplierClassificationValue attributes.

object (SupplierClassificationValueRelationship)

Supplier classification value relationships.

{
  • "id": "1-21",
  • "type": "supplier_classification_values",
  • "attributes": {
    },
  • "relationships": {
    }
}

Supplier Classification Field Value Object

type
required
string (SupplierClassificationFieldValueType)

Object type, should always be supplier_classification_field_values.

id
required
integer (SupplierClassificationFieldValueId)

Supplier classification field value identifier string.

object (SupplierClassificationFieldValueAttributes)

SupplierClassificationFieldValue attributes.

object (SupplierClassificationFieldValueRelationship)

Supplier classification relationships.

{
  • "id": "1",
  • "type": "supplier_classification_field_values",
  • "attributes": {
    },
  • "relationships": {
    }
}

List Supplier Companies

Returns a list of supplier companies for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
segmentation_status
string (SupplierSegmentationStatus)
Deprecated
Enum: "not_approved" "reviewing" "approved" "out_of_compliance" "blacklisted"

Filter suppliers by segmentation status.

object (SupplierCompanyInputFilter)

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

include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_companies?include=payment_types,default_payment_type

In the response, relationships will be represented as normal linkage objects (containing id and type), and full related resource details will be presented in the included section as resource objects (with attributes, links, and potentially relationships).

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.scoutrfp.com/v3/supplier_companies?segmentation_status=approved"

Response samples

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

Create a Supplier Company

Create a supplier company with given attributes, relationships, and related complex resources.

When creating a supplier company with relationships, keep in mind that there are two kinds of relationships: linked resources and composite resources.

Linked Resources

These are normal relationship resources managed outside of primary resource (supplier company). For example, payment currencies exist on their own, and can be assigned to one or many supplier companies, contracts, etc. These resources usually have their own API management endpoints.

All related objects should exist prior to being linked to the supplier company. They can be referenced by Workday Strategic Sourcing identifier, or by external ID; in the latter case, the relationship name is used with prefix external_. For example, a payment currency with Workday Strategic Sourcing ID "1" and external ID "C$EUR" can be used to initialize default_payment_currency:

{
  "default_payment_currency": {
    "data" {
      "id": "1",
      "type": "payment_currencies"
    }
  }
}

{
  "external_default_payment_currency": {
    "data" {
      "id": "C$EUR",
      "type": "payment_currencies"
    }
  }
}

When external_ prefix is applied to a "many" relationship, like external_payment_currencies, all of the identifiers will be treated as external IDs.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

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

Responses

Request samples

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

Response samples

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

Get a Supplier Company

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

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

Unique Supplier Company identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

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.scoutrfp.com/v3/supplier_companies/1"

Response samples

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

Update a Supplier Company

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

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

Linked Resources

When updating relationships on a supplier company resource, keep in mind the whole relationship will be replaced the new values. For example, if a supplier company has currencies with IDs "1" and "2", and in update request payload payment_currencies relationship is specified with ID "3", the only payment currency associated after the request succeeded will be "3".

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

Unique Supplier Company identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

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

Responses

Request samples

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

Response samples

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

Delete a Supplier Company

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

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

Unique Supplier Company 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.scoutrfp.com/v3/supplier_companies/1"

Get a Supplier Company by External ID

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

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

Supplier company external identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

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.scoutrfp.com/v3/supplier_companies/SUP-1234/external_id"

Response samples

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

Update a Supplier Company by External ID

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

Please note, that request body must include an id attribute with the value of your supplier 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

Supplier company external identifier.

query Parameters
include
string (SupplierCompanyRelatedResources)
Enum: "attachments" "supplier_category" "supplier_groups" "default_payment_term" "payment_types" "default_payment_type" "payment_currencies" "default_payment_currency" "supplier_classification_values"

Use the include parameter to request related resources along with the primary resource. (see "List Supplier Companies" for more details).

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

Responses

Request samples

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

Response samples

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

Delete a Supplier Company by External ID

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

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

Supplier company 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.scoutrfp.com/v3/supplier_companies/SUP-1234/external_id"

Describe Supplier Company object

Returns a list of fields for the supplier company 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.scoutrfp.com/v3/supplier_companies/describe"

Response samples

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

Supplier Contacts

Supplier Contact Object

type
required
string (SupplierContactType)

Object type, should always be supplier_contacts.

id
required
integer (SupplierContactId)

Supplier contact identifier string.

object (SupplierContactAttributes)

Supplier contact attributes.

object (SupplierContactRelationshipCreate)

Supplier contact relationships.

object (ResourceLinks)

List of related links.

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

List Supplier Contacts

Retrieves the list of contacts for an existing supplier company.

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

Unique supplier company identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_contacts?include=supplier_company

In the response, relationships will be represented as normal linkage objects (containing id and type), and related resource details will be presented in the included section as resource objects (with attributes that have a corresponding external_id).

object (SupplierContactInputFilter)

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

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.scoutrfp.com/v3/supplier_companies/1/supplier_contacts"

Response samples

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

Create a Supplier Contact

Create a supplier contact with given attributes.

Linked Resources

The supplier company should exist prior to being linked to the supplier contact. It can be referenced by Workday Strategic Sourcing identifier, or by external ID; in the latter case, the relationship name is used with prefix external_. For example, a supplier company with Workday Strategic Sourcing ID "1" and external ID "SCM-1" can be used to initialize supplier_company:

{
  "supplier_company": {
    "data" {
      "id": "1",
      "type": "supplier_companies"
    }
  }
}

{
  "external_supplier_company": {
    "data" {
      "id": "SCM-1",
      "type": "supplier_companies"
    }
  }
}
Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

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

Responses

Request samples

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

Response samples

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

Get a Supplier Contact

Retrieves the details of an existing supplier contact.

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

Unique supplier contact identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

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.scoutrfp.com/v3/supplier_contacts/1"

Response samples

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

Update a Supplier Contact

Updates the details of an existing supplier contact. You need to supply the unique supplier company and contact identifiers.

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

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

Unique supplier contact identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

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

Responses

Request samples

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

Response samples

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

Delete a Supplier Contact

Deletes a supplier contact.

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

Unique supplier contact 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.scoutrfp.com/v3/supplier_contacts/1/external_id"

List Supplier Contacts by Supplier Company External ID

Retrieves the list of contacts for an existing supplier company by Supplier Company External ID.

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

Supplier company external identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_contacts?include=supplier_company

In the response, relationships will be represented as normal linkage objects (containing id and type), and related resource details will be presented in the included section as resource objects (with attributes that have a corresponding external_id).

object (SupplierContactInputFilter)

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

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.scoutrfp.com/v3/supplier_companies/1234-5678-abcd-efgh/supplier_contacts/external_id"

Response samples

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

Get a Supplier Contact by External ID

Retrieves the details of an existing supplier contact by Supplier Contact External ID.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CNT-17

Unique supplier contact identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

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.scoutrfp.com/v3/supplier_contacts/CNT-17/external_id"

Response samples

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

Update a Supplier Contact by External ID

Updates the details of an existing supplier contact by Supplir Contact External ID.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CNT-17

Unique supplier contact external identifier.

query Parameters
include
string (SupplierContactRelatedResources)
Enum: "supplier_company" "contact_types" "phones"

Use the include parameter to request a primary resource supplier company.

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

Responses

Request samples

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

Response samples

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

Delete a Supplier Contact by External ID

Deletes a supplier contact by Supplier Contact External ID.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CNT-17

Unique supplier contact 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.scoutrfp.com/v3/supplier_contacts/CNT-17/external_id"

Create Supplier Contact by Supplier Company External ID

Create a supplier contact with given attributes by Supplier Company External ID.

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

Responses

Request samples

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

Response samples

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

Supplier Classifications

Supplier Classification Object

type
required
string (SupplierClassificationType)

Object type, should always be supplier_classifications.

id
required
integer (SupplierClassificationId)

Supplier classification identifier string.

object (SupplierClassificationAttributes)

SupplierClassification attributes.

object (SupplierClassificationRelationship)

Supplier classification relationships.

{
  • "data": {
    }
}

List Supplier Classifications

Returns a list of supplier classifications.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/supplier_classifications?include=supplier_classification_fields

In the response, relationships will be represented as normal linkage objects (containing id and type), and related resource details will be presented in the included section as resource objects (with attributes that have a corresponding external_id).

object (SupplierClassificationInputFilter)

Filter supplier classifications by codename.

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.scoutrfp.com/v3/supplier_classifications"

Response samples

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

Create a Supplier Classification

Create a supplier classifications with given attributes, relationships, and related complex resources.

{
  "data": {
    "type": "supplier_classifications",
    "attributes": {
      "name": "Classification 1",
      "order": 1,
      "country_alpha2": "CA",
      "codename": "diversity",
      "active": true,
      "external_id": "CLASSIFICATION-1",
      "request_additional_information": false
    }
  }
}

Composite Resources

Resources that do not exist outside of parent resource, and are managed within the scope of parent resource, cannot be pre-created in advance. Supplier classifications have one composite resource supplier_classification_fields that includes another composite resource in itself - supplier_classification_field_options.

In order to create these resource along with the parent object, compound document must be used:

{
  "data": {
    "type": "supplier_classifications",
    "attributes": {
      "name": "Classification 1",
      "order": 1,
      "country_alpha2": "CA",
      "codename": "diversity",
      "active": true,
      "external_id": "CLASSIFICATION-1",
      "request_additional_information": true
    },
    "relationships": {
      "supplier_classification_fields": {
        "data": [
          {
            "id": "CLASSIFICATION-FIELD-1",
            "type": "supplier_classification_fields"
          },
        ]
      }
    },
    "included": [
      {
        "id": "CLASSIFICATION-FIELD-1",
        "type": "supplier_classification_fields",
        "attributes": {
          "name": "Field 1",
          "order": 1,
          "required": false,
          "kind": "SELECT",
          "external_id": "CLASSIFICATION-FIELD-1"
        },
        "relationships": {
          "supplier_classification_field_options": {
            "data": [
              {
                "id": "CLASSIFICATION-FIELD-OPTION-1",
                "type": "supplier_classification_field_options"
              },
              {
                "id": "CLASSIFICATION-FIELD-OPTION-2",
                "type": "supplier_classification_field_options"
              }
            ]
          }
        }
      },
      {
        "id": "CLASSIFICATION-FIELD-OPTION-1",
        "type": "supplier_classification_field_options",
        "attributes": {
          "label": "Option 1",
          "order": 1,
          "external_id": "CLASSIFICATION-FIELD-OPTION-1"
        }
      },
      {
        "id": "CLASSIFICATION-FIELD-OPTION-2",
        "type": "supplier_classification_field_options",
        "attributes": {
          "label": "Option 2",
          "order": 2,
          "external_id": "CLASSIFICATION-FIELD-OPTION-2"
        }
      }
    ]
  }
}
Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

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

Request Body schema: application/vnd.api+json
object (SupplierClassification)
Array of SupplierClassificationField (object) or SupplierClassificationFieldOption (object) (SupplierClassificationIncludedMutationResources)

Responses

Request samples

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

Response samples

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

Get a Supplier Classification

Retrieves the details of an existing supplier classification.

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

Unique supplier classification identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources.

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.scoutrfp.com/v3/supplier_classifications/1"

Response samples

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

Update a Supplier Classification

Update a supplier classification with given attributes, relationships, and related complex resources.

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

Unique Supplier Classification identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

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

Request Body schema: application/vnd.api+json
object (SupplierClassification)
included
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Responses

Request samples

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

Response samples

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

Delete a Supplier Classification

Deletes a supplier classification.

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

Unique supplier classification 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.scoutrfp.com/v3/supplier_classifications/1"

Get a Supplier Classification by External ID

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CL-1

Supplier classification external identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Use the include parameter to request related resources.

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.scoutrfp.com/v3/supplier_classifications/CL-1/external_id"

Response samples

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

Update a Supplier Classification by External ID

Update a supplier classification with given attributes, relationships, and related complex resources.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CL-1

Supplier classification external identifier.

query Parameters
include
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

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

Request Body schema: application/vnd.api+json
object (SupplierClassification)
included
string (SupplierClassificationRelatedResources)
Value: "supplier_classification_fields"

Responses

Request samples

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

Response samples

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

Delete a Supplier Classification by External ID

Deletes a supplier classification.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CL-1

Supplier classification 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.scoutrfp.com/v3/supplier_classifications/CL-1/external_id"

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.scoutrfp.com/v3/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
{
  • "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.scoutrfp.com/v3/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.scoutrfp.com/v3/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.scoutrfp.com/v3/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.scoutrfp.com/v3/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.scoutrfp.com/v3/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.scoutrfp.com/v3/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.scoutrfp.com/v3/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": [
    ]
}

Contracts

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

Contract Object

type
required
string (ContractTypeValue)

Object type, should always be contracts.

id
required
integer (ContractId)

Contract identifier string.

object

Contract attributes.

object (ContractRelationship)

Contract relationship.

object (ResourceLinks)

List of related links.

{
  • "data": {
    }
}

Docusign Envelope Object

type
required
string (DocusignEnvelopeType)

Object type, should always be docusign_envelopes.

id
required
integer (DocusignEnvelopeId)

Docusign envelope identifier string.

object (DocusignEnvelopeAttributes)

Docusign envelope attributes

object (Docusign envelope relationships)
{
  • "type": "docusign_envelopes",
  • "id": 1,
  • "attributes": {
    },
  • "relationships": {
    }
}

Adobe Sign Agreement Object

type
required
string (AdobeSignAgreementType)

Object type, should always be adobe_sign_agreements

id
required
integer (AdobeSignAgreementId)

Adobe Sign Agreement identifier string

object (AdobeSignAgreementAttributes)

Adobe Sign Agreement attributes

object (Adobe Sign Agreement relationships)
{
  • "type": "adobe_sign_agreements",
  • "id": 1,
  • "attributes": {
    },
  • "relationships": {
    }
}

Adobe Sign Document Object

type
required
string (AdobeSignDocumentType)

Object type, should always be adobe_sign_documents

id
required
integer (AdobeSignDocumentId)

Adobe Sign Document identifier string

object (AdobeSignDocumentAttributes)

Adobe Sign Document attributes

object (Adobe Sign Document relationships)
{
  • "type": "adobe_sign_documents",
  • "id": 1,
  • "attributes": {
    },
  • "relationships": {
    }
}

List Contracts

Returns a list of contracts for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (ContractInputFilter)

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

include
string (ContractRelatedResources)
Enum: "attachments" "contract_type" "supplier_company" "docusign_envelopes" "adobe_sign_agreements"

To reduce the number of HTTP requests, related resources can be requested along with the requested primary resources. Such responses are called "compound documents". In a compound document, all included resources will be represented as an array of resource objects in a top-level included member.

The value of the include parameter must be a comma-separated list of relationships from the list of available relationships.

/contracts?include=contract_type,supplier_company

In the response, relationships will be represented as normal linkage objects (containing id and type), and full related resource details will be presented in the included section as resource objects (with attributes, links, and potentially relationships).

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.scoutrfp.com/v3/contracts"

Response samples

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

Create a Contract

Create a contract with given attributes.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
include
string (ContractRelatedResources)
Enum: "attachments" "contract_type" "supplier_company" "docusign_envelopes" "adobe_sign_agreements"

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

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

Responses

Request samples

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

Response samples

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

Get a Contract

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

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

Unique Contract identifier.

query Parameters
include
string (ContractRelatedResources)
Enum: "attachments" "contract_type" "supplier_company" "docusign_envelopes" "adobe_sign_agreements"

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.scoutrfp.com/v3/contracts/1"

Response samples

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

Update a Contract

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

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

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

Unique Contract identifier.

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

Responses

Request samples

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

Response samples

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

Delete a Contract

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

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

Unique Contract 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.scoutrfp.com/v3/contracts/1"

Get a Contract by External ID

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

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

Contract external identifier.

query Parameters
include
string (ContractRelatedResources)
Enum: "attachments" "contract_type" "supplier_company" "docusign_envelopes" "adobe_sign_agreements"

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.scoutrfp.com/v3/contracts/SUP-1234/external_id"

Response samples

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

Update a Contract by External ID

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

Please note, that request body must include an id attribute with the value of your contract 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

Contract external identifier.

query Parameters
include
string (ContractRelatedResources)
Enum: "attachments" "contract_type" "supplier_company" "docusign_envelopes" "adobe_sign_agreements"

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

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

Responses

Request samples

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

Response samples

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

Delete a Contract by External ID

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

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

Contract 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.scoutrfp.com/v3/contracts/SUP-1234/external_id"

Describe Contract object

Returns a list of fields for the contract 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.scoutrfp.com/v3/contracts/describe"

Response samples

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

Contract Types

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

Contract Types are used in the contract resource. On POST and PATCH related endpoints for this resource a contract_type_id can be added to set the contract type. The contract_type_id is a foreign key for the contract_types resource's id.

Contract Type Object

type
required
string (ContractTypeType)

Object type, should always be contract_types.

id
required
integer (ContractTypeId)

Contract type identifier string.

object (ContractTypeAttributes)

Contract type attributes.

{
  • "type": "contract_types",
  • "id": 1,
  • "attributes": {
    }
}

List Contract Types

Returns a list of all contract 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.scoutrfp.com/v3/contract_types"

Response samples

Content type
application/vnd.api+json
{}

Create a Contract Type

Create a contract type with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Get a Contract Type

Retrieves the details of an existing contract type.

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

Unique contract 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.scoutrfp.com/v3/contract_types/1"

Response samples

Content type
application/vnd.api+json
{}

Update a Contract Type

Updates the details of an existing contract type. You need to supply the unique identifier that was returned upon contract type creation.

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

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

Unique contract type identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Contract Type

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

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

Unique contract 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" \
     -X DELETE \
     "https://api.scoutrfp.com/v3/contract_types/1"

Get a Contract Type by External ID

Retrieves the details of an existing contract type.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTR$1

Unique contract type 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.scoutrfp.com/v3/contract_types/CTR$1/external_id"

Response samples

Content type
application/vnd.api+json
{}

Update a Contract Type by External ID

Updates the details of an existing contract type. You need to supply the unique external identifier assigned to the contract type on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTR$1

Unique contract type external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Contract Type by External ID

Deletes a contract type. You need to supply the unique contract type external identifier assigned to the contract type on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTR$1

Unique contract type 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.scoutrfp.com/v3/contract_types/CTR$1/external_id"

Events

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

Event Object

type
required
string (EventType)

Object type, should always be events.

id
required
integer (EventId)

Event identifier string.

object (EventAttributes)

Event attributes.

object (EventRelationship)

Event relationships.

object (ResourceLinks)

List of related links.

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

List Events

Returns a list of events for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (EventInputFilter)

Filter events 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.scoutrfp.com/v3/events"

Response samples

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

Create an Event

Events can only be created from a template. When a creation request is issued, the base event object will be created from the template and returned with the response. Child records such as attachments, price sheets, custom values, will be scheduled for copy asynchronously. Current duplication status can be retrieved from the duplication_state attribute, which will have one of following values:

  • scheduled - duplication is scheduled, but not yet started;
  • started - duplication started, but not yet finished;
  • finished - duplication completed;
  • failed - there was an error duplicating relationships.

An event should always have an associated project, please make sure to specify it as always relationship object.

Please note, this endpoint does not support auction creation/duplication.

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

Responses

Request samples

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

Response samples

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

Get an Event

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

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

Unique Event 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.scoutrfp.com/v3/events/1"

Response samples

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

Update an Event

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

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

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

Unique Event identifier.

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

Responses

Request samples

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

Response samples

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

Delete an Event

Deletes an event. You need to supply the unique event identifier that was returned upon event creation.

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

Unique Event 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.scoutrfp.com/v3/events/1"

Describe Event Object

Returns the list of fields for the event 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.scoutrfp.com/v3/events/describe"

Response samples

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

Event Supplier Companies

Use the event supplier companies API to manage event suppliers.

Add Event Suppliers

Add suppliers to an event. Only events of type RFP are supported.

The operation will be rolled back upon any failure, and invitations won't be sent.

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

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

Event identifier.

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

Responses

Request samples

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

Remove Event Suppliers

Remove suppliers from an event. Only events of type RFP are supported.

The operation will be rolled back upon any failure, and invitations won't be removed.

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

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

Event identifier.

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

Responses

Request samples

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

Add Event Suppliers using External IDs

Add suppliers to an event. Only events of type RFP are supported.

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

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

The operation will be rolled back upon any failure, and invitations won't be sent.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
string
Example: EVENT1

Event external identifier.

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

Responses

Request samples

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

Remove Event Suppliers using External IDs

Remove suppliers from an event. Only events of type RFP are supported.

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

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

The operation will be rolled back upon any failure, and invitations won't be removed.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
string
Example: EVENT1

Event external identifier.

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

Responses

Request samples

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

Event Supplier Contacts

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

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

Add Event Suppliers using Contacts

Add suppliers to an event using supplier contacts. Only events of type RFP are supported.

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

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

Event identifier.

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

Responses

Request samples

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

Remove Event Suppliers using Contacts

Remove suppliers from an event using supplier contacts. Only events of type RFP are supported.

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

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

Event identifier.

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

Responses

Request samples

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

Add Event Suppliers using Contacts External IDs

Add suppliers to an event using supplier contacts. Only events of type RFP are supported.

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

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

The operation will be rolled back upon any failure, and invitations won't be sent.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
event_external_id
required
string
Example: EVENT1

Event external identifier.

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

Responses

Request samples

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

Remove Event Suppliers using Contacts External IDs

Remove suppliers from an event using supplier contacts. Only events of type RFP are supported.

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

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

The operation will be rolled back upon any failure, and invitations won't be removed.

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

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

Event external identifier.

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

Responses

Request samples

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

Event Templates

Use the contract types API to query the event templates in Workday Strategic Sourcing.

Event Templates are used as a blueprint for newly created events.

Event Template Object

type
required
string (EventTemplateType)

Object type, should always be event_templates.

id
required
integer (EventTemplateId)

Event template identifier string.

object (EventTemplateAttributes)

Event template attributes.

object (ResourceLinks)

List of related links.

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

List Event Templates

Returns a list of all event templates.

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.scoutrfp.com/v3/event_templates"

Response samples

Content type
application/vnd.api+json
{}

Get an Event Template

Retrieves the details of an existing event template.

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

Unique event template 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.scoutrfp.com/v3/event_templates/1"

Response samples

Content type
application/vnd.api+json
{}

Worksheets

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

Worksheet Object

type
required
string (WorksheetType)

Object type, should always be worksheets.

id
required
integer (WorksheetId)

Worksheet identifier string.

object (WorksheetAttributes)

Worksheet attributes.

object (ResourceLinks)

List of related links.

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

List Worksheets

Returns a list of all worksheets.

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

Event 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.scoutrfp.com/v3/events/1/worksheets"

Response samples

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

Get a Worksheet

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

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

Event identifier.

id
required
integer
Example: 1

Unique Worksheet 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.scoutrfp.com/v3/events/1/worksheets/1"

Response samples

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

Describe Worksheet object

Returns a list of fields for the worksheet 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.scoutrfp.com/v3/worksheets/describe"

Response samples

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

Line Items

Use the line items API to create, update, and query the worksheet line items in Workday Strategic Sourcing.

Line Item Object

type
required
string (LineItemType)

Object type, should always be line_items.

id
required
integer (LineItemId)

LineItem identifier string.

object (LineItemAttributes)

LineItem attributes.

{
  • "type": "line_items",
  • "id": 1,
  • "attributes": {
    }
}

List Line Items

Returns a list of line items for the specified criteria.

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

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet 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.scoutrfp.com/v3/events/1/worksheets/1/line_items"

Response samples

Content type
application/vnd.api+json
{}

Create a Line Item

Create a line item with given cell values.

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

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

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

Responses

Request samples

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

Response samples

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

Bulk Create Line Items

Create multiple line items in a given worksheet. You can create up to 200 line items in a single request.

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

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

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

Responses

Request samples

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

Response samples

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

Get a Line Item

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

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

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

id
required
integer
Example: 1

Unique line item 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.scoutrfp.com/v3/events/1/worksheets/1/line_items/1"

Response samples

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

Update a Line Item

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

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

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

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

id
required
integer
Example: 1

Unique line item identifier.

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

Responses

Request samples

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

Response samples

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

Delete a Line Item

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

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

Event identifier.

worksheet_id
required
integer
Example: 1

Worksheet identifier.

id
required
integer
Example: 1

Unique line item 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.scoutrfp.com/v3/events/1/worksheets/1/line_items/1"

Bids

Use the bids API to query the bids in Workday Strategic Sourcing. Only bids for events of type RFP are supported.

Bid Object

type
required
string (BidType)

Object type, should always be bids.

id
required
integer (BidId)

Bid identifier string.

object (BidAttributes)

Bid attributes.

object (BidRelationship)

Bid relationships.

object (ResourceLinks)

List of related links.

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

List Bids

Returns a list of all bids. Only bids for events of type RFP are returned.

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

Event identifier.

query Parameters
object (BidInputFilter)

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

include
string (BidRelatedResources)
Enum: "event" "supplier_company"

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

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.scoutrfp.com/v3/events/1/bids"

Response samples

Content type
application/vnd.api+json
Example
{}

Get a Bid

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

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

Unique Bid identifier.

query Parameters
include
string (BidRelatedResources)
Enum: "event" "supplier_company"

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.scoutrfp.com/v3/bids/1"

Response samples

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

Describe Bid object

Returns a list of fields for the bid 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.scoutrfp.com/v3/bids/describe"

Response samples

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

Bid Line Items

Use the bid line items API to query the bid line items in Workday Strategic Sourcing.

Bid Line Item Object

type
required
string (BidLineItemType)

Object type, should always be bid_line_items.

id
required
integer (BidLineItemId)

BidLineItem identifier string.

object (BidLineItemAttributes)

BidLineItem attributes.

object (BidLineItemRelationship)

Bid line item relationship.

{
  • "id": "1",
  • "type": "bid_line_items",
  • "attributes": {
    },
  • "relationships": {
    }
}

List Bid Line Items

Returns a list of line items for a specific bid.

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

Bid 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.scoutrfp.com/v3/bids/1/bid_line_items"

Response samples

Content type
application/vnd.api+json
{}

Get a Bid Line Item

Retrieves the details of an existing bid line item.

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

Unique bid line item 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.scoutrfp.com/v3/bid_line_items/1"

Response samples

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

List All Bid Line Items

Returns a list of all bid line items.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (BidLineItemInputFilter)

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

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.scoutrfp.com/v3/bid_line_items"

Response samples

Content type
application/vnd.api+json
{}

Describe Bid Line Item Object

Returns a list of fields for bid line item 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.scoutrfp.com/v3/bid_line_items/describe"

Response samples

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

Contact Types

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

ContactType Object

type
required
string (ContactTypeType)

Object type, should always be contact_types.

id
required
integer (ContactTypeId)

Contact type identifier string.

object (ContactTypeAttributes)

Contact type attributes.

{
  • "type": "contact_types",
  • "id": 1,
  • "attributes": {
    }
}

List Contact Types

Returns a list of contact 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.scoutrfp.com/v3/fields/contact_types"

Response samples

Content type
application/vnd.api+json
{}

Create a Contact Type

Create a contact type with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Update a Contact Type

Updates the details of an existing contact type. You need to supply the unique identifier that was returned upon contact type creation.

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

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

Unique contact type identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Contact Type

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

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

Unique contact 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" \
     -X DELETE \
     "https://api.scoutrfp.com/v3/fields/contact_types/1"

Update a Contact Type by External ID

Updates the details of an existing contact type. You need to supply the unique external identifier assigned to the contact type on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTYPE

Unique contact type external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Contact Type by External ID

Deletes a contact type. You need to supply the unique contact type external identifier assigned to the contact type on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: CTYPE

Unique contact type 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.scoutrfp.com/v3/fields/contact_types/CTYPE/external_id"

Field Groups

Use the fields API to create, update, and query the custom fields groups in Workday Strategic Sourcing. Custom field groups act as a collection of custom fields. Every newly made custom field with requires a custom field group (except for the fields with target_object set to RFP).

Field Group Object

type
required
string (FieldGroupType)

Object type, should always be field_groups.

id
required
integer (FieldGroupId)

Field group identifier string.

object (FieldGroupAttributes)

Field group attributes.

{
  • "type": "field_groups",
  • "id": 1,
  • "attributes": {
    }
}

List Field Groups

Returns a list of field groups.

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.scoutrfp.com/v3/field_groups"

Response samples

Content type
application/vnd.api+json
{}

Create a Field Group

Create a field group with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Get a Field Group

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

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

Unique Field 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.scoutrfp.com/v3/field_groups/1"

Response samples

Content type
application/vnd.api+json
{}

Update a Field Group

Updates the details of an existing field group. You need to supply the unique identifier that was returned upon field group creation.

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

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

Unique Field Group identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Field Group

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

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

Unique Field Group 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.scoutrfp.com/v3/field_groups/1"

Fields

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

Field Object

type
required
string (FieldType)

Object type, should always be fields.

id
required
integer (FieldId)

Field identifier string.

object (FieldAttributes)

Field attributes.

object (FieldRelationship)

Field relationship.

object (ResourceLinks)

List of related links.

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

List Fields

Returns a list of custom fields for the specified criteria.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (FieldInputFilter)

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

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.scoutrfp.com/v3/fields"

Response samples

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

Create a Field

Create a field with given parameters.

For fields with target_object set to RFP, group relationship should be omitted. It is required to specify the relationship for all other target objects.

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

Responses

Request samples

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

Response samples

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

Get a Field

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

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

Unique Field 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.scoutrfp.com/v3/fields/1"

Response samples

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

Update a Field

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

For fields with target_object set to RFP, group relationship should be omitted.

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

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

Unique Field identifier.

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

Responses

Request samples

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

Response samples

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

Delete a Field

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

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

Unique Field 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.scoutrfp.com/v3/fields/1"

Field Options

Use the fields API to create, update, and query the custom fields options in Workday Strategic Sourcing. Custom field options exist for single select and multiple select field types.

Field Option Object

type
required
string (FieldOptionType)

Object type, should always be fields.

id
required
integer (FieldOptionId)

Field identifier string.

object (FieldOptionAttributes)

Field attributes.

{
  • "type": "fields",
  • "id": 1,
  • "attributes": {
    }
}

List Field Options

Returns a list of field options for the specified field.

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

Field 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.scoutrfp.com/v3/fields/1/field_options"

Response samples

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

Create a Field Option

Create a field options with given parameters.

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

Responses

Request samples

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

Response samples

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

Update a Field Option

Update a field options with given parameters.

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

Unique Field Option identifier.

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

Responses

Request samples

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

Response samples

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

Delete a Field Option

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

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

Unique Field Option 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.scoutrfp.com/v3/field_options/1"

Payment Terms

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

Payment Term Object

type
required
string (PaymentTermType)

Object type, should always be payment_terms.

id
required
integer (PaymentTermId)

Payment term identifier string.

object (PaymentTermAttributes)

Payment term attributes.

{
  • "type": "payment_terms",
  • "id": 1,
  • "attributes": {
    }
}

List Payment Terms

Returns a list of payment terms.

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.scoutrfp.com/v3/fields/payment_terms"

Response samples

Content type
application/vnd.api+json
{}

Create a Payment Term

Create a payment term with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Update a Payment Term

Updates the details of an existing payment term. You need to supply the unique identifier that was returned upon payment term creation.

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

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

Unique payment term identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Payment Term

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

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

Unique payment term 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.scoutrfp.com/v3/fields/payment_terms/1"

Update a Payment Term by External ID

Updates the details of an existing payment term. You need to supply the unique external identifier assigned to the payment term on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
integer
Example: PAYTERM

Unique payment term external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Payment Term by External ID

Deletes a payment term. You need to supply the unique payment term external identifier assigned to the payment term on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
integer
Example: PAYTERM

Unique payment term 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.scoutrfp.com/v3/fields/payment_terms/PAYTERM/external_id"

Payment Types

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

Payment Type Object

type
required
string (PaymentTypeType)

Object type, should always be payment_types.

id
required
integer (PaymentTypeId)

Payment type identifier string.

object (PaymentTypeAttributes)

Payment type attributes.

{
  • "type": "payment_types",
  • "id": 1,
  • "attributes": {
    }
}

List Payment Types

Returns a list of payment 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.scoutrfp.com/v3/fields/payment_types"

Response samples

Content type
application/vnd.api+json
{}

Create a Payment Type

Create a payment type with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Update a Payment Type

Updates the details of an existing payment type. You need to supply the unique identifier that was returned upon payment type creation.

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

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

Unique payment type identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Payment Type

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

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

Unique payment 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" \
     -X DELETE \
     "https://api.scoutrfp.com/v3/fields/payment_types/1"

Update a Payment Type by External ID

Updates the details of an existing payment type. You need to supply the unique external identifier assigned to the payment type on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
integer
Example: PAYTYPE

Unique payment type external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Payment Type by External ID

Deletes a payment type. You need to supply the unique payment type external identifier assigned to the payment type on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
integer
Example: PAYTYPE

Unique payment type 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.scoutrfp.com/v3/fields/payment_types/PAYTYPE/external_id"

Supplier Company Segmentations

Use the supplier company segmentations API to create, update, and query the supplier company segmentations in Workday Strategic Sourcing.

Supplier Company Segmentation Object

type
required
string (SupplierCompanySegmentationType)

Object type, should always be supplier_company_segmentations.

id
required
integer (SupplierCompanySegmentationId)

Supplier company segmentation identifier string.

object (SupplierCompanySegmentationCreateAttributes)

Supplier company segmentation attributes.

{
  • "type": "supplier_company_segmentations",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Company Segmentations

Returns a list of supplier company segmentations.

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.scoutrfp.com/v3/fields/supplier_company_segmentations"

Response samples

Content type
application/vnd.api+json
{}

Create a Supplier Company Segmentation

Create a supplier company segmentation with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
Example
{}

Update a Supplier Company Segmentation

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

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

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

Unique supplier company segmentation identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Company Segmentation

Deletes a supplier company segmentation. You need to supply the unique supplier company segmentation identifier that was returned upon supplier company segmentation creation.

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

Unique supplier company segmentation 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.scoutrfp.com/v3/fields/supplier_company_segmentations/1"

Supplier Company Segmentation Statuses

Use the supplier company segmentation statuses API to create, update, and query the supplier company segmentation statuses in Workday Strategic Sourcing.

Supplier Company Segmentation Status Object

type
required
string (SupplierCompanySegmentationStatusType)

Object type, should always be supplier_company_segmentation_statuses.

id
required
integer (SupplierCompanySegmentationStatusId)

Supplier company segmentation status identifier string.

object (SupplierCompanySegmentationStatusCreateAttributes)

Supplier company segmentation status attributes.

{
  • "type": "supplier_company_segmentation_statuses",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Company Segmentation Statuses

Returns a list of supplier company segmentation statuses.

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.scoutrfp.com/v3/fields/supplier_company_segmentation_statuses"

Response samples

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

Create a Supplier Company Segmentation Status

Create a supplier company segmentation status with given parameters.

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

Responses

Request samples

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

Response samples

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

Update a Supplier Company Segmentation Status

Updates the details of an existing supplier company segmentation status. You need to supply the unique identifier that was returned upon supplier company segmentation status creation.

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

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

Unique supplier company segmentation status identifier.

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

Responses

Request samples

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

Response samples

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

Delete a Supplier Company Segmentation Status

Deletes a supplier company segmentation status. You need to supply the unique supplier company segmentation status identifier that was returned upon supplier company segmentation status creation.

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

Unique supplier company segmentation status 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.scoutrfp.com/v3/fields/supplier_company_segmentation_statuses/1"

Supplier Company Risks

Use the supplier company risks API to create, update, and query the supplier company risks in Workday Strategic Sourcing.

Supplier Company Risk Object

type
required
string (SupplierCompanyRiskType)

Object type, should always be supplier_company_risks.

id
required
integer (SupplierCompanyRiskId)

Supplier company risk identifier string.

object (SupplierCompanyRiskCreateAttributes)

Supplier company risk attributes.

{
  • "type": "supplier_company_risks",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Company Risks

Returns a list of supplier company risks.

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.scoutrfp.com/v3/fields/supplier_company_risks"

Response samples

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

Create a Supplier Company Risk

Create a supplier company risk with given parameters.

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

Responses

Request samples

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

Response samples

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

Update a Supplier Company Risk

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

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

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

Unique supplier company risk identifier.

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

Responses

Request samples

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

Response samples

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

Delete a Supplier Company risk

Deletes a supplier company risk. You need to supply the unique supplier company risk identifier that was returned upon supplier company risk creation.

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

Unique supplier company risk 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.scoutrfp.com/v3/fields/supplier_company_risks/1"

Supplier Categories

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

Supplier Category Object

type
required
string (SupplierCategoryType)

Object type, should always be supplier_categories.

id
required
integer (SupplierCategoryId)

Supplier category identifier string.

object (SupplierCategoryAttributes)

Supplier category attributes.

{
  • "type": "supplier_categories",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Categories

Returns a list of supplier categories.

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.scoutrfp.com/v3/fields/supplier_categories"

Response samples

Content type
application/vnd.api+json
{}

Create a Supplier Category

Create a supplier category with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Update a Supplier Category

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

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

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

Unique supplier category identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Category

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

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

Unique supplier category 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.scoutrfp.com/v3/fields/supplier_categories/1"

Update a Supplier Category by External ID

Updates the details of an existing supplier category. You need to supply the unique external identifier assigned to the supplier category on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPCAT

Unique supplier category external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Category by External ID

Deletes a supplier category. You need to supply the unique supplier category external identifier assigned to the supplier category on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPCAT

Unique supplier category 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.scoutrfp.com/v3/fields/supplier_categories/SUPCAT/external_id"

Supplier Groups

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

Supplier Group Object

type
required
string (SupplierGroupType)

Object type, should always be supplier_groups.

id
required
integer (SupplierGroupId)

Supplier group identifier string.

object (SupplierGroupAttributes)

Supplier group attributes.

{
  • "type": "supplier_groups",
  • "id": 1,
  • "attributes": {
    }
}

List Supplier Groups

Returns a list of supplier groups.

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.scoutrfp.com/v3/fields/supplier_groups"

Response samples

Content type
application/vnd.api+json
{}

Create a Supplier Group

Create a supplier group with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Update a Supplier Group

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

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

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

Unique supplier group identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Group

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

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

Unique supplier group 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.scoutrfp.com/v3/fields/supplier_groups/1"

Update a Supplier Group by External ID

Updates the details of an existing supplier group. You need to supply the unique external identifier assigned to the supplier group on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPGROUP

Unique supplier group external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Supplier Group by External ID

Deletes a supplier group. You need to supply the unique supplier group external identifier assigned to the supplier group on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: SUPGROUP

Unique supplier group 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.scoutrfp.com/v3/fields/supplier_groups/SUPGROUP/external_id"

Payment Currencies

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

Payment Currency Object

type
required
string (PaymentCurrencyType)

Object type, should always be payment_currencies.

id
required
integer (PaymentCurrencyId)

Payment currency identifier string.

object (PaymentCurrencyAttributes)

Payment currency attributes.

{
  • "type": "payment_currencies",
  • "id": 1,
  • "attributes": {
    }
}

List Payment Currencies

Returns a list of payment currencies.

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.scoutrfp.com/v3/fields/payment_currencies"

Response samples

Content type
application/vnd.api+json
{}

Create a Payment Currency

Create a payment currency with given parameters.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Update a Payment Currency

Updates the details of an existing payment currency. You need to supply the unique identifier that was returned upon payment currency creation.

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

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

Unique payment currency identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Payment Currency

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

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

Unique payment currency 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.scoutrfp.com/v3/fields/payment_currencies/1"

Update a Payment Currency by External ID

Updates the details of an existing payment currency. You need to supply the unique external identifier assigned to the payment currency on creation.

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

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: PAYCUR

Unique payment currency external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Delete a Payment Currency by External ID

Deletes a payment currency. You need to supply the unique payment currency external identifier assigned to the payment currency on creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: PAYCUR

Unique payment currency 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.scoutrfp.com/v3/fields/payment_currencies/PAYCUR/external_id"

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.scoutrfp.com/v3/awards"

Response samples

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

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.scoutrfp.com/v3/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.scoutrfp.com/v3/award_line_items/1_5"

Response samples

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

Attachments

Use the attachments API to create, update, and delete the attachments in Workday Strategic Sourcing.

Working with Attachments

Creating attachments for Workday Strategic Sourcing objects is a two-step process. First, you need to inform the system about your intention to upload an attachment by issuing a "Create an Attachment" request, consisting of the file name and a link to the object to which you are adding an attachment. The link is represented by a relationship object containing an object ID and its type.

In the response you will receive a link in the upload_url attributes, along with required HTTP headers to send with your file. You will need to upload your file as a binary stream in a PUT request into the specified URL, making sure the required headers are present. Here is how the workflow might look like when triggered from a console:

$ 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 POST \
       -d '
         {
           "data": {
             "type": "attachments",
             "attributes": {
               "title": "My Interesting Document",
               "file_name": "Some Interesting File.pdf"
             },
             "relationships": {
               "contract": {
                 "data": {
                   "id": 1,
                   "type": "contracts"
                 }
               }
             }
           }
         }
       ' \
       "https://api.scoutrfp.com/v3/attachments"

{
    "data": {
        "id": "1",
        "type": "attachments",
        "attributes": {
            "title": "My Interesting Document",
            "file_size": null,
            "upload_url": "https://upload.s3.amazonaws.com/uploads/contract/1/hex/file.pdf?some=very&long=url",
            "upload_headers": [
                {
                    "name": "Content-Type",
                    "value": "application/octet-stream"
                },
                {
                    "name": "x-amz-acl",
                    "value": "private"
                },
                {
                    "name": "x-amz-server-side-encryption",
                    "value": "AES256"
                },
                {
                    "name": "Content-Disposition",
                    "value": "attachment"
                }
            ]
        }
    }
}

$ curl -X PUT \
    --data "@file.pdf" \
    -H "Content-Type: application/octet-stream" \
    -H "x-amz-acl: private" \
    -H "x-amz-server-side-encryption: AES256" \
    -H "Content-Disposition: attachment" \
    https://upload.s3.amazonaws.com/uploads/contract/1/hex/file.pdf?some=very&long=url

The upload URL expires within 15 minutes after issuing. Please note that you will not be able to upload the data file to the attachment object after that. An automated system will purge all partial uploads after a certain period (usually within 30-60 minutes after creation) to prevent orphan records from overflowing the system.

Please Note: The list of headers and their values might change at any time, so when you're implementing an integration with the Workday Strategic Sourcing system, make sure to include all of the HTTP headers returned from the attachments endpoint.

Attachment Object

type
required
string (AttachmentType)

Object type, should always be attachments.

id
required
integer (AttachmentId)

Attachment identifier string.

object (AttachmentAttributes)

Attachment attributes.

{
  • "type": "attachments",
  • "id": 1,
  • "attributes": {
    }
}

List Attachments

Returns a filtered list of attachments based of the filter[id_equals] mandatory param. The result is limited to 50 attachments.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
object (AttachmentInputFilter)

Filter attachments 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.scoutrfp.com/v3/attachments"

Response samples

Content type
application/vnd.api+json
{}

Create an Attachment

Create an attachment for an object. This endpoint represents the first step in the two-step upload workflow, described in the Working with Attachments section.

The only required attribute is file_name, which will be used to generate attachment title (if a custom one is not supplied), and the upload URL. You will also need to specify the object to which you want to add an attachment (see relationships property).

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Get an Attachment

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

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

Unique attachment 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.scoutrfp.com/v3/attachments/1"

Response samples

Content type
application/vnd.api+json
{}

Update an Attachment

Update an attachment for an object. This endpoint represents the first step in the two-step update upload workflow, described in the Working with Attachments section.

New upload_url and upload_headers will be returned when the file_name attribute is passed. In this case, the existing upload_url will be overridden with a new one that doesn’t have the associated file yet, pending completion of the second step in the described upload process.

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

Unique attachment identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Get an Attachment by External ID

Retrieves the details of an existing attachment. You need to supply the unique attachment identifier (external ID) that was set during attachment creation.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: AT1

Unique attachment 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.scoutrfp.com/v3/attachments/AT1/external_id"

Response samples

Content type
application/vnd.api+json
{}

Update an Attachment by External ID

Update an attachment for an object. This endpoint represents the first step in the two-step update upload workflow, described in the Working with Attachments section.

New upload_url and upload_headers will be returned when the file_name attribute is passed. In this case, the existing upload_url will be overridden with a new one that doesn’t have the associated file yet, pending completion of the second step in the described upload process.

Authorizations:
(api_keyuser_tokenuser_email)
path Parameters
external_id
required
string
Example: AT1

Unique attachment external identifier.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{}

Spend Categories

Use the spend categories API to query the spend categories in Workday Strategic Sourcing.

Spend Categories are used in both the project and contract resources. On POST and PATCH related endpoints for those resources a spend_category_id can be added to attach a spend category. The spend_category_id is a foreign key for the spend_categories resource's id.

Spend Category Object

type
string (SpendCategoryType)

Object type, should always be spend_categories.

id
required
integer (SpendCategoryId)

Spend category identifier string.

object (SpendCategoryAttributes)

Spend category attributes.

{
  • "type": "spend_categories",
  • "id": 1,
  • "attributes": {
    }
}

List Spend Categories

Returns a list of spend categories.

Authorizations:
(api_keyuser_tokenuser_email)
query Parameters
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.scoutrfp.com/v3/spend_categories"

Response samples

Content type
application/vnd.api+json
{}

Users

Provided through our SCIM implementation