Dell Servers Jobs API

openapi: 3.2.0
info:
  title: Dell Servers Dell OpenManage Enterprise Jobs API
  description: RESTful API for centralized management of Dell EMC servers, chassis, and storage through the OpenManage Enterprise console. Provides discovery, inventory, monitoring, alerting, firmware updates, configuration compliance, and lifecycle management of Dell PowerEdge infrastructure at scale. The API delivers JSON responses over HTTPS and follows OData v4 conventions.
  version: '4.0'
  contact:
    name: Dell Technologies Support
    url: https://www.dell.com/support
  termsOfService: https://i.dell.com/sites/csdocuments/Legal_Docs/en/us/api-terms-of-use_en.pdf
servers:
- url: https://{ome-server}/api
  description: OpenManage Enterprise API Server
  variables:
    ome-server:
      description: Hostname or IP address of the OpenManage Enterprise appliance
      default: ome-server.example.com
security:
- sessionAuth: []
tags:
- name: Jobs
  description: Job creation, scheduling, and status tracking
paths:
  /JobService/Jobs:
    get:
      operationId: listJobs
      summary: Dell Servers List jobs
      description: Retrieves the collection of jobs in OpenManage Enterprise including discovery, firmware update, configuration, and report jobs. Supports OData filtering by job type and status.
      tags:
      - Jobs
      parameters:
      - name: $filter
        in: query
        description: OData filter expression for job criteria
        schema:
          type: string
      responses:
        '200':
          description: Collection of jobs
          content:
            application/json:
              schema:
                type: object
                properties:
                  '@odata.count':
                    type: integer
                    description: Total number of matching jobs
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job'
        '401':
          description: Unauthorized - invalid or expired session token
    post:
      operationId: createJob
      summary: Dell Servers Create a job
      description: Creates a new job for executing operations such as firmware updates, configuration deployment, or inventory refresh on targeted devices.
      tags:
      - Jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobRequest'
      responses:
        '201':
          description: Job created successfully
        '400':
          description: Invalid job parameters
        '401':
          description: Unauthorized - invalid or expired session token
  /JobService/Jobs({JobId}):
    get:
      operationId: getJob
      summary: Dell Servers Get a job
      description: Retrieves the status and details of a specific job including progress percentage, execution history, and any error messages.
      tags:
      - Jobs
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '401':
          description: Unauthorized - invalid or expired session token
        '404':
          description: Job not found
components:
  schemas:
    JobRequest:
      type: object
      description: Request body for creating a new job
      required:
      - JobName
      - JobDescription
      - Targets
      properties:
        JobName:
          type: string
          description: Name for the new job
        JobDescription:
          type: string
          description: Description of the job
        Schedule:
          type: string
          description: Cron expression for scheduling or RunNow
        Targets:
          type: array
          description: Target devices or groups for the job
          items:
            type: object
            properties:
              Id:
                type: integer
                description: Target device or group identifier
              Data:
                type: string
                description: Additional target data
              TargetType:
                type: object
                properties:
                  Id:
                    type: integer
                    description: Target type identifier
                  Name:
                    type: string
                    description: Target type name
    Job:
      type: object
      description: An asynchronous job in OpenManage Enterprise
      properties:
        Id:
          type: integer
          description: Unique job identifier
        JobName:
          type: string
          description: Job name
        JobDescription:
          type: string
          description: Job description
        JobType:
          type: object
          description: Job type information
          properties:
            Id:
              type: integer
              description: Job type identifier
            Name:
              type: string
              description: Job type name
        LastRunStatus:
          type: object
          description: Status of the last job execution
          properties:
            Id:
              type: integer
              description: Status code
            Name:
              type: string
              description: Status description
        JobStatus:
          type: object
          description: Current job status
          properties:
            Id:
              type: integer
              description: Status code
            Name:
              type: string
              description: Status description
        PercentComplete:
          type: integer
          description: Job completion percentage
          minimum: 0
          maximum: 100
        StartTime:
          type: string
          format: date-time
          description: Job start timestamp
        EndTime:
          type: string
          format: date-time
          description: Job completion timestamp
  parameters:
    JobId:
      name: JobId
      in: path
      required: true
      description: Unique identifier for a job
      schema:
        type: integer
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session token obtained from the POST /SessionService/Sessions endpoint. Must be included in the X-Auth-Token header of all authenticated requests.
externalDocs:
  description: OpenManage Enterprise RESTful API Guide
  url: https://www.dell.com/support/manuals/en-us/dell-openmanage-enterprise/ome_p_api_guide/overview?guid=guid-fc1c0585-795c-41fe-9957-977678be554f&lang=en-us