UCLouvain

UCLouvain Jobs API

The Jobs API from UCLouvain — 7 operation(s) for jobs.

Documentation GitHub OpenAPI

Operations 9

GET /jobs List jobs #

DELETE /jobs/{id} Delete a job from history #

GET /jobs/{id} Get job #

POST /jobs/{id}/cancel Cancel job #

POST /jobs/{id}/pause Pause job #

POST /jobs/{id}/resubmit Resubmit job #

POST /jobs/{id}/resume Resume job #

DELETE /jobs/{id}/{key} Delete a job output #

GET /jobs/{id}/{key} Get job output #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/uclouvain:uclouvain-jobs-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: 'This is the full documentation of the REST API of Orthanc.

    This reference is automatically generated from the source code of Orthanc. A shorter cheat sheet is part of the Orthanc Book.

    An earlier, manually crafted version from August 2019, is still available, but is not up-to-date anymore (source).'
  title: Orthanc Jobs API
  version: 1.13.0
servers:
- url: https://orthanc.uclouvain.be/demo/
tags:
- name: Jobs
paths:
  /jobs:
    get:
      deprecated: false
      description: List all the available jobs
      parameters:
      - description: If present, retrieve detailed information about the individual jobs
        in: query
        name: expand
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                description: JSON array containing either the jobs identifiers, or detailed information about the reported jobs (if `expand` argument is provided)
                example:
                - 8d01242e-41cb-425c-a2be-ea692d448c80
          description: ''
      summary: List jobs
      tags:
      - Jobs
      operationId: getJobs
      x-operation-id-source: derived
  /jobs/{id}:
    delete:
      deprecated: false
      description: Delete the job from the jobs history. Only a completed job can be deleted. If the job has not run or not completed yet, you must cancel it first. If the job has outputs, all outputs will be deleted as well.
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Delete a job from history
      tags:
      - Jobs
      operationId: deleteJobsById
      x-operation-id-source: derived
    get:
      deprecated: false
      description: 'Retrieve detailed information about the job whose identifier is provided in the URL: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs'
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                description: JSON object detailing the job
                example:
                  CompletionTime: 20201227T161842.520129
                  Content:
                    ArchiveSizeMB: 22
                    Description: REST API
                    InstancesCount: 232
                    UncompressedSizeMB: 64
                  CreationTime: 20201227T161836.428311
                  EffectiveRuntime: 6.081
                  ErrorCode: 0
                  ErrorDescription: Success
                  ID: 645ecb02-7c0e-4465-b767-df873222dcfb
                  Priority: 0
                  Progress: 100
                  State: Success
                  Timestamp: 20201228T160340.253201
                  Type: Media
          description: ''
      summary: Get job
      tags:
      - Jobs
      operationId: getJobsById
      x-operation-id-source: derived
  /jobs/{id}/cancel:
    post:
      deprecated: false
      description: 'Cancel the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs'
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples: {}
              schema:
                description: Empty JSON object in the case of a success
          description: ''
      summary: Cancel job
      tags:
      - Jobs
      operationId: postJobsByIdCancel
      x-operation-id-source: derived
  /jobs/{id}/pause:
    post:
      deprecated: false
      description: 'Pause the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs'
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples: {}
              schema:
                description: Empty JSON object in the case of a success
          description: ''
      summary: Pause job
      tags:
      - Jobs
      operationId: postJobsByIdPause
      x-operation-id-source: derived
  /jobs/{id}/resubmit:
    post:
      deprecated: false
      description: 'Resubmit the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs'
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples: {}
              schema:
                description: Empty JSON object in the case of a success
          description: ''
      summary: Resubmit job
      tags:
      - Jobs
      operationId: postJobsByIdResubmit
      x-operation-id-source: derived
  /jobs/{id}/resume:
    post:
      deprecated: false
      description: 'Resume the job whose identifier is provided in the URL. Check out the Orthanc Book for more information about the state machine applicable to jobs: https://orthanc.uclouvain.be/book/users/advanced-rest.html#jobs'
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples: {}
              schema:
                description: Empty JSON object in the case of a success
          description: ''
      summary: Resume job
      tags:
      - Jobs
      operationId: postJobsByIdResume
      x-operation-id-source: derived
  /jobs/{id}/{key}:
    delete:
      deprecated: false
      description: Delete the output produced by a job. As of Orthanc 1.12.1, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: Name of the output of interest
        in: path
        name: key
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Delete a job output
      tags:
      - Jobs
      operationId: deleteJobsByIdByKey
      x-operation-id-source: derived
    get:
      deprecated: false
      description: Retrieve some output produced by a job. As of Orthanc 1.8.2, only the jobs that generate a DICOMDIR media or a ZIP archive provide such an output (with `key` equals to `archive`).
      parameters:
      - description: Identifier of the job of interest
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: Name of the output of interest
        in: path
        name: key
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/octet-stream:
              examples: {}
              schema:
                description: Content of the output of the job
          description: ''
      summary: Get job output
      tags:
      - Jobs
      operationId: getJobsByIdByKey
      x-operation-id-source: derived
x-provenance:
  method: harvested
  publisher: UCLouvain
  source: https://orthanc.uclouvain.be/api/orthanc-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)