openrqm 1.0.24

OpenRQM API

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.24
• 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';

// TODO Configure API key authorization: APIKeyHeader
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIKeyHeader').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('APIKeyHeader').apiKeyPrefix = 'Bearer';

var api_instance = AccessGroupsApi();
var accessGroup = RQMAccessGroup(); // RQMAccessGroup | The access group to create

try {
    api_instance.addAccessgroup(accessGroup);
} catch (e) {
    print("Exception when calling AccessGroupsApi->addAccessgroup: $e\n");
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccessGroupsApi	addAccessgroup	POST /accessgroup	Add an access group
AccessGroupsApi	addUserToAccessGroup	POST /accessgroup/users	Add a user to an access group
AccessGroupsApi	deleteAccessgroup	DELETE /accessgroup	Delete an access group
AccessGroupsApi	deleteUserOfAccessGroup	DELETE /accessgroup/users	Delete a user of an access group
AccessGroupsApi	getAccessgroup	GET /accessgroup	Get a specific access group
AccessGroupsApi	getAccessgroups	GET /accessgroups	Get all access groups
AccessGroupsApi	getUsersOfAccessGroup	GET /accessgroup/users	Get all users of a given access group
AccessGroupsApi	patchAccessgroup	PATCH /accessgroup	Update an access group
DocumentsApi	deleteDocument	DELETE /document	Delete a document
DocumentsApi	getDocument	GET /document	Get a document
DocumentsApi	getDocuments	GET /documents	Get all documents
DocumentsApi	getLinksOfDocument	GET /document/links	Get all links of a document
DocumentsApi	patchDocument	PATCH /document	Update a document
DocumentsApi	postDocument	POST /document	Add a document
ElementsApi	deleteElement	DELETE /element	Delete an element
ElementsApi	getElementTypes	GET /elementTypes	Get all element types
ElementsApi	getElements	GET /elements	Get all elements
ElementsApi	getIncomingLinksOfElement	GET /element/inlinks	Get all links of a given element
ElementsApi	getOutgoingLinksOfElement	GET /element/outlinks	Get all links of a given element
ElementsApi	patchElement	PATCH /element	Update an element
ElementsApi	postElement	POST /element	Add an element
ExportApi	exportMarkdown	GET /export/markdown	Export a document as Markdown
ExportApi	exportPdf	GET /export/pdf	Export a document as PDF
ExportApi	exportRaw	GET /export/openrqm	Export a document as OpenRQM Data for import
ExportApi	getMarkdownTemplates	GET /export/markdown/templates	Get all Markdown templates
ExportApi	getPdfTemplates	GET /export/pdf/templates	Get all PDF templates
ImportApi	importDocument	POST /import	Post document for import
LinksApi	deleteLink	DELETE /link	Delete a link
LinksApi	getLinkTypes	GET /linkTypes	Get the link types
LinksApi	linkElement	POST /link	Link two elements
ThemesApi	createTheme	POST /theme	Create a new theme
ThemesApi	getElementTypeColorsOfTheme	GET /theme/elementTypeColors	Get all element type colors of a theme
ThemesApi	getTheme	GET /theme	Get a theme
ThemesApi	getThemesOfDocument	GET /document/themes	Get all themes of a document
ThemesApi	updateTheme	PATCH /theme	Update a theme
UserManagementApi	changeUser	PATCH /user/change	Change user
UserManagementApi	deleteUser	DELETE /user/delete	Delete user
UserManagementApi	getInfo	GET /user/info	Get info of user
UserManagementApi	getUsers	GET /user	Get all users
UserManagementApi	login	GET /user/login	Login
UserManagementApi	logout	GET /user/logout	Logout
UserManagementApi	register	POST /user/register	Register
WorkspacesApi	addAccessGroupToWorkspace	POST /workspace/accessgroups	Add an access group to a workspace
WorkspacesApi	addUserToWorkspace	POST /workspace/users	Add a user to a workspace
WorkspacesApi	deleteAccessGroupOfWorkspace	DELETE /workspace/accessgroups	Delete a workspace
WorkspacesApi	deleteUserOfWorkspace	DELETE /workspace/users	Delete a user of a workspace
WorkspacesApi	deleteWorkspace	DELETE /workspace	Delete a workspace
WorkspacesApi	getAccessGroupsOfWorkspace	GET /workspace/accessgroups	Get all access groups of a given workspace
WorkspacesApi	getUsersOfWorkspace	GET /workspace/users	Get all users of a given workspace
WorkspacesApi	getWorkspace	GET /workspace	Get a workspace
WorkspacesApi	getWorkspaces	GET /workspaces	Get all workspaces
WorkspacesApi	patchAccessGroupOfWorkspace	PATCH /workspace/accessgroups	Update an access group of a workspace
WorkspacesApi	patchUserOfWorkspace	PATCH /workspace/users	Update a user of a workspace
WorkspacesApi	patchWorkspace	PATCH /workspace	Update a workspace
WorkspacesApi	postWorkspace	POST /workspace	Add a workspace

Documentation For Models

• RQMAccessGroup
• RQMDocument
• RQMElement
• RQMElementType
• RQMElementTypeColor
• RQMLink
• RQMLinkType
• RQMTemplate
• RQMTheme
• RQMToken
• RQMUser
• RQMWorkspace
• RQMWorkspaceAccessgroup
• RQMWorkspaceUser

Documentation For Authorization

APIKeyHeader

• Type: API key
• API key parameter name: token
• Location: HTTP header

Author