openapi: 3.2.0
info:
  title: Core Scheduled Job API
  version: core
tags:
- name: Scheduled Job
paths:
  /jobsystem/scheduledJobs/changes:
    get:
      tags:
      - Scheduled Job
      parameters:
      - name: since
        in: query
        schema:
          type: string
      - name: cursor
        in: query
        schema:
          type: string
      - name: links
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceChanges_ApiScheduledJobResource'
      summary: Get jobsystem scheduled jobs changes
      x-summary-source: derived
      operationId: getJobsystemScheduledJobsChanges
      x-operation-id-source: derived
  /jobsystem/scheduledJobs/template:
    get:
      tags:
      - Scheduled Job
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResult_ApiScheduledJobResource'
      summary: Get jobsystem scheduled jobs template
      x-summary-source: derived
      operationId: getJobsystemScheduledJobsTemplate
      x-operation-id-source: derived
  /jobsystem/scheduledJobs/{id}:
    get:
      tags:
      - Scheduled Job
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: links
        in: query
        schema:
          type: string
      - name: include
        in: query
        schema:
          type: string
      - name: expand
        in: query
        schema:
          type: string
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultEntity_ApiScheduledJobResource'
      summary: Get jobsystem scheduled jobs by id
      x-summary-source: derived
      operationId: getJobsystemScheduledJobsById
      x-operation-id-source: derived
    put:
      tags:
      - Scheduled Job
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiResourceId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
      summary: Replace jobsystem scheduled jobs by id
      x-summary-source: derived
      operationId: putJobsystemScheduledJobsById
      x-operation-id-source: derived
    delete:
      tags:
      - Scheduled Job
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResource'
      summary: Delete jobsystem scheduled jobs by id
      x-summary-source: derived
      operationId: deleteJobsystemScheduledJobsById
      x-operation-id-source: derived
  /jobsystem/scheduledJobs/{id}/blob/{blobMemberName}:
    get:
      tags:
      - Scheduled Job
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: blobMemberName
        in: path
        required: true
        schema:
          type: string
      - name: fileName
        in: query
        schema:
          type: string
      - name: contentType
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                format: binary
      summary: Get jobsystem scheduled jobs by id blob by blob member name
      x-summary-source: derived
      operationId: getJobsystemScheduledJobsByIdBlobByBlobMemberName
      x-operation-id-source: derived
  /jobsystem/scheduledJobs:
    get:
      tags:
      - Scheduled Job
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: search
        in: query
        schema:
          type: string
      - name: order
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: string
      - name: includeCount
        in: query
        schema:
          type: string
      - name: includeDeleted
        in: query
        schema:
          type: string
      - name: links
        in: query
        schema:
          type: string
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection_ApiScheduledJobResource'
      summary: Get jobsystem scheduled jobs
      x-summary-source: derived
      operationId: getJobsystemScheduledJobs
      x-operation-id-source: derived
    post:
      tags:
      - Scheduled Job
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiResourceId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
      summary: Create jobsystem scheduled jobs
      x-summary-source: derived
      operationId: postJobsystemScheduledJobs
      x-operation-id-source: derived
components:
  schemas:
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    ApiResourceId:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          type: integer
          format: int32
      additionalProperties: false
    ApiResourceResultEntityLinks:
      type: object
      properties:
        self:
          type:
          - string
          - 'null'
        associations:
          type:
          - array
          - 'null'
          items:
            type: string
        expand:
          type:
          - array
          - 'null'
          items:
            type: string
        operations:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    ApiResourceResultUpdatesExtra:
      type: object
      properties:
        until:
          type:
          - string
          - 'null'
        cursor:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApiResourceStatus:
      type: object
      properties:
        id:
          type:
          - integer
          - 'null'
          format: int32
        isSuccess:
          type: boolean
      additionalProperties: false
    ApiResourceResultEntityExtra:
      type: object
      properties:
        expand:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties: {}
        include:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              type: object
              additionalProperties: {}
      additionalProperties: false
    ApiResource:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
      additionalProperties: false
    ApiResourceResult_ApiScheduledJobResource:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          $ref: '#/components/schemas/AMCS.Core.Entity.Api.JobSystem.ApiScheduledJob'
      additionalProperties: false
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApiResourceResultEntity_ApiScheduledJobResource:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          $ref: '#/components/schemas/AMCS.Core.Entity.Api.JobSystem.ApiScheduledJob'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
      additionalProperties: false
    AMCS.Core.Entity.Api.JobSystem.ApiScheduledJob:
      type: object
      properties:
        isValid:
          type: boolean
          readOnly: true
        id:
          type:
          - integer
          - 'null'
          format: int32
          readOnly: true
        id32:
          type: integer
          format: int32
          readOnly: true
        guid:
          type:
          - string
          - 'null'
          format: uuid
        lastChangeReasonId:
          type:
          - integer
          - 'null'
          format: int32
        tempIdentifier:
          type:
          - string
          - 'null'
        scheduledJobId:
          type:
          - integer
          - 'null'
          format: int32
        trigger:
          type:
          - string
          - 'null'
        friendlyName:
          type:
          - string
          - 'null'
        handler:
          type:
          - string
          - 'null'
        parameters:
          type:
          - string
          - 'null'
        queue:
          type:
          - string
          - 'null'
        deadline:
          type:
          - integer
          - 'null'
          format: int32
        persistenceMode:
          type:
          - integer
          - 'null'
          format: int32
        duplicateMode:
          type: integer
          format: int32
        ownerTag:
          type:
          - string
          - 'null'
      additionalProperties: false
    ApiResourceChanges_ApiScheduledJobResource:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AMCS.Core.Entity.Api.JobSystem.ApiScheduledJob'
        extra:
          $ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
      additionalProperties: false
    ApiResourceResultCollection_ApiScheduledJobResource:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
        resource:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AMCS.Core.Entity.Api.JobSystem.ApiScheduledJob'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
      additionalProperties: false