Cumulocity Applications API

The Applications API from Cumulocity — 2 operation(s) for applications.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

cumulocity-applications-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Applications 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: Applications
paths:
  /application/applications:
    get:
      tags:
      - Applications
      summary: List Applications
      operationId: listApplications
      responses:
        '200':
          description: A collection of applications.
          content:
            application/vnd.com.nsn.cumulocity.applicationCollection+json:
              schema:
                $ref: '#/components/schemas/ApplicationCollection'
    post:
      tags:
      - Applications
      summary: Create an Application
      operationId: createApplication
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.application+json:
            schema:
              $ref: '#/components/schemas/Application'
      responses:
        '201':
          description: Application created.
  /application/applications/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Applications
      summary: Retrieve an Application
      operationId: getApplication
      responses:
        '200':
          description: A single application.
          content:
            application/vnd.com.nsn.cumulocity.application+json:
              schema:
                $ref: '#/components/schemas/Application'
    put:
      tags:
      - Applications
      summary: Update an Application
      operationId: updateApplication
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.application+json:
            schema:
              $ref: '#/components/schemas/Application'
      responses:
        '200':
          description: Application updated.
    delete:
      tags:
      - Applications
      summary: Delete an Application
      operationId: deleteApplication
      responses:
        '204':
          description: Application deleted.
components:
  schemas:
    ApplicationCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        applications:
          type: array
          items:
            $ref: '#/components/schemas/Application'
    Application:
      type: object
      properties:
        id:
          type: string
        self:
          type: string
          format: uri
        name:
          type: string
        key:
          type: string
        type:
          type: string
          enum:
          - HOSTED
          - MICROSERVICE
          - EXTERNAL
        availability:
          type: string
          enum:
          - PRIVATE
          - MARKET
        contextPath:
          type: string
        manifest:
          type: object
        requiredRoles:
          type: array
          items:
            type: string
        owner:
          type: object
          properties:
            tenant:
              type: object
              properties:
                id:
                  type: string
        resourcesUrl:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT