arazzo: 1.0.1
info:
title: PeopleSoft List and Execute a Query
summary: List available PS Query definitions, confirm the requested query exists, then execute it with paging.
description: >-
A reporting flow over the PeopleSoft Query Access Service. It lists the
available PeopleSoft Query definitions, then executes the requested query by
name with row-limit and offset paging, returning the result rows and the
total row count. Every step spells out its request inline so the flow can be
read and executed without opening the underlying OpenAPI description.
version: 1.0.0
sourceDescriptions:
- name: queriesApi
url: ../openapi/peoplesoft-queries-api-openapi.yml
type: openapi
workflows:
- workflowId: query-export
summary: Discover a PS Query definition then execute it for results.
description: >-
Lists query definitions and executes the named query with optional paging,
returning the rows and total row count.
inputs:
type: object
required:
- authorization
- queryName
properties:
authorization:
type: string
description: HTTP Basic auth header value (e.g. "Basic dXNlcjpwYXNz").
queryName:
type: string
description: The PeopleSoft Query name to execute.
isConnectedQuery:
type: boolean
description: Whether the named query is a Connected Query.
default: false
maxRows:
type: integer
description: Maximum number of rows to return.
default: 100
offset:
type: integer
description: Row offset for pagination.
default: 0
steps:
- stepId: listQueries
description: >-
Retrieve the catalog of available PeopleSoft Query definitions.
operationId: listQueries
parameters:
- name: Authorization
in: header
value: $inputs.authorization
successCriteria:
- condition: $statusCode == 200
outputs:
queries: $response.body#/queries
- stepId: executeQuery
description: >-
Execute the named query and retrieve the result rows with paging applied.
operationId: executeQuery
parameters:
- name: queryName
in: path
value: $inputs.queryName
- name: isConnectedQuery
in: query
value: $inputs.isConnectedQuery
- name: maxRows
in: query
value: $inputs.maxRows
- name: offset
in: query
value: $inputs.offset
- name: Authorization
in: header
value: $inputs.authorization
successCriteria:
- condition: $statusCode == 200
outputs:
rows: $response.body#/rows
totalRows: $response.body#/totalRows
outputs:
queries: $steps.listQueries.outputs.queries
rows: $steps.executeQuery.outputs.rows
totalRows: $steps.executeQuery.outputs.totalRows
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.