openrqm 1.0.1 openrqm: ^1.0.1 copied to clipboard
OpenRQM API
openrqm #
This is the OpenRQM API specification. OpenRQM Docs - Github
This Dart package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Build package: io.swagger.codegen.languages.DartClientCodegen
Requirements #
Dart 1.20.0 or later OR Flutter 0.0.20 or later
Installation & Usage #
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
name: openrqm
version: 1.0.0
description: OpenRQM API
dependencies:
openrqm:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
version: 'any'
Local #
To use the package in your local drive, please include the following in 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 = new 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
Class | Method | HTTP request | Description |
---|---|---|---|
DocumentApi | getDocument | GET /document | Get a document |
DocumentsApi | getDocuments | GET /documents | Get all documents |
ElementApi | patchElement | PATCH /element | Update an element |
ElementApi | postElement | POST /element | Add an element |
ElementApi | putElement | PUT /element | Update an element |
ElementsApi | getElements | GET /elements | Get all elements |
WorkspaceApi | getWorkspace | GET /workspace | Get a workspace |
WorkspacesApi | getWorkspaces | GET /workspaces | Get all workspaces |
Documentation For Models #
Documentation For Authorization #
All endpoints do not require authorization.