Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-6132

Provide Optimize REST API in OpenAPI format

    XMLWordPrintable

Details

    • 1
    • 3 - Expected

    Description

      Problem Definition

      User Story

      As a developer
      I want Optimize API endpoints in OpenAPI format
      So that I can quickly adopt Optimize for my production projects

      Use Cases

      • Import data
      • Manage dashboard/report configuration

      PM Notes (Customer requests, context, assumptions)

      • OpenAPI is the defacto industry standard
      • Camunda has already partially adopted OpenAPI (https://docs.camunda.org/manual/latest/reference/rest/openapi/)
      • Top priority endpoints to include as mentioned in SUPPORT-13386
        • POST /api/public/export/report/definition/json
        • POST /api/public/export/dashboard/definition/json
        • POST /api/public/import
        • POST /api/ingestion/variable
      • It should save a few hours per business unit - at 10 BUs it saves 30 dev-hrs

      Solution Definition

      Solution Ideas

      Design Notes (Videos, mockups, guidance)

      User Scenario

      GIVEN
      (MH/SH/NTH) WHEN
      (MH/SH/NTH) THEN

      Metrics (if applicable)

      mgm-controller-panel

        This is the controller panel for Smart Panels app

        Attachments

          Issue Links

            Activity

              People

                giuliano.rodrigues-lima Giuliano Rodrigues Lima
                eric.lundberg Eric Lundberg
                Giuliano Rodrigues Lima Giuliano Rodrigues Lima
                Votes:
                5 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                  Created:
                  Updated:

                  Salesforce