Workday Financials Report Prompts API

openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Report Prompts API
  description: API for managing cash positions, bank accounts, transactions, and cash forecasting within Workday Cash Management.
  version: v38.2
  contact:
    name: Workday Support
    url: https://www.workday.com/en-us/company/latest/support.html
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{tenant}.workday.com/api/cashManagement/v38.2
  description: Workday Cash Management Production
  variables:
    tenant:
      description: Workday tenant identifier
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Report Prompts
  description: Manage report prompt values
paths:
  /reports/{id}/prompts:
    get:
      operationId: getReportPrompts
      summary: Workday Financials Get report prompts
      description: Retrieve the prompt definitions for a specific report.
      tags:
      - Report Prompts
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Report prompts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReportPrompt'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource (WID)
      schema:
        type: string
  responses:
    NotFound:
      description: The requested resource was not found
    Unauthorized:
      description: Authentication credentials are missing or invalid
  schemas:
    ReportPrompt:
      type: object
      properties:
        name:
          type: string
          description: Prompt parameter name
        label:
          type: string
          description: Prompt display label
        required:
          type: boolean
          description: Whether the prompt is required
        dataType:
          type: string
          description: Expected data type for the prompt value
        defaultValue:
          type: string
          description: Default value for the prompt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Workday authentication
externalDocs:
  description: Workday Cash Management API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html