Scout RFP

Scout RFP Line Items API

The Line Items API from Scout RFP — 3 operation(s) for line items.

GitHub OpenAPI

Documentation

📖
Documentation
https://apidocs.workdayspend.com/
📖
GettingStarted
https://apidocs.workdayspend.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/openapi/scout-rfp-line-items-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/json-schema/scout-rfp-event-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/json-structure/scout-rfp-event-structure.json

Other Resources

🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/rules/scout-rfp-rules.yml
🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/json-ld/scout-rfp-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/examples/scout-rfp-list-events-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/scout-rfp/refs/heads/main/vocabulary/scout-rfp-vocabulary.yml

OpenAPI Specification

scout-rfp-line-items-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Workday Strategic Sourcing Events Bids Line Items API
  description: The Events API (formerly Scout RFP Events API) enables management of sourcing events including RFPs, RFIs, and reverse auctions within the Workday Strategic Sourcing platform. Supports creating events from templates, managing suppliers, worksheets, line items, and collecting bids.
  version: '1.3'
  contact:
    url: https://apidocs.workdayspend.com/
servers:
- url: https://api.us.workdayspend.com/services/events/v1
  description: US Production
- url: https://api.sandbox.us.workdayspend.com/services/events/v1
  description: US Sandbox
- url: https://api.eu.workdayspend.com/services/events/v1
  description: EU Production
- url: https://api.ca.workdayspend.com/services/events/v1
  description: CA Production
security:
- ApiKeyAuth: []
  UserTokenAuth: []
  UserEmailAuth: []
tags:
- name: Line Items
paths:
  /events/{event_id}/worksheets/{worksheet_id}/line_items:
    get:
      operationId: listLineItems
      summary: List Line Items
      description: List line items for a specific worksheet.
      tags:
      - Line Items
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
      - name: worksheet_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: List of line items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineItemsListResponse'
    post:
      operationId: createLineItem
      summary: Create Line Item
      description: Create a single line item in a worksheet.
      tags:
      - Line Items
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
      - name: worksheet_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LineItemCreateRequest'
      responses:
        '201':
          description: Line item created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineItemResponse'
  /events/{event_id}/worksheets/{worksheet_id}/line_items/bulk:
    post:
      operationId: bulkCreateLineItems
      summary: Bulk Create Line Items
      description: Create up to 200 line items in a single request.
      tags:
      - Line Items
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
      - name: worksheet_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/LineItemCreateRequest'
                  maxItems: 200
      responses:
        '201':
          description: Line items created
  /events/{event_id}/worksheets/{worksheet_id}/line_items/{id}:
    get:
      operationId: getLineItem
      summary: Get Line Item
      description: Retrieve a specific line item.
      tags:
      - Line Items
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
      - name: worksheet_id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Line item details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LineItemResponse'
    patch:
      operationId: updateLineItem
      summary: Update Line Item
      description: Update a specific line item.
      tags:
      - Line Items
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
      - name: worksheet_id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LineItemUpdateRequest'
      responses:
        '200':
          description: Line item updated
    delete:
      operationId: deleteLineItem
      summary: Delete Line Item
      description: Delete a specific line item.
      tags:
      - Line Items
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
      - name: worksheet_id
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Line item deleted
components:
  schemas:
    LineItemCreateRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            attributes:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                quantity:
                  type: number
                unit:
                  type: string
    LineItem:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
          properties:
            name:
              type: string
            description:
              type: string
            quantity:
              type: number
            unit:
              type: string
    LineItemUpdateRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            attributes:
              type: object
    LineItemResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/LineItem'
    LineItemsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Company-wide API key
    UserTokenAuth:
      type: apiKey
      in: header
      name: X-User-Token
      description: User-specific API token
    UserEmailAuth:
      type: apiKey
      in: header
      name: X-User-Email
      description: User email address