Microsoft Azure scheduledJobs API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector scheduledJobs API
schemes:
- https
tags:
- name: scheduledJobs
paths:
  /scheduledJobs:
    get:
      operationId: microsoftAzureScheduledjobsList
      summary: Microsoft Azure Get The List Of Scheduled Job Definitions In An Application
      x-ms-examples:
        List scheduled jobs:
          $ref: ./examples/scheduledjobs_list.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/MaxPageSize'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScheduledJobCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - scheduledJobs
  /scheduledJobs/{scheduledJobId}:
    get:
      operationId: microsoftAzureScheduledjobsGet
      summary: Microsoft Azure Get A Scheduled Job By Id
      description: Get details about a scheduled job by ID.
      x-ms-examples:
        Get scheduled job by ID:
          $ref: ./examples/scheduledjobs_get.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ScheduledJobId'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScheduledJob'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - scheduledJobs
    put:
      operationId: microsoftAzureScheduledjobsCreate
      summary: Microsoft Azure Create Or Update A Scheduled Job
      description: Create or update a scheduled job by ID.
      x-ms-examples:
        Create a scheduled job:
          $ref: ./examples/scheduledjobs_create.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ScheduledJobId'
      - in: body
        name: body
        description: Scheduled job definition.
        schema:
          $ref: '#/definitions/ScheduledJob'
        required: true
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScheduledJob'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - scheduledJobs
    patch:
      operationId: microsoftAzureScheduledjobsUpdate
      summary: Microsoft Azure Update A Scheduled Job Via Patch
      description: Update an existing scheduled job by ID.
      x-ms-examples:
        Update Scheduled Job:
          $ref: ./examples/scheduledjobs_update.json
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ScheduledJobId'
      - in: body
        name: body
        description: Scheduled job patch.
        schema:
          type: object
        required: true
      - $ref: '#/parameters/IfMatch'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScheduledJob'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - scheduledJobs
    delete:
      operationId: microsoftAzureScheduledjobsRemove
      summary: Microsoft Azure Delete A Scheduled Job
      description: Delete an existing scheduled job by ID.
      x-ms-examples:
        Delete scheduled job:
          $ref: ./examples/scheduledjobs_delete.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ScheduledJobId'
      responses:
        '204':
          description: Success
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      tags:
      - scheduledJobs
  /scheduledJobs/{scheduledJobId}/jobs:
    get:
      operationId: microsoftAzureScheduledjobsListjobs
      summary: Microsoft Azure Get The List Of Jobs For A Scheduled Job Definition
      x-ms-examples:
        List running job instances:
          $ref: ./examples/scheduledjobs_list_jobs.json
      parameters:
      - $ref: '#/parameters/Version'
      - $ref: '#/parameters/ScheduledJobId'
      - $ref: '#/parameters/MaxPageSize'
      x-ms-pageable:
        nextLinkName: nextLink
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/JobCollection'
        default:
          description: An error response received from the IoT Central Service.
          headers:
            x-ms-error-code:
              type: string
              description: Error code for specific error that occurred.
          schema:
            $ref: '#/definitions/Error'
      description: Needs a more full description created.
      tags:
      - scheduledJobs
