Cumulocity

Cumulocity Offload Jobs API

The Offload Jobs API from Cumulocity — 1 operation(s) for offload jobs.

Documentation GitHub OpenAPI

Documentation

https://cumulocity.com/api/core/

https://cumulocity.com/docs/concepts/domain-model/

https://cumulocity.com/docs/device-integration/device-integration-introduction/

https://cumulocity.com/docs/microservice-sdk/

https://cumulocity.com/docs/reference/notifications/

https://cumulocity.com/api/datahub/

https://cumulocity.com/docs/datahub/datahub-overview/

https://cumulocity.com/api/dtm/

https://cumulocity.com/docs/digital-twin-manager/dtm-overview/

https://cumulocity.com/api/edge/

https://cumulocity.com/docs/edge/edge-overview/

Specifications

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/openapi/cumulocity-offload-jobs-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/asyncapi/cumulocity-notification2-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-managed-object-schema.json

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-measurement-schema.json

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-event-schema.json

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-schema/cumulocity-alarm-schema.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/cumulocity/refs/heads/main/json-ld/cumulocity-context.jsonld

OpenAPI Specification

openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Offload Jobs API
  version: 10.20.0
  description: 'Raise, query, acknowledge, clear, and bulk-update alarms with four severity levels (CRITICAL, MAJOR,

    MINOR, WARNING) and four statuses (ACTIVE, ACKNOWLEDGED, CLEARED). Cumulocity auto-deduplicates alarms

    by source + type so repeated raises increment the count rather than creating duplicates.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Offload Jobs
paths:
  /service/datahub/offload/{id}/jobs:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Offload Jobs
      summary: List Offload Jobs
      operationId: listOffloadJobs
      responses:
        '200':
          description: A collection of offload jobs.
    post:
      tags:
      - Offload Jobs
      summary: Start an Offload Job
      operationId: startOffloadJob
      responses:
        '201':
          description: Offload job started.
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT