openrqm

This is the OpenRQM API specification. OpenRQM Docs - Github

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openrqm:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openrqm:
    path: /path/to/openrqm

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openrqm/api.dart';


var api_instance = DocumentApi();

try {
    var result = api_instance.getDocument();
    print(result);
} catch (e) {
    print("Exception when calling DocumentApi->getDocument: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/benjaminSchilling33/OpenRQM/1.0.0

ClassMethodHTTP requestDescription
DocumentApigetDocumentGET /documentGet a document
DocumentsApigetDocumentsGET /documentsGet all documents
ElementApipatchElementPATCH /elementUpdate an element
ElementApipostElementPOST /elementAdd an element
ElementApiputElementPUT /elementUpdate an element
ElementsApigetElementsGET /elementsGet all elements
WorkspaceApigetWorkspaceGET /workspaceGet a workspace
WorkspacesApigetWorkspacesGET /workspacesGet all workspaces

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

Libraries

openrqm.api