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

ClassMethodHTTP requestDescription
AccessGroupsApiaddAccessgroupPOST /accessgroupAdd an access group
AccessGroupsApiaddUserToAccessGroupPOST /accessgroup/usersAdd a user to an access group
AccessGroupsApideleteAccessgroupDELETE /accessgroupDelete an access group
AccessGroupsApideleteUserOfAccessGroupDELETE /accessgroup/usersDelete a user of an access group
AccessGroupsApigetAccessgroupGET /accessgroupGet a specific access group
AccessGroupsApigetAccessgroupsGET /accessgroupsGet all access groups
AccessGroupsApigetUsersOfAccessGroupGET /accessgroup/usersGet all users of a given access group
AccessGroupsApipatchAccessgroupPATCH /accessgroupUpdate an access group
DocumentsApideleteDocumentDELETE /documentDelete a document
DocumentsApigetDocumentGET /documentGet a document
DocumentsApigetDocumentsGET /documentsGet all documents
DocumentsApigetLinksOfDocumentGET /document/linksGet all links of a document
DocumentsApipatchDocumentPATCH /documentUpdate a document
DocumentsApipostDocumentPOST /documentAdd a document
ElementsApideleteElementDELETE /elementDelete an element
ElementsApigetElementTypesGET /elementTypesGet all element types
ElementsApigetElementsGET /elementsGet all elements
ElementsApigetIncomingLinksOfElementGET /element/inlinksGet all links of a given element
ElementsApigetOutgoingLinksOfElementGET /element/outlinksGet all links of a given element
ElementsApipatchElementPATCH /elementUpdate an element
ElementsApipostElementPOST /elementAdd an element
ExportApiexportMarkdownGET /export/markdownExport a document as Markdown
ExportApiexportPdfGET /export/pdfExport a document as PDF
ExportApiexportRawGET /export/openrqmExport a document as OpenRQM Data for import
ExportApigetMarkdownTemplatesGET /export/markdown/templatesGet all Markdown templates
ExportApigetPdfTemplatesGET /export/pdf/templatesGet all PDF templates
ImportApiimportDocumentPOST /importPost document for import
LinksApideleteLinkDELETE /linkDelete a link
LinksApigetLinkTypesGET /linkTypesGet the link types
LinksApilinkElementPOST /linkLink two elements
ThemesApicreateThemePOST /themeCreate a new theme
ThemesApigetElementTypeColorsOfThemeGET /theme/elementTypeColorsGet all element type colors of a theme
ThemesApigetThemeGET /themeGet a theme
ThemesApigetThemesOfDocumentGET /document/themesGet all themes of a document
ThemesApiupdateThemePATCH /themeUpdate a theme
UserManagementApichangeUserPATCH /user/changeChange user
UserManagementApideleteUserDELETE /user/deleteDelete user
UserManagementApigetInfoGET /user/infoGet info of user
UserManagementApigetUsersGET /userGet all users
UserManagementApiloginGET /user/loginLogin
UserManagementApilogoutGET /user/logoutLogout
UserManagementApiregisterPOST /user/registerRegister
WorkspacesApiaddAccessGroupToWorkspacePOST /workspace/accessgroupsAdd an access group to a workspace
WorkspacesApiaddUserToWorkspacePOST /workspace/usersAdd a user to a workspace
WorkspacesApideleteAccessGroupOfWorkspaceDELETE /workspace/accessgroupsDelete a workspace
WorkspacesApideleteUserOfWorkspaceDELETE /workspace/usersDelete a user of a workspace
WorkspacesApideleteWorkspaceDELETE /workspaceDelete a workspace
WorkspacesApigetAccessGroupsOfWorkspaceGET /workspace/accessgroupsGet all access groups of a given workspace
WorkspacesApigetUsersOfWorkspaceGET /workspace/usersGet all users of a given workspace
WorkspacesApigetWorkspaceGET /workspaceGet a workspace
WorkspacesApigetWorkspacesGET /workspacesGet all workspaces
WorkspacesApipatchAccessGroupOfWorkspacePATCH /workspace/accessgroupsUpdate an access group of a workspace
WorkspacesApipatchUserOfWorkspacePATCH /workspace/usersUpdate a user of a workspace
WorkspacesApipatchWorkspacePATCH /workspaceUpdate a workspace
WorkspacesApipostWorkspacePOST /workspaceAdd a workspace

Documentation For Models

Documentation For Authorization

APIKeyHeader

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

Author

Libraries

openrqm.api