definitions:
  ScheduledJobCollection:
    description: The paged results of scheduled job definitions.
    type: object
    properties:
      value:
        description: The collection of scheduled jobs.
        type: array
        items:
          $ref: '#/definitions/ScheduledJob'
      nextLink:
        description: URL to get the next page of scheduled jobs.
        type: string
    required:
    - value
  JobProgress:
    description: progress summary for a scheduled job.
    type: object
    properties:
      total:
        description: The total number of entities targeted by the job.
        type: integer
        format: int32
      pending:
        description: The number of entities for which the job is not yet running.
        type: integer
        format: int32
      completed:
        description: The number of entities for which the job has completed.
        type: integer
        format: int32
      failed:
        description: The number of entities for which the job has failed.
        type: integer
        format: int32
  ErrorDetails:
    description: The detail information of the error.
    type: object
    properties:
      code:
        type: string
        description: Error code.
      message:
        type: string
        description: Error message details.
      requestId:
        type: string
        description: Correlation Id for current request.
      time:
        type: string
        format: date-time-rfc1123
        description: The time that error request failed.
    required:
    - code
    - message
  Job:
    description: The job definition.
    type: object
    properties:
      id:
        description: Unique ID of the job.
        type: string
        readOnly: true
      scheduledJobId:
        description: Id of the scheduled job definition that created this job.
        type: string
      displayName:
        description: Display name of the job.
        type: string
      description:
        description: Detailed description of the job.
        type: string
      group:
        description: The ID of the device group on which to execute the job.
        type: string
      batch:
        description: The batching configuration for the job.
        $ref: '#/definitions/JobBatch'
      cancellationThreshold:
        description: The cancellation threshold for the job.
        $ref: '#/definitions/JobCancellationThreshold'
      data:
        description: The capabilities being updated by the job and the values with which they are being updated.
        type: array
        items:
          $ref: '#/definitions/JobData'
        minItems: 1
      start:
        description: The start time of the job
        type: string
        format: date-time
        readOnly: true
      end:
        description: The end time of the job
        type: string
        format: date-time
        readOnly: true
      progress:
        description: The progress statistics of the job.
        $ref: '#/definitions/JobProgress'
        readOnly: true
      status:
        description: Indicates whether the job is starting, running, etc.
        type: string
        readOnly: true
      organizations:
        description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.
        type: array
        items:
          type: string
        maxItems: 1
        minItems: 1
    required:
    - group
    - data
  JobBatch:
    description: The job batch definition.
    type: object
    properties:
      type:
        description: Whether batching is done on a specified number of devices or a percentage of the total devices.
        type: string
        enum:
        - number
        - percentage
        x-ms-enum:
          name: JobBatchType
          modelAsString: false
          values:
          - value: number
            name: Number
            description: Job Batching based on number of devices.
          - value: percentage
            name: Percentage
            description: Job Batching based percentage of total applied devices.
      value:
        description: The number or percentage of devices on which batching is done.
        type: number
    required:
    - type
    - value
  JobCancellationThreshold:
    description: The job cancellation threshold definition.
    type: object
    properties:
      type:
        description: Whether the cancellation threshold is per a specified number of devices or a percentage of the total devices.
        type: string
        enum:
        - number
        - percentage
        x-ms-enum:
          name: JobCancellationThresholdType
          modelAsString: false
          values:
          - value: number
            name: Number
            description: Job cancellation threshold based on specified number of devices.
          - value: percentage
            name: Percentage
            description: Job cancellation threshold based on percentage of total devices.
      value:
        description: The number or percentage of devices on which the cancellation threshold is applied.
        type: number
      batch:
        description: Whether the cancellation threshold applies per-batch or to the overall job.
        type: boolean
    required:
    - type
    - value
  JobCollection:
    description: The paged results of jobs.
    type: object
    properties:
      value:
        description: The collection of jobs.
        type: array
        items:
          $ref: '#/definitions/Job'
      nextLink:
        description: URL to get the next page of jobs.
        type: string
    required:
    - value
  JobSchedule:
    description: The schedule definition of job.
    type: object
    properties:
      recurrence:
        description: The recurrence of the scheduled job. If not provided, the job will run once at the specified start time.
        type: string
        enum:
        - daily
        - weekly
        - monthly
        x-ms-enum:
          name: JobRecurrence
          modelAsString: false
          values:
          - value: daily
            name: Daily
            description: The job will run once daily
          - value: weekly
            name: Weekly
            description: The job will run once every week
          - value: monthly
            name: Monthly
            description: The job will run once every month
      start:
        description: The start time for the scheduled job
        type: string
        format: date-time
      end:
        description: The specification of when to end the scheduled job.
        $ref: '#/definitions/JobScheduleEnd'
    required:
    - start
  ScheduledJob:
    description: The scheduled job definition.
    type: object
    properties:
      etag:
        description: ETag used to prevent conflict in scheduled job updates.
        type: string
      id:
        description: Unique ID of the scheduled job.
        type: string
        readOnly: true
      displayName:
        description: Display name of the scheduled job.
        type: string
      description:
        description: Detailed description of the scheduled job.
        type: string
      group:
        description: The ID of the device group on which to execute the scheduled job.
        type: string
      batch:
        description: The batching configuration for the scheduled job.
        $ref: '#/definitions/JobBatch'
      cancellationThreshold:
        description: The cancellation threshold for the scheduled job.
        $ref: '#/definitions/JobCancellationThreshold'
      data:
        description: Data related to the operation being performed by this job. All entries must be of the same type.
        type: array
        items:
          $ref: '#/definitions/JobData'
        minItems: 1
      organizations:
        description: List of organizations of the job, only one organization is supported today, multiple organizations will be supported soon.
        type: array
        items:
          type: string
        maxItems: 1
        minItems: 1
      schedule:
        description: The schedule at which to execute the job.
        $ref: '#/definitions/JobSchedule'
      enabled:
        description: Whether the scheduled job is enabled.
        type: boolean
      completed:
        description: Whether the scheduled job has completed.
        type: boolean
        readOnly: true
    required:
    - schedule
    - group
    - data
  JobScheduleEnd:
    description: The end definition of job schedule.
    type: object
    properties:
      type:
        description: Type of the job schedule end.
        type: string
    required:
    - type
    discriminator: type
  Error:
    description: The response error definition.
    type: object
    properties:
      error:
        description: Error details for current request.
        $ref: '#/definitions/ErrorDetails'
    required:
    - error
  JobData:
    description: The job data definition.
    type: object
    properties:
      type:
        description: Type of the job data.
        type: string
    required:
    - type
    discriminator: type
parameters:
  ScheduledJobId:
    in: path
    name: scheduledJobId
    description: Unique ID of the scheduled job.
    x-ms-parameter-location: method
    type: string
    maxLength: 255
    pattern: ^[a-zA-Z0-9_-]*$
    required: true
  Version:
    in: query
    name: api-version
    description: The version of the API being called.
    x-ms-parameter-location: client
    type: string
    required: true
  MaxPageSize:
    in: query
    name: maxpagesize
    description: The maximum number of resources to return from one response.
    x-ms-parameter-location: method
    type: integer
    format: int32
    minimum: 1
    maximum: 100
    required: false
  IfMatch:
    in: header
    name: If-Match
    description: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
    x-ms-parameter-location: method
    type: string
    required: false
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'