openapi: 3.0.3
info:
  title: SAS Viya REST BusinessRules Jobs API
  description: 'Representative slice of the SAS Viya REST API surface across the platform''s primary capability domains: jobs, reports, models, decisions, identities, files, folders, and OAuth via SAS Logon. The full catalog lists 50+ services at https://developer.sas.com/rest-apis.'
  version: '2024.10'
  contact:
    name: SAS Developer Portal
    url: https://developer.sas.com/
servers:
- url: https://{viya-host}
  description: A SAS Viya deployment
  variables:
    viya-host:
      default: viya.example.com
      description: The tenant host for the SAS Viya deployment
security:
- oauth2: []
tags:
- name: Jobs
paths:
  /jobExecution/jobs:
    get:
      summary: List Jobs
      operationId: listJobs
      tags:
      - Jobs
      responses:
        '200':
          description: A collection of jobs
          content:
            application/vnd.sas.collection+json:
              schema:
                $ref: '#/components/schemas/JobCollection'
    post:
      summary: Create Job
      operationId: createJob
      tags:
      - Jobs
      requestBody:
        required: true
        content:
          application/vnd.sas.job.execution.job.request+json:
            schema:
              $ref: '#/components/schemas/Job'
      responses:
        '201':
          description: Job created
  /jobExecution/jobs/{id}:
    get:
      summary: Get Job
      operationId: getJob
      tags:
      - Jobs
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A job
          content:
            application/vnd.sas.job.execution.job+json:
              schema:
                $ref: '#/components/schemas/Job'
components:
  schemas:
    Job:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        state:
          type: string
          enum:
          - pending
          - running
          - completed
          - failed
          - canceled
        jobDefinitionUri:
          type: string
        createdBy:
          type: string
        creationTimeStamp:
          type: string
          format: date-time
        endTimeStamp:
          type: string
          format: date-time
    JobCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Job'
        count:
          type: integer
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        password:
          tokenUrl: /SASLogon/oauth/token
          scopes:
            openid: OpenID Connect scope