mirror of
https://github.com/gosticks/open-project-flutter-api.git
synced 2025-10-16 11:55:34 +00:00
first commit
This commit is contained in:
Wlad Meixner
commit
4a3123aa74
808
README.md
Normal file
808
README.md
Normal file
@ -0,0 +1,808 @@
|
||||
# openapi
|
||||
You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current
|
||||
development version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3).
|
||||
|
||||
## Introduction
|
||||
|
||||
The documentation for the APIv3 is written according to the [OpenAPI 3.0 Specification](https://swagger.io/specification/).
|
||||
You can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/)
|
||||
or the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md),
|
||||
in your OpenProject installation under `/api/docs`.
|
||||
In the latter you can try out the various API endpoints directly interacting with our OpenProject data.
|
||||
Moreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml`
|
||||
(e.g. [here](https://community.openproject.org/api/v3/spec.yml)).
|
||||
|
||||
The APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS).
|
||||
This means that each endpoint of this API will have links to other resources or actions defined in the resulting body.
|
||||
|
||||
These related resources and actions for any given resource will be context sensitive. For example, only actions that the
|
||||
authenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any
|
||||
given response.
|
||||
|
||||
As an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only
|
||||
be present when the user you authenticated has been granted a permission to update the work package in the assigned project.
|
||||
|
||||
## HAL+JSON
|
||||
|
||||
HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.
|
||||
Read more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08)
|
||||
|
||||
**OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties:
|
||||
|
||||
- `_type` - specifies the type of the resource (e.g.: WorkPackage, Project)
|
||||
- `_links` - contains all related resource and action links available for the resource
|
||||
- `_embedded` - contains all embedded objects
|
||||
|
||||
HAL does not guarantee that embedded resources are embedded in their full representation, they might as well be
|
||||
partially represented (e.g. some properties can be left out).
|
||||
However in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**.
|
||||
|
||||
## API response structure
|
||||
|
||||
All API responses contain a single HAL+JSON object, even collections of objects are technically represented by
|
||||
a single HAL+JSON object that itself contains its members. More details on collections can be found
|
||||
in the [Collections Section](https://www.openproject.org/docs/api/collections/).
|
||||
|
||||
## Authentication
|
||||
|
||||
The API supports the following authentication schemes: OAuth2, session based authentication, and basic auth.
|
||||
|
||||
Depending on the settings of the OpenProject instance many resources can be accessed without being authenticated.
|
||||
In case the instance requires authentication on all requests the client will receive an **HTTP 401** status code
|
||||
in response to any request.
|
||||
|
||||
Otherwise unauthenticated clients have all the permissions of the anonymous user.
|
||||
|
||||
### Session-based Authentication
|
||||
|
||||
This means you have to login to OpenProject via the Web-Interface to be authenticated in the API.
|
||||
This method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.
|
||||
|
||||
In this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication.
|
||||
|
||||
### API Key through Basic Auth
|
||||
|
||||
Users can authenticate towards the API v3 using basic auth with the user name `apikey` (NOT your login) and the API key as the password.
|
||||
Users can find their API key on their account page.
|
||||
|
||||
Example:
|
||||
|
||||
```shell
|
||||
API_KEY=2519132cdf62dcf5a66fd96394672079f9e9cad1
|
||||
curl -u apikey:$API_KEY https://community.openproject.com/api/v3/users/42
|
||||
```
|
||||
|
||||
### OAuth2.0 authentication
|
||||
|
||||
OpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes.
|
||||
|
||||
To get started, you first need to register an application in the OpenProject OAuth administration section of your installation.
|
||||
This will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`).
|
||||
|
||||
You can then use one the following guides to perform the supported OAuth 2.0 flows:
|
||||
|
||||
- [Authorization code flow](https://oauth.net/2/grant-types/authorization-code)
|
||||
|
||||
- [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential.
|
||||
|
||||
- [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access
|
||||
|
||||
### Why not username and password?
|
||||
|
||||
The simplest way to do basic auth would be to use a user's username and password naturally.
|
||||
However, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.
|
||||
|
||||
Using **username and password** directly would have some advantages:
|
||||
|
||||
* It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.
|
||||
|
||||
* No extra logic for token management necessary.
|
||||
|
||||
On the other hand using **API keys** has some advantages too, which is why we went for that:
|
||||
|
||||
* If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.
|
||||
|
||||
* They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.
|
||||
|
||||
Most importantly users may not actually have a password to begin with. Specifically when they have registered
|
||||
through an OpenID Connect provider.
|
||||
|
||||
## Cross-Origin Resource Sharing (CORS)
|
||||
|
||||
By default, the OpenProject API is _not_ responding with any CORS headers.
|
||||
If you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.
|
||||
|
||||
Please see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on
|
||||
how to selectively enable CORS.
|
||||
|
||||
## Allowed HTTP methods
|
||||
|
||||
- `GET` - Get a single resource or collection of resources
|
||||
|
||||
- `POST` - Create a new resource or perform
|
||||
|
||||
- `PATCH` - Update a resource
|
||||
|
||||
- `DELETE` - Delete a resource
|
||||
|
||||
## Compression
|
||||
|
||||
Responses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951)
|
||||
are supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).
|
||||
If no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed.
|
||||
|
||||
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
||||
|
||||
- API version: 3
|
||||
- Build package: org.openapitools.codegen.languages.DartClientCodegen
|
||||
|
||||
## Requirements
|
||||
|
||||
Dart 2.12 or later
|
||||
|
||||
## Installation & Usage
|
||||
|
||||
### Github
|
||||
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
|
||||
```
|
||||
dependencies:
|
||||
openapi:
|
||||
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:
|
||||
openapi:
|
||||
path: /path/to/openapi
|
||||
```
|
||||
|
||||
## Tests
|
||||
|
||||
TODO
|
||||
|
||||
## Getting Started
|
||||
|
||||
Please follow the [installation procedure](#installation--usage) and then run the following:
|
||||
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActionsCapabilitiesApi();
|
||||
final filters = [{ "id": { "operator": "=", "values": ["memberships/create"] }" }]; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are: + id: Returns only the action having the id or all actions except those having the id(s).
|
||||
final sortBy = [["id", "asc"]]; // String | JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + *No sort supported yet*
|
||||
|
||||
try {
|
||||
final result = api_instance.listActions(filters, sortBy);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActionsCapabilitiesApi->listActions: $e\n');
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*ActionsCapabilitiesApi* | [**listActions**](doc//ActionsCapabilitiesApi.md#listactions) | **GET** /api/v3/actions | List actions
|
||||
*ActionsCapabilitiesApi* | [**listCapabilities**](doc//ActionsCapabilitiesApi.md#listcapabilities) | **GET** /api/v3/capabilities | List capabilities
|
||||
*ActionsCapabilitiesApi* | [**viewAction**](doc//ActionsCapabilitiesApi.md#viewaction) | **GET** /api/v3/actions/{id} | View action
|
||||
*ActionsCapabilitiesApi* | [**viewCapabilities**](doc//ActionsCapabilitiesApi.md#viewcapabilities) | **GET** /api/v3/capabilities/{id} | View capabilities
|
||||
*ActionsCapabilitiesApi* | [**viewGlobalContext**](doc//ActionsCapabilitiesApi.md#viewglobalcontext) | **GET** /api/v3/capabilities/context/global | View global context
|
||||
*ActivitiesApi* | [**updateActivity**](doc//ActivitiesApi.md#updateactivity) | **PATCH** /api/v3/activities/{id} | Update activity
|
||||
*ActivitiesApi* | [**viewActivity**](doc//ActivitiesApi.md#viewactivity) | **GET** /api/v3/activities/{id} | View activity
|
||||
*AttachmentsApi* | [**addAttachmentToPost**](doc//AttachmentsApi.md#addattachmenttopost) | **POST** /api/v3/posts/{id}/attachments | Add attachment to post
|
||||
*AttachmentsApi* | [**addAttachmentToWikiPage**](doc//AttachmentsApi.md#addattachmenttowikipage) | **POST** /api/v3/wiki_pages/{id}/attachments | Add attachment to wiki page
|
||||
*AttachmentsApi* | [**createAttachment**](doc//AttachmentsApi.md#createattachment) | **POST** /api/v3/attachments | Create Attachment
|
||||
*AttachmentsApi* | [**createWorkPackageAttachment**](doc//AttachmentsApi.md#createworkpackageattachment) | **POST** /api/v3/work_packages/{id}/attachments | Create work package attachment
|
||||
*AttachmentsApi* | [**deleteAttachment**](doc//AttachmentsApi.md#deleteattachment) | **DELETE** /api/v3/attachments/{id} | Delete attachment
|
||||
*AttachmentsApi* | [**listAttachmentsByPost**](doc//AttachmentsApi.md#listattachmentsbypost) | **GET** /api/v3/posts/{id}/attachments | List attachments by post
|
||||
*AttachmentsApi* | [**listAttachmentsByWikiPage**](doc//AttachmentsApi.md#listattachmentsbywikipage) | **GET** /api/v3/wiki_pages/{id}/attachments | List attachments by wiki page
|
||||
*AttachmentsApi* | [**listWorkPackageAttachments**](doc//AttachmentsApi.md#listworkpackageattachments) | **GET** /api/v3/work_packages/{id}/attachments | List attachments by work package
|
||||
*AttachmentsApi* | [**viewAttachment**](doc//AttachmentsApi.md#viewattachment) | **GET** /api/v3/attachments/{id} | View attachment
|
||||
*BudgetsApi* | [**viewBudget**](doc//BudgetsApi.md#viewbudget) | **GET** /api/v3/budgets/{id} | view Budget
|
||||
*BudgetsApi* | [**viewBudgetsOfAProject**](doc//BudgetsApi.md#viewbudgetsofaproject) | **GET** /api/v3/projects/{id}/budgets | view Budgets of a Project
|
||||
*CategoriesApi* | [**listCategoriesOfAProject**](doc//CategoriesApi.md#listcategoriesofaproject) | **GET** /api/v3/projects/{id}/categories | List categories of a project
|
||||
*CategoriesApi* | [**viewCategory**](doc//CategoriesApi.md#viewcategory) | **GET** /api/v3/categories/{id} | View Category
|
||||
*CollectionsApi* | [**viewAggregatedResult**](doc//CollectionsApi.md#viewaggregatedresult) | **GET** /api/v3/examples | view aggregated result
|
||||
*ConfigurationApi* | [**viewConfiguration**](doc//ConfigurationApi.md#viewconfiguration) | **GET** /api/v3/configuration | View configuration
|
||||
*CustomActionsApi* | [**executeCustomAction**](doc//CustomActionsApi.md#executecustomaction) | **POST** /api/v3/custom_actions/{id}/execute | Execute custom action
|
||||
*CustomActionsApi* | [**getCustomAction**](doc//CustomActionsApi.md#getcustomaction) | **GET** /api/v3/custom_actions/{id} | Get a custom action
|
||||
*CustomOptionsApi* | [**viewCustomOption**](doc//CustomOptionsApi.md#viewcustomoption) | **GET** /api/v3/custom_options/{id} | View Custom Option
|
||||
*DocumentsApi* | [**listDocuments**](doc//DocumentsApi.md#listdocuments) | **GET** /api/v3/documents | List Documents
|
||||
*DocumentsApi* | [**viewDocument**](doc//DocumentsApi.md#viewdocument) | **GET** /api/v3/documents/{id} | View document
|
||||
*FileLinksApi* | [**createStorage**](doc//FileLinksApi.md#createstorage) | **POST** /api/v3/storages | Creates a storage.
|
||||
*FileLinksApi* | [**createStorageOauthCredentials**](doc//FileLinksApi.md#createstorageoauthcredentials) | **POST** /api/v3/storages/{id}/oauth_client_credentials | Creates an oauth client credentials object for a storage.
|
||||
*FileLinksApi* | [**createWorkPackageFileLink**](doc//FileLinksApi.md#createworkpackagefilelink) | **POST** /api/v3/work_packages/{id}/file_links | Creates file links.
|
||||
*FileLinksApi* | [**deleteFileLink**](doc//FileLinksApi.md#deletefilelink) | **DELETE** /api/v3/file_links/{id} | Removes a file link.
|
||||
*FileLinksApi* | [**deleteStorage**](doc//FileLinksApi.md#deletestorage) | **DELETE** /api/v3/storages/{id} | Delete a storage
|
||||
*FileLinksApi* | [**downloadFileLink**](doc//FileLinksApi.md#downloadfilelink) | **GET** /api/v3/file_links/{id}/download | Creates a download uri of the linked file.
|
||||
*FileLinksApi* | [**getProjectStorage**](doc//FileLinksApi.md#getprojectstorage) | **GET** /api/v3/project_storages/{id} | Gets a project storage
|
||||
*FileLinksApi* | [**getStorage**](doc//FileLinksApi.md#getstorage) | **GET** /api/v3/storages/{id} | Get a storage
|
||||
*FileLinksApi* | [**getStorageFiles**](doc//FileLinksApi.md#getstoragefiles) | **GET** /api/v3/storages/{id}/files | Gets files of a storage.
|
||||
*FileLinksApi* | [**listProjectStorages**](doc//FileLinksApi.md#listprojectstorages) | **GET** /api/v3/project_storages | Gets a list of project storages
|
||||
*FileLinksApi* | [**listWorkPackageFileLinks**](doc//FileLinksApi.md#listworkpackagefilelinks) | **GET** /api/v3/work_packages/{id}/file_links | Gets all file links of a work package
|
||||
*FileLinksApi* | [**openFileLink**](doc//FileLinksApi.md#openfilelink) | **GET** /api/v3/file_links/{id}/open | Creates an opening uri of the linked file.
|
||||
*FileLinksApi* | [**prepareStorageFileUpload**](doc//FileLinksApi.md#preparestoragefileupload) | **POST** /api/v3/storages/{id}/files/prepare_upload | Preparation of a direct upload of a file to the given storage.
|
||||
*FileLinksApi* | [**updateStorage**](doc//FileLinksApi.md#updatestorage) | **PATCH** /api/v3/storages/{id} | Update a storage
|
||||
*FileLinksApi* | [**viewFileLink**](doc//FileLinksApi.md#viewfilelink) | **GET** /api/v3/file_links/{id} | Gets a file link.
|
||||
*FormsApi* | [**showOrValidateForm**](doc//FormsApi.md#showorvalidateform) | **POST** /api/v3/example/form | show or validate form
|
||||
*GridsApi* | [**createGrid**](doc//GridsApi.md#creategrid) | **POST** /api/v3/grids | Create a grid
|
||||
*GridsApi* | [**getGrid**](doc//GridsApi.md#getgrid) | **GET** /api/v3/grids/{id} | Get a grid
|
||||
*GridsApi* | [**gridCreateForm**](doc//GridsApi.md#gridcreateform) | **POST** /api/v3/grids/form | Grid Create Form
|
||||
*GridsApi* | [**gridUpdateForm**](doc//GridsApi.md#gridupdateform) | **POST** /api/v3/grids/{id}/form | Grid Update Form
|
||||
*GridsApi* | [**listGrids**](doc//GridsApi.md#listgrids) | **GET** /api/v3/grids | List grids
|
||||
*GridsApi* | [**updateGrid**](doc//GridsApi.md#updategrid) | **PATCH** /api/v3/grids/{id} | Update a grid
|
||||
*GroupsApi* | [**createGroup**](doc//GroupsApi.md#creategroup) | **POST** /api/v3/groups | Create group
|
||||
*GroupsApi* | [**deleteGroup**](doc//GroupsApi.md#deletegroup) | **DELETE** /api/v3/groups/{id} | Delete group
|
||||
*GroupsApi* | [**getGroup**](doc//GroupsApi.md#getgroup) | **GET** /api/v3/groups/{id} | Get group
|
||||
*GroupsApi* | [**listGroups**](doc//GroupsApi.md#listgroups) | **GET** /api/v3/groups | List groups
|
||||
*GroupsApi* | [**updateGroup**](doc//GroupsApi.md#updategroup) | **PATCH** /api/v3/groups/{id} | Update group
|
||||
*HelpTextsApi* | [**getHelpText**](doc//HelpTextsApi.md#gethelptext) | **GET** /api/v3/help_texts/{id} | Get help text
|
||||
*HelpTextsApi* | [**listHelpTexts**](doc//HelpTextsApi.md#listhelptexts) | **GET** /api/v3/help_texts | List help texts
|
||||
*MembershipsApi* | [**availableProjectsForMemberships**](doc//MembershipsApi.md#availableprojectsformemberships) | **GET** /api/v3/memberships/available_projects | Available projects for memberships
|
||||
*MembershipsApi* | [**createMembership**](doc//MembershipsApi.md#createmembership) | **POST** /api/v3/memberships | Create membership
|
||||
*MembershipsApi* | [**deleteMembership**](doc//MembershipsApi.md#deletemembership) | **DELETE** /api/v3/memberships/{id} | Delete membership
|
||||
*MembershipsApi* | [**listMemberships**](doc//MembershipsApi.md#listmemberships) | **GET** /api/v3/memberships | List memberships
|
||||
*MembershipsApi* | [**membershipCreateForm**](doc//MembershipsApi.md#membershipcreateform) | **POST** /api/v3/memberships/form | Membership create form
|
||||
*MembershipsApi* | [**membershipUpdateForm**](doc//MembershipsApi.md#membershipupdateform) | **POST** /api/v3/memberships/{id}/form | Membership update form
|
||||
*MembershipsApi* | [**updateMembership**](doc//MembershipsApi.md#updatemembership) | **PATCH** /api/v3/memberships/{id} | Update membership
|
||||
*MembershipsApi* | [**viewMembership**](doc//MembershipsApi.md#viewmembership) | **GET** /api/v3/memberships/{id} | View membership
|
||||
*MembershipsApi* | [**viewMembershipSchema**](doc//MembershipsApi.md#viewmembershipschema) | **GET** /api/v3/memberships/schema | View membership schema
|
||||
*NewsApi* | [**listNews**](doc//NewsApi.md#listnews) | **GET** /api/v3/news | List News
|
||||
*NewsApi* | [**viewNews**](doc//NewsApi.md#viewnews) | **GET** /api/v3/news/{id} | View news
|
||||
*NotificationsApi* | [**listNotifications**](doc//NotificationsApi.md#listnotifications) | **GET** /api/v3/notifications | Get notification collection
|
||||
*NotificationsApi* | [**readNotification**](doc//NotificationsApi.md#readnotification) | **POST** /api/v3/notifications/{id}/read_ian | Read notification
|
||||
*NotificationsApi* | [**readNotifications**](doc//NotificationsApi.md#readnotifications) | **POST** /api/v3/notifications/read_ian | Read all notifications
|
||||
*NotificationsApi* | [**unreadNotification**](doc//NotificationsApi.md#unreadnotification) | **POST** /api/v3/notifications/{id}/unread_ian | Unread notification
|
||||
*NotificationsApi* | [**unreadNotifications**](doc//NotificationsApi.md#unreadnotifications) | **POST** /api/v3/notifications/unread_ian | Unread all notifications
|
||||
*NotificationsApi* | [**viewNotification**](doc//NotificationsApi.md#viewnotification) | **GET** /api/v3/notifications/{id} | Get the notification
|
||||
*NotificationsApi* | [**viewNotificationDetail**](doc//NotificationsApi.md#viewnotificationdetail) | **GET** /api/v3/notifications/{notification_id}/details/{id} | Get a notification detail
|
||||
*OAuth2Api* | [**getOauthApplication**](doc//OAuth2Api.md#getoauthapplication) | **GET** /api/v3/oauth_applications/{id} | Get the oauth application.
|
||||
*OAuth2Api* | [**getOauthClientCredentials**](doc//OAuth2Api.md#getoauthclientcredentials) | **GET** /api/v3/oauth_client_credentials/{id} | Get the oauth client credentials object.
|
||||
*PostsApi* | [**viewPost**](doc//PostsApi.md#viewpost) | **GET** /api/v3/posts/{id} | View Post
|
||||
*PreviewingApi* | [**previewMarkdownDocument**](doc//PreviewingApi.md#previewmarkdowndocument) | **POST** /api/v3/render/markdown | Preview Markdown document
|
||||
*PreviewingApi* | [**previewPlainDocument**](doc//PreviewingApi.md#previewplaindocument) | **POST** /api/v3/render/plain | Preview plain document
|
||||
*PrincipalsApi* | [**listPrincipals**](doc//PrincipalsApi.md#listprincipals) | **GET** /api/v3/principals | List principals
|
||||
*PrioritiesApi* | [**listAllPriorities**](doc//PrioritiesApi.md#listallpriorities) | **GET** /api/v3/priorities | List all Priorities
|
||||
*PrioritiesApi* | [**viewPriority**](doc//PrioritiesApi.md#viewpriority) | **GET** /api/v3/priorities/{id} | View Priority
|
||||
*ProjectsApi* | [**createProject**](doc//ProjectsApi.md#createproject) | **POST** /api/v3/projects | Create project
|
||||
*ProjectsApi* | [**createProjectCopy**](doc//ProjectsApi.md#createprojectcopy) | **POST** /api/v3/projects/{id}/copy | Create project copy
|
||||
*ProjectsApi* | [**deleteProject**](doc//ProjectsApi.md#deleteproject) | **DELETE** /api/v3/projects/{id} | Delete Project
|
||||
*ProjectsApi* | [**listAvailableParentProjectCandidates**](doc//ProjectsApi.md#listavailableparentprojectcandidates) | **GET** /api/v3/projects/available_parent_projects | List available parent project candidates
|
||||
*ProjectsApi* | [**listProjects**](doc//ProjectsApi.md#listprojects) | **GET** /api/v3/projects | List projects
|
||||
*ProjectsApi* | [**listProjectsWithVersion**](doc//ProjectsApi.md#listprojectswithversion) | **GET** /api/v3/versions/{id}/projects | List projects having version
|
||||
*ProjectsApi* | [**projectCopyForm**](doc//ProjectsApi.md#projectcopyform) | **POST** /api/v3/projects/{id}/copy/form | Project copy form
|
||||
*ProjectsApi* | [**projectCreateForm**](doc//ProjectsApi.md#projectcreateform) | **POST** /api/v3/projects/form | Project create form
|
||||
*ProjectsApi* | [**projectUpdateForm**](doc//ProjectsApi.md#projectupdateform) | **POST** /api/v3/projects/{id}/form | Project update form
|
||||
*ProjectsApi* | [**updateProject**](doc//ProjectsApi.md#updateproject) | **PATCH** /api/v3/projects/{id} | Update Project
|
||||
*ProjectsApi* | [**viewProject**](doc//ProjectsApi.md#viewproject) | **GET** /api/v3/projects/{id} | View project
|
||||
*ProjectsApi* | [**viewProjectSchema**](doc//ProjectsApi.md#viewprojectschema) | **GET** /api/v3/projects/schema | View project schema
|
||||
*ProjectsApi* | [**viewProjectStatus**](doc//ProjectsApi.md#viewprojectstatus) | **GET** /api/v3/project_statuses/{id} | View project status
|
||||
*QueriesApi* | [**availableProjectsForQuery**](doc//QueriesApi.md#availableprojectsforquery) | **GET** /api/v3/queries/available_projects | Available projects for query
|
||||
*QueriesApi* | [**createQuery**](doc//QueriesApi.md#createquery) | **POST** /api/v3/queries | Create query
|
||||
*QueriesApi* | [**deleteQuery**](doc//QueriesApi.md#deletequery) | **DELETE** /api/v3/queries/{id} | Delete query
|
||||
*QueriesApi* | [**editQuery**](doc//QueriesApi.md#editquery) | **PATCH** /api/v3/queries/{id} | Edit Query
|
||||
*QueriesApi* | [**listQueries**](doc//QueriesApi.md#listqueries) | **GET** /api/v3/queries | List queries
|
||||
*QueriesApi* | [**queryCreateForm**](doc//QueriesApi.md#querycreateform) | **POST** /api/v3/queries/form | Query Create Form
|
||||
*QueriesApi* | [**queryUpdateForm**](doc//QueriesApi.md#queryupdateform) | **POST** /api/v3/queries/{id}/form | Query Update Form
|
||||
*QueriesApi* | [**starQuery**](doc//QueriesApi.md#starquery) | **PATCH** /api/v3/queries/{id}/star | Star query
|
||||
*QueriesApi* | [**unstarQuery**](doc//QueriesApi.md#unstarquery) | **PATCH** /api/v3/queries/{id}/unstar | Unstar query
|
||||
*QueriesApi* | [**viewDefaultQuery**](doc//QueriesApi.md#viewdefaultquery) | **GET** /api/v3/queries/default | View default query
|
||||
*QueriesApi* | [**viewDefaultQueryForProject**](doc//QueriesApi.md#viewdefaultqueryforproject) | **GET** /api/v3/projects/{id}/queries/default | View default query for project
|
||||
*QueriesApi* | [**viewQuery**](doc//QueriesApi.md#viewquery) | **GET** /api/v3/queries/{id} | View query
|
||||
*QueriesApi* | [**viewSchemaForGlobalQueries**](doc//QueriesApi.md#viewschemaforglobalqueries) | **GET** /api/v3/queries/schema | View schema for global queries
|
||||
*QueriesApi* | [**viewSchemaForProjectQueries**](doc//QueriesApi.md#viewschemaforprojectqueries) | **GET** /api/v3/projects/{id}/queries/schema | View schema for project queries
|
||||
*QueryColumnsApi* | [**viewQueryColumn**](doc//QueryColumnsApi.md#viewquerycolumn) | **GET** /api/v3/queries/columns/{id} | View Query Column
|
||||
*QueryFilterInstanceSchemaApi* | [**listQueryFilterInstanceSchemas**](doc//QueryFilterInstanceSchemaApi.md#listqueryfilterinstanceschemas) | **GET** /api/v3/queries/filter_instance_schemas | List Query Filter Instance Schemas
|
||||
*QueryFilterInstanceSchemaApi* | [**listQueryFilterInstanceSchemasForProject**](doc//QueryFilterInstanceSchemaApi.md#listqueryfilterinstanceschemasforproject) | **GET** /api/v3/projects/{id}/queries/filter_instance_schemas | List Query Filter Instance Schemas for Project
|
||||
*QueryFilterInstanceSchemaApi* | [**viewQueryFilterInstanceSchema**](doc//QueryFilterInstanceSchemaApi.md#viewqueryfilterinstanceschema) | **GET** /api/v3/queries/filter_instance_schemas/{id} | View Query Filter Instance Schema
|
||||
*QueryFiltersApi* | [**viewQueryFilter**](doc//QueryFiltersApi.md#viewqueryfilter) | **GET** /api/v3/queries/filters/{id} | View Query Filter
|
||||
*QueryOperatorsApi* | [**viewQueryOperator**](doc//QueryOperatorsApi.md#viewqueryoperator) | **GET** /api/v3/queries/operators/{id} | View Query Operator
|
||||
*QuerySortBysApi* | [**viewQuerySortBy**](doc//QuerySortBysApi.md#viewquerysortby) | **GET** /api/v3/queries/sort_bys/{id} | View Query Sort By
|
||||
*RelationsApi* | [**deleteRelation**](doc//RelationsApi.md#deleterelation) | **DELETE** /api/v3/relations/{id} | Delete Relation
|
||||
*RelationsApi* | [**editRelation**](doc//RelationsApi.md#editrelation) | **PATCH** /api/v3/relations/{id} | Edit Relation
|
||||
*RelationsApi* | [**listRelations**](doc//RelationsApi.md#listrelations) | **GET** /api/v3/relations | List Relations
|
||||
*RelationsApi* | [**relationEditForm**](doc//RelationsApi.md#relationeditform) | **POST** /api/v3/relations/{id}/form | Relation edit form
|
||||
*RelationsApi* | [**viewRelation**](doc//RelationsApi.md#viewrelation) | **GET** /api/v3/relations/{id} | View Relation
|
||||
*RelationsApi* | [**viewRelationSchema**](doc//RelationsApi.md#viewrelationschema) | **GET** /api/v3/relations/schema | View relation schema
|
||||
*RelationsApi* | [**viewRelationSchemaForType**](doc//RelationsApi.md#viewrelationschemafortype) | **GET** /api/v3/relations/schema/{type} | View relation schema for type
|
||||
*RevisionsApi* | [**viewRevision**](doc//RevisionsApi.md#viewrevision) | **GET** /api/v3/revisions/{id} | View revision
|
||||
*RolesApi* | [**listRoles**](doc//RolesApi.md#listroles) | **GET** /api/v3/roles | List roles
|
||||
*RolesApi* | [**viewRole**](doc//RolesApi.md#viewrole) | **GET** /api/v3/roles/{id} | View role
|
||||
*RootApi* | [**viewRoot**](doc//RootApi.md#viewroot) | **GET** /api/v3 | View root
|
||||
*SchemasApi* | [**viewTheSchema**](doc//SchemasApi.md#viewtheschema) | **GET** /api/v3/example/schema | view the schema
|
||||
*StatusesApi* | [**listAllStatuses**](doc//StatusesApi.md#listallstatuses) | **GET** /api/v3/statuses | List all Statuses
|
||||
*StatusesApi* | [**viewStatus**](doc//StatusesApi.md#viewstatus) | **GET** /api/v3/statuses/{id} | View Status
|
||||
*TimeEntriesApi* | [**availableProjectsForTimeEntries**](doc//TimeEntriesApi.md#availableprojectsfortimeentries) | **GET** /api/v3/time_entries/available_projects | Available projects for time entries
|
||||
*TimeEntriesApi* | [**createTimeEntry**](doc//TimeEntriesApi.md#createtimeentry) | **POST** /api/v3/time_entries | Create time entry
|
||||
*TimeEntriesApi* | [**deleteTimeEntry**](doc//TimeEntriesApi.md#deletetimeentry) | **DELETE** /api/v3/time_entries/{id} | Delete time entry
|
||||
*TimeEntriesApi* | [**getTimeEntry**](doc//TimeEntriesApi.md#gettimeentry) | **GET** /api/v3/time_entries/{id} | Get time entry
|
||||
*TimeEntriesApi* | [**listTimeEntries**](doc//TimeEntriesApi.md#listtimeentries) | **GET** /api/v3/time_entries | List time entries
|
||||
*TimeEntriesApi* | [**timeEntryCreateForm**](doc//TimeEntriesApi.md#timeentrycreateform) | **POST** /api/v3/time_entries/form | Time entry create form
|
||||
*TimeEntriesApi* | [**timeEntryUpdateForm**](doc//TimeEntriesApi.md#timeentryupdateform) | **POST** /api/v3/time_entries/{id}/form | Time entry update form
|
||||
*TimeEntriesApi* | [**updateTimeEntry**](doc//TimeEntriesApi.md#updatetimeentry) | **PATCH** /api/v3/time_entries/{id} | update time entry
|
||||
*TimeEntriesApi* | [**viewTimeEntrySchema**](doc//TimeEntriesApi.md#viewtimeentryschema) | **GET** /api/v3/time_entries/schema | View time entry schema
|
||||
*TimeEntryActivitiesApi* | [**getTimeEntriesActivity**](doc//TimeEntryActivitiesApi.md#gettimeentriesactivity) | **GET** /api/v3/time_entries/activity/{id} | View time entries activity
|
||||
*TypesApi* | [**listAllTypes**](doc//TypesApi.md#listalltypes) | **GET** /api/v3/types | List all Types
|
||||
*TypesApi* | [**listTypesAvailableInAProject**](doc//TypesApi.md#listtypesavailableinaproject) | **GET** /api/v3/projects/{id}/types | List types available in a project
|
||||
*TypesApi* | [**viewType**](doc//TypesApi.md#viewtype) | **GET** /api/v3/types/{id} | View Type
|
||||
*UserPreferencesApi* | [**showMyPreferences**](doc//UserPreferencesApi.md#showmypreferences) | **GET** /api/v3/my_preferences | Show my preferences
|
||||
*UserPreferencesApi* | [**updateUserPreferences**](doc//UserPreferencesApi.md#updateuserpreferences) | **PATCH** /api/v3/my_preferences | Update my preferences
|
||||
*UsersApi* | [**createUser**](doc//UsersApi.md#createuser) | **POST** /api/v3/users | Create User
|
||||
*UsersApi* | [**deleteUser**](doc//UsersApi.md#deleteuser) | **DELETE** /api/v3/users/{id} | Delete user
|
||||
*UsersApi* | [**listUsers**](doc//UsersApi.md#listusers) | **GET** /api/v3/users | List Users
|
||||
*UsersApi* | [**lockUser**](doc//UsersApi.md#lockuser) | **POST** /api/v3/users/{id}/lock | Lock user
|
||||
*UsersApi* | [**unlockUser**](doc//UsersApi.md#unlockuser) | **DELETE** /api/v3/users/{id}/lock | Unlock user
|
||||
*UsersApi* | [**updateUser**](doc//UsersApi.md#updateuser) | **PATCH** /api/v3/users/{id} | Update user
|
||||
*UsersApi* | [**userUpdateForm**](doc//UsersApi.md#userupdateform) | **POST** /api/v3/users/{id}/form | User update form
|
||||
*UsersApi* | [**viewUser**](doc//UsersApi.md#viewuser) | **GET** /api/v3/users/{id} | View user
|
||||
*UsersApi* | [**viewUserSchema**](doc//UsersApi.md#viewuserschema) | **GET** /api/v3/users/schema | View user schema
|
||||
*ValuesPropertyApi* | [**viewNotificationDetail**](doc//ValuesPropertyApi.md#viewnotificationdetail) | **GET** /api/v3/notifications/{notification_id}/details/{id} | Get a notification detail
|
||||
*ValuesPropertyApi* | [**viewValuesSchema**](doc//ValuesPropertyApi.md#viewvaluesschema) | **GET** /api/v3/values/schema/{id} | View Values schema
|
||||
*VersionsApi* | [**availableProjectsForVersions**](doc//VersionsApi.md#availableprojectsforversions) | **GET** /api/v3/versions/available_projects | Available projects for versions
|
||||
*VersionsApi* | [**createVersion**](doc//VersionsApi.md#createversion) | **POST** /api/v3/versions | Create version
|
||||
*VersionsApi* | [**deleteVersion**](doc//VersionsApi.md#deleteversion) | **DELETE** /api/v3/versions/{id} | Delete version
|
||||
*VersionsApi* | [**listVersions**](doc//VersionsApi.md#listversions) | **GET** /api/v3/versions | List versions
|
||||
*VersionsApi* | [**listVersionsAvailableInAProject**](doc//VersionsApi.md#listversionsavailableinaproject) | **GET** /api/v3/projects/{id}/versions | List versions available in a project
|
||||
*VersionsApi* | [**updateVersion**](doc//VersionsApi.md#updateversion) | **PATCH** /api/v3/versions/{id} | Update Version
|
||||
*VersionsApi* | [**versionCreateForm**](doc//VersionsApi.md#versioncreateform) | **POST** /api/v3/versions/form | Version create form
|
||||
*VersionsApi* | [**versionUpdateForm**](doc//VersionsApi.md#versionupdateform) | **POST** /api/v3/versions/{id}/form | Version update form
|
||||
*VersionsApi* | [**viewVersion**](doc//VersionsApi.md#viewversion) | **GET** /api/v3/versions/{id} | View version
|
||||
*VersionsApi* | [**viewVersionSchema**](doc//VersionsApi.md#viewversionschema) | **GET** /api/v3/versions/schema | View version schema
|
||||
*ViewsApi* | [**createViews**](doc//ViewsApi.md#createviews) | **POST** /api/v3/views/{id} | Create view
|
||||
*ViewsApi* | [**listViews**](doc//ViewsApi.md#listviews) | **GET** /api/v3/views | List views
|
||||
*ViewsApi* | [**viewView**](doc//ViewsApi.md#viewview) | **GET** /api/v3/views/{id} | View view
|
||||
*WikiPagesApi* | [**viewWikiPage**](doc//WikiPagesApi.md#viewwikipage) | **GET** /api/v3/wiki_pages/{id} | View Wiki Page
|
||||
*WorkPackagesApi* | [**addWatcher**](doc//WorkPackagesApi.md#addwatcher) | **POST** /api/v3/work_packages/{id}/watchers | Add watcher
|
||||
*WorkPackagesApi* | [**availableAssignees**](doc//WorkPackagesApi.md#availableassignees) | **GET** /api/v3/projects/{id}/available_assignees | Available assignees
|
||||
*WorkPackagesApi* | [**availableProjectsForWorkPackage**](doc//WorkPackagesApi.md#availableprojectsforworkpackage) | **GET** /api/v3/work_packages/{id}/available_projects | Available projects for work package
|
||||
*WorkPackagesApi* | [**availableResponsibles**](doc//WorkPackagesApi.md#availableresponsibles) | **GET** /api/v3/projects/{id}/available_responsibles | Available responsibles
|
||||
*WorkPackagesApi* | [**availableWatchers**](doc//WorkPackagesApi.md#availablewatchers) | **GET** /api/v3/work_packages/{id}/available_watchers | Available watchers
|
||||
*WorkPackagesApi* | [**commentWorkPackage**](doc//WorkPackagesApi.md#commentworkpackage) | **POST** /api/v3/work_packages/{id}/activities | Comment work package
|
||||
*WorkPackagesApi* | [**createProjectWorkPackage**](doc//WorkPackagesApi.md#createprojectworkpackage) | **POST** /api/v3/projects/{id}/work_packages | Create work package in project
|
||||
*WorkPackagesApi* | [**createRelation**](doc//WorkPackagesApi.md#createrelation) | **POST** /api/v3/work_packages/{id}/relations | Create Relation
|
||||
*WorkPackagesApi* | [**createWorkPackage**](doc//WorkPackagesApi.md#createworkpackage) | **POST** /api/v3/work_packages | Create Work Package
|
||||
*WorkPackagesApi* | [**createWorkPackageFileLink**](doc//WorkPackagesApi.md#createworkpackagefilelink) | **POST** /api/v3/work_packages/{id}/file_links | Creates file links.
|
||||
*WorkPackagesApi* | [**deleteWorkPackage**](doc//WorkPackagesApi.md#deleteworkpackage) | **DELETE** /api/v3/work_packages/{id} | Delete Work Package
|
||||
*WorkPackagesApi* | [**getProjectWorkPackageCollection**](doc//WorkPackagesApi.md#getprojectworkpackagecollection) | **GET** /api/v3/projects/{id}/work_packages | Get work packages of project
|
||||
*WorkPackagesApi* | [**listAvailableRelationCandidates**](doc//WorkPackagesApi.md#listavailablerelationcandidates) | **GET** /api/v3/work_packages/{id}/available_relation_candidates | Available relation candidates
|
||||
*WorkPackagesApi* | [**listRelations**](doc//WorkPackagesApi.md#listrelations) | **GET** /api/v3/work_packages/{id}/relations | List relations
|
||||
*WorkPackagesApi* | [**listWatchers**](doc//WorkPackagesApi.md#listwatchers) | **GET** /api/v3/work_packages/{id}/watchers | List watchers
|
||||
*WorkPackagesApi* | [**listWorkPackageActivities**](doc//WorkPackagesApi.md#listworkpackageactivities) | **GET** /api/v3/work_packages/{id}/activities | List work package activities
|
||||
*WorkPackagesApi* | [**listWorkPackageFileLinks**](doc//WorkPackagesApi.md#listworkpackagefilelinks) | **GET** /api/v3/work_packages/{id}/file_links | Gets all file links of a work package
|
||||
*WorkPackagesApi* | [**listWorkPackageSchemas**](doc//WorkPackagesApi.md#listworkpackageschemas) | **GET** /api/v3/work_packages/schemas | List Work Package Schemas
|
||||
*WorkPackagesApi* | [**listWorkPackages**](doc//WorkPackagesApi.md#listworkpackages) | **GET** /api/v3/work_packages | List work packages
|
||||
*WorkPackagesApi* | [**removeWatcher**](doc//WorkPackagesApi.md#removewatcher) | **DELETE** /api/v3/work_packages/{id}/watchers/{user_id} | Remove watcher
|
||||
*WorkPackagesApi* | [**revisions**](doc//WorkPackagesApi.md#revisions) | **GET** /api/v3/work_packages/{id}/revisions | Revisions
|
||||
*WorkPackagesApi* | [**updateWorkPackage**](doc//WorkPackagesApi.md#updateworkpackage) | **PATCH** /api/v3/work_packages/{id} | Update a Work Package
|
||||
*WorkPackagesApi* | [**viewWorkPackage**](doc//WorkPackagesApi.md#viewworkpackage) | **GET** /api/v3/work_packages/{id} | View Work Package
|
||||
*WorkPackagesApi* | [**viewWorkPackageSchema**](doc//WorkPackagesApi.md#viewworkpackageschema) | **GET** /api/v3/work_packages/schemas/{identifier} | View Work Package Schema
|
||||
*WorkPackagesApi* | [**workPackageCreateForm**](doc//WorkPackagesApi.md#workpackagecreateform) | **POST** /api/v3/work_packages/form | Work Package Create Form
|
||||
*WorkPackagesApi* | [**workPackageCreateFormForProject**](doc//WorkPackagesApi.md#workpackagecreateformforproject) | **POST** /api/v3/projects/{id}/work_packages/form | Work Package Create Form For Project
|
||||
*WorkPackagesApi* | [**workPackageEditForm**](doc//WorkPackagesApi.md#workpackageeditform) | **POST** /api/v3/work_packages/{id}/form | Work Package Edit Form
|
||||
*WorkScheduleApi* | [**createNonWorkingDay**](doc//WorkScheduleApi.md#createnonworkingday) | **POST** /api/v3/days/non_working | Creates a non-working day (NOT IMPLEMENTED)
|
||||
*WorkScheduleApi* | [**deleteNonWorkingDay**](doc//WorkScheduleApi.md#deletenonworkingday) | **DELETE** /api/v3/days/non_working/{date} | Removes a non-working day (NOT IMPLEMENTED)
|
||||
*WorkScheduleApi* | [**listDays**](doc//WorkScheduleApi.md#listdays) | **GET** /api/v3/days | Lists days
|
||||
*WorkScheduleApi* | [**listNonWorkingDays**](doc//WorkScheduleApi.md#listnonworkingdays) | **GET** /api/v3/days/non_working | Lists all non working days
|
||||
*WorkScheduleApi* | [**listWeekDays**](doc//WorkScheduleApi.md#listweekdays) | **GET** /api/v3/days/week | Lists week days
|
||||
*WorkScheduleApi* | [**updateNonWorkingDay**](doc//WorkScheduleApi.md#updatenonworkingday) | **PATCH** /api/v3/days/non_working/{date} | Update a non-working day attributes (NOT IMPLEMENTED)
|
||||
*WorkScheduleApi* | [**updateWeekDay**](doc//WorkScheduleApi.md#updateweekday) | **PATCH** /api/v3/days/week/{day} | Update a week day attributes (NOT IMPLEMENTED)
|
||||
*WorkScheduleApi* | [**updateWeekDays**](doc//WorkScheduleApi.md#updateweekdays) | **PATCH** /api/v3/days/week | Update week days (NOT IMPLEMENTED)
|
||||
*WorkScheduleApi* | [**viewDay**](doc//WorkScheduleApi.md#viewday) | **GET** /api/v3/days/{date} | View day
|
||||
*WorkScheduleApi* | [**viewNonWorkingDay**](doc//WorkScheduleApi.md#viewnonworkingday) | **GET** /api/v3/days/non_working/{date} | View a non-working day
|
||||
*WorkScheduleApi* | [**viewWeekDay**](doc//WorkScheduleApi.md#viewweekday) | **GET** /api/v3/days/week/{day} | View a week day
|
||||
|
||||
|
||||
## Documentation For Models
|
||||
|
||||
- [ActivityModel](doc//ActivityModel.md)
|
||||
- [ActivityModelComment](doc//ActivityModelComment.md)
|
||||
- [AddWatcherRequest](doc//AddWatcherRequest.md)
|
||||
- [AttachmentModel](doc//AttachmentModel.md)
|
||||
- [AttachmentModelDescription](doc//AttachmentModelDescription.md)
|
||||
- [AttachmentModelLinks](doc//AttachmentModelLinks.md)
|
||||
- [AttachmentModelLinksAuthor](doc//AttachmentModelLinksAuthor.md)
|
||||
- [AttachmentModelLinksContainer](doc//AttachmentModelLinksContainer.md)
|
||||
- [AttachmentModelLinksDelete](doc//AttachmentModelLinksDelete.md)
|
||||
- [AttachmentModelLinksDownloadLocation](doc//AttachmentModelLinksDownloadLocation.md)
|
||||
- [AttachmentModelLinksSelf](doc//AttachmentModelLinksSelf.md)
|
||||
- [AttachmentsModel](doc//AttachmentsModel.md)
|
||||
- [AttachmentsModelAllOfEmbedded](doc//AttachmentsModelAllOfEmbedded.md)
|
||||
- [AttachmentsModelAllOfEmbeddedElementsInner](doc//AttachmentsModelAllOfEmbeddedElementsInner.md)
|
||||
- [AttachmentsModelAllOfLinks](doc//AttachmentsModelAllOfLinks.md)
|
||||
- [AttachmentsModelAllOfLinksSelf](doc//AttachmentsModelAllOfLinksSelf.md)
|
||||
- [BudgetModel](doc//BudgetModel.md)
|
||||
- [BudgetModelLinks](doc//BudgetModelLinks.md)
|
||||
- [BudgetModelLinksSelf](doc//BudgetModelLinksSelf.md)
|
||||
- [CategoryModel](doc//CategoryModel.md)
|
||||
- [CategoryModelLinks](doc//CategoryModelLinks.md)
|
||||
- [CategoryModelLinksDefaultAssignee](doc//CategoryModelLinksDefaultAssignee.md)
|
||||
- [CategoryModelLinksProject](doc//CategoryModelLinksProject.md)
|
||||
- [CategoryModelLinksSelf](doc//CategoryModelLinksSelf.md)
|
||||
- [CollectionModel](doc//CollectionModel.md)
|
||||
- [CollectionModelLinks](doc//CollectionModelLinks.md)
|
||||
- [CollectionModelLinksSelf](doc//CollectionModelLinksSelf.md)
|
||||
- [CommentWorkPackageRequest](doc//CommentWorkPackageRequest.md)
|
||||
- [ConfigurationModel](doc//ConfigurationModel.md)
|
||||
- [CreateViewsRequest](doc//CreateViewsRequest.md)
|
||||
- [CreateViewsRequestLinks](doc//CreateViewsRequestLinks.md)
|
||||
- [CreateViewsRequestLinksQuery](doc//CreateViewsRequestLinksQuery.md)
|
||||
- [CustomActionModel](doc//CustomActionModel.md)
|
||||
- [CustomActionModelLinks](doc//CustomActionModelLinks.md)
|
||||
- [CustomActionModelLinksExecuteImmediately](doc//CustomActionModelLinksExecuteImmediately.md)
|
||||
- [CustomActionModelLinksSelf](doc//CustomActionModelLinksSelf.md)
|
||||
- [CustomOptionModel](doc//CustomOptionModel.md)
|
||||
- [CustomOptionModelLinks](doc//CustomOptionModelLinks.md)
|
||||
- [CustomOptionModelLinksSelf](doc//CustomOptionModelLinksSelf.md)
|
||||
- [DayCollectionModel](doc//DayCollectionModel.md)
|
||||
- [DayCollectionModelAllOfEmbedded](doc//DayCollectionModelAllOfEmbedded.md)
|
||||
- [DayCollectionModelAllOfLinks](doc//DayCollectionModelAllOfLinks.md)
|
||||
- [DayCollectionModelAllOfLinksSelf](doc//DayCollectionModelAllOfLinksSelf.md)
|
||||
- [DayModel](doc//DayModel.md)
|
||||
- [DayModelLinks](doc//DayModelLinks.md)
|
||||
- [DayModelLinksWeekDay](doc//DayModelLinksWeekDay.md)
|
||||
- [DocumentModel](doc//DocumentModel.md)
|
||||
- [DocumentModelLinks](doc//DocumentModelLinks.md)
|
||||
- [DocumentModelLinksAttachments](doc//DocumentModelLinksAttachments.md)
|
||||
- [DocumentModelLinksProject](doc//DocumentModelLinksProject.md)
|
||||
- [DocumentModelLinksSelf](doc//DocumentModelLinksSelf.md)
|
||||
- [ErrorResponse](doc//ErrorResponse.md)
|
||||
- [ErrorResponseEmbedded](doc//ErrorResponseEmbedded.md)
|
||||
- [ErrorResponseEmbeddedDetails](doc//ErrorResponseEmbeddedDetails.md)
|
||||
- [ExecuteCustomActionRequest](doc//ExecuteCustomActionRequest.md)
|
||||
- [ExecuteCustomActionRequestLinks](doc//ExecuteCustomActionRequestLinks.md)
|
||||
- [ExecuteCustomActionRequestLinksWorkPackage](doc//ExecuteCustomActionRequestLinksWorkPackage.md)
|
||||
- [FileLinkCollectionReadModel](doc//FileLinkCollectionReadModel.md)
|
||||
- [FileLinkCollectionReadModelAllOfEmbedded](doc//FileLinkCollectionReadModelAllOfEmbedded.md)
|
||||
- [FileLinkCollectionReadModelAllOfLinks](doc//FileLinkCollectionReadModelAllOfLinks.md)
|
||||
- [FileLinkCollectionReadModelAllOfLinksSelf](doc//FileLinkCollectionReadModelAllOfLinksSelf.md)
|
||||
- [FileLinkCollectionWriteModel](doc//FileLinkCollectionWriteModel.md)
|
||||
- [FileLinkCollectionWriteModelAllOfEmbedded](doc//FileLinkCollectionWriteModelAllOfEmbedded.md)
|
||||
- [FileLinkOriginDataModel](doc//FileLinkOriginDataModel.md)
|
||||
- [FileLinkReadModel](doc//FileLinkReadModel.md)
|
||||
- [FileLinkReadModelEmbedded](doc//FileLinkReadModelEmbedded.md)
|
||||
- [FileLinkReadModelLinks](doc//FileLinkReadModelLinks.md)
|
||||
- [FileLinkReadModelLinksContainer](doc//FileLinkReadModelLinksContainer.md)
|
||||
- [FileLinkReadModelLinksCreator](doc//FileLinkReadModelLinksCreator.md)
|
||||
- [FileLinkReadModelLinksDelete](doc//FileLinkReadModelLinksDelete.md)
|
||||
- [FileLinkReadModelLinksOriginOpen](doc//FileLinkReadModelLinksOriginOpen.md)
|
||||
- [FileLinkReadModelLinksOriginOpenLocation](doc//FileLinkReadModelLinksOriginOpenLocation.md)
|
||||
- [FileLinkReadModelLinksPermission](doc//FileLinkReadModelLinksPermission.md)
|
||||
- [FileLinkReadModelLinksSelf](doc//FileLinkReadModelLinksSelf.md)
|
||||
- [FileLinkReadModelLinksStaticOriginDownload](doc//FileLinkReadModelLinksStaticOriginDownload.md)
|
||||
- [FileLinkReadModelLinksStaticOriginOpen](doc//FileLinkReadModelLinksStaticOriginOpen.md)
|
||||
- [FileLinkReadModelLinksStaticOriginOpenLocation](doc//FileLinkReadModelLinksStaticOriginOpenLocation.md)
|
||||
- [FileLinkReadModelLinksStorage](doc//FileLinkReadModelLinksStorage.md)
|
||||
- [FileLinkWriteModel](doc//FileLinkWriteModel.md)
|
||||
- [Formattable](doc//Formattable.md)
|
||||
- [GridCollectionModel](doc//GridCollectionModel.md)
|
||||
- [GridCollectionModelAllOfEmbedded](doc//GridCollectionModelAllOfEmbedded.md)
|
||||
- [GridReadModel](doc//GridReadModel.md)
|
||||
- [GridReadModelLinks](doc//GridReadModelLinks.md)
|
||||
- [GridReadModelLinksAddAttachment](doc//GridReadModelLinksAddAttachment.md)
|
||||
- [GridReadModelLinksAttachments](doc//GridReadModelLinksAttachments.md)
|
||||
- [GridReadModelLinksDelete](doc//GridReadModelLinksDelete.md)
|
||||
- [GridReadModelLinksScope](doc//GridReadModelLinksScope.md)
|
||||
- [GridReadModelLinksSelf](doc//GridReadModelLinksSelf.md)
|
||||
- [GridReadModelLinksUpdate](doc//GridReadModelLinksUpdate.md)
|
||||
- [GridReadModelLinksUpdateImmediately](doc//GridReadModelLinksUpdateImmediately.md)
|
||||
- [GridWidgetModel](doc//GridWidgetModel.md)
|
||||
- [GridWriteModel](doc//GridWriteModel.md)
|
||||
- [GridWriteModelLinks](doc//GridWriteModelLinks.md)
|
||||
- [GroupCollectionModel](doc//GroupCollectionModel.md)
|
||||
- [GroupCollectionModelAllOfEmbedded](doc//GroupCollectionModelAllOfEmbedded.md)
|
||||
- [GroupCollectionModelAllOfLinks](doc//GroupCollectionModelAllOfLinks.md)
|
||||
- [GroupCollectionModelAllOfLinksSelf](doc//GroupCollectionModelAllOfLinksSelf.md)
|
||||
- [GroupModel](doc//GroupModel.md)
|
||||
- [GroupModelLinks](doc//GroupModelLinks.md)
|
||||
- [GroupModelLinksDelete](doc//GroupModelLinksDelete.md)
|
||||
- [GroupModelLinksMembersInner](doc//GroupModelLinksMembersInner.md)
|
||||
- [GroupModelLinksMemberships](doc//GroupModelLinksMemberships.md)
|
||||
- [GroupModelLinksSelf](doc//GroupModelLinksSelf.md)
|
||||
- [GroupModelLinksUpdateImmediately](doc//GroupModelLinksUpdateImmediately.md)
|
||||
- [GroupWriteModel](doc//GroupWriteModel.md)
|
||||
- [GroupWriteModelLinks](doc//GroupWriteModelLinks.md)
|
||||
- [GroupWriteModelLinksMembersInner](doc//GroupWriteModelLinksMembersInner.md)
|
||||
- [HelpTextCollectionModel](doc//HelpTextCollectionModel.md)
|
||||
- [HelpTextCollectionModelAllOfEmbedded](doc//HelpTextCollectionModelAllOfEmbedded.md)
|
||||
- [HelpTextCollectionModelAllOfLinks](doc//HelpTextCollectionModelAllOfLinks.md)
|
||||
- [HelpTextCollectionModelAllOfLinksSelf](doc//HelpTextCollectionModelAllOfLinksSelf.md)
|
||||
- [HelpTextModel](doc//HelpTextModel.md)
|
||||
- [HelpTextModelLinks](doc//HelpTextModelLinks.md)
|
||||
- [HelpTextModelLinksAddAttachment](doc//HelpTextModelLinksAddAttachment.md)
|
||||
- [HelpTextModelLinksAttachments](doc//HelpTextModelLinksAttachments.md)
|
||||
- [HelpTextModelLinksEditText](doc//HelpTextModelLinksEditText.md)
|
||||
- [HelpTextModelLinksSelf](doc//HelpTextModelLinksSelf.md)
|
||||
- [Link](doc//Link.md)
|
||||
- [NewsModel](doc//NewsModel.md)
|
||||
- [NewsModelLinks](doc//NewsModelLinks.md)
|
||||
- [NewsModelLinksAuthor](doc//NewsModelLinksAuthor.md)
|
||||
- [NewsModelLinksProject](doc//NewsModelLinksProject.md)
|
||||
- [NewsModelLinksSelf](doc//NewsModelLinksSelf.md)
|
||||
- [NonWorkingDayCollectionModel](doc//NonWorkingDayCollectionModel.md)
|
||||
- [NonWorkingDayCollectionModelAllOfEmbedded](doc//NonWorkingDayCollectionModelAllOfEmbedded.md)
|
||||
- [NonWorkingDayCollectionModelAllOfLinks](doc//NonWorkingDayCollectionModelAllOfLinks.md)
|
||||
- [NonWorkingDayCollectionModelAllOfLinksSelf](doc//NonWorkingDayCollectionModelAllOfLinksSelf.md)
|
||||
- [NonWorkingDayModel](doc//NonWorkingDayModel.md)
|
||||
- [NonWorkingDayModelLinks](doc//NonWorkingDayModelLinks.md)
|
||||
- [NonWorkingDayModelLinksSelf](doc//NonWorkingDayModelLinksSelf.md)
|
||||
- [NotificationCollectionModel](doc//NotificationCollectionModel.md)
|
||||
- [NotificationCollectionModelAllOfEmbedded](doc//NotificationCollectionModelAllOfEmbedded.md)
|
||||
- [NotificationCollectionModelAllOfLinks](doc//NotificationCollectionModelAllOfLinks.md)
|
||||
- [NotificationCollectionModelAllOfLinksChangeSize](doc//NotificationCollectionModelAllOfLinksChangeSize.md)
|
||||
- [NotificationCollectionModelAllOfLinksJumpTo](doc//NotificationCollectionModelAllOfLinksJumpTo.md)
|
||||
- [NotificationCollectionModelAllOfLinksSelf](doc//NotificationCollectionModelAllOfLinksSelf.md)
|
||||
- [NotificationModel](doc//NotificationModel.md)
|
||||
- [NotificationModelDetailsInner](doc//NotificationModelDetailsInner.md)
|
||||
- [NotificationModelEmbedded](doc//NotificationModelEmbedded.md)
|
||||
- [NotificationModelEmbeddedResource](doc//NotificationModelEmbeddedResource.md)
|
||||
- [NotificationModelLinks](doc//NotificationModelLinks.md)
|
||||
- [NotificationModelLinksActivity](doc//NotificationModelLinksActivity.md)
|
||||
- [NotificationModelLinksActor](doc//NotificationModelLinksActor.md)
|
||||
- [NotificationModelLinksDetailsInner](doc//NotificationModelLinksDetailsInner.md)
|
||||
- [NotificationModelLinksProject](doc//NotificationModelLinksProject.md)
|
||||
- [NotificationModelLinksReadIAN](doc//NotificationModelLinksReadIAN.md)
|
||||
- [NotificationModelLinksResource](doc//NotificationModelLinksResource.md)
|
||||
- [NotificationModelLinksSelf](doc//NotificationModelLinksSelf.md)
|
||||
- [NotificationModelLinksUnreadIAN](doc//NotificationModelLinksUnreadIAN.md)
|
||||
- [OAuthApplicationReadModel](doc//OAuthApplicationReadModel.md)
|
||||
- [OAuthApplicationReadModelLinks](doc//OAuthApplicationReadModelLinks.md)
|
||||
- [OAuthApplicationReadModelLinksIntegration](doc//OAuthApplicationReadModelLinksIntegration.md)
|
||||
- [OAuthApplicationReadModelLinksOwner](doc//OAuthApplicationReadModelLinksOwner.md)
|
||||
- [OAuthApplicationReadModelLinksRedirectUri](doc//OAuthApplicationReadModelLinksRedirectUri.md)
|
||||
- [OAuthApplicationReadModelLinksSelf](doc//OAuthApplicationReadModelLinksSelf.md)
|
||||
- [OAuthClientCredentialsReadModel](doc//OAuthClientCredentialsReadModel.md)
|
||||
- [OAuthClientCredentialsReadModelLinks](doc//OAuthClientCredentialsReadModelLinks.md)
|
||||
- [OAuthClientCredentialsReadModelLinksIntegration](doc//OAuthClientCredentialsReadModelLinksIntegration.md)
|
||||
- [OAuthClientCredentialsReadModelLinksSelf](doc//OAuthClientCredentialsReadModelLinksSelf.md)
|
||||
- [OAuthClientCredentialsWriteModel](doc//OAuthClientCredentialsWriteModel.md)
|
||||
- [PaginatedCollectionModel](doc//PaginatedCollectionModel.md)
|
||||
- [PaginatedCollectionModelAllOfLinks](doc//PaginatedCollectionModelAllOfLinks.md)
|
||||
- [PaginatedCollectionModelAllOfLinksChangeSize](doc//PaginatedCollectionModelAllOfLinksChangeSize.md)
|
||||
- [PaginatedCollectionModelAllOfLinksJumpTo](doc//PaginatedCollectionModelAllOfLinksJumpTo.md)
|
||||
- [PostModel](doc//PostModel.md)
|
||||
- [PostModelLinks](doc//PostModelLinks.md)
|
||||
- [PostModelLinksAddAttachment](doc//PostModelLinksAddAttachment.md)
|
||||
- [PriorityModel](doc//PriorityModel.md)
|
||||
- [PriorityModelLinks](doc//PriorityModelLinks.md)
|
||||
- [PriorityModelLinksSelf](doc//PriorityModelLinksSelf.md)
|
||||
- [ProjectModel](doc//ProjectModel.md)
|
||||
- [ProjectModelLinks](doc//ProjectModelLinks.md)
|
||||
- [ProjectModelLinksCategories](doc//ProjectModelLinksCategories.md)
|
||||
- [ProjectModelLinksCreateWorkPackage](doc//ProjectModelLinksCreateWorkPackage.md)
|
||||
- [ProjectModelLinksCreateWorkPackageImmediately](doc//ProjectModelLinksCreateWorkPackageImmediately.md)
|
||||
- [ProjectModelLinksDelete](doc//ProjectModelLinksDelete.md)
|
||||
- [ProjectModelLinksMemberships](doc//ProjectModelLinksMemberships.md)
|
||||
- [ProjectModelLinksParent](doc//ProjectModelLinksParent.md)
|
||||
- [ProjectModelLinksSelf](doc//ProjectModelLinksSelf.md)
|
||||
- [ProjectModelLinksStatus](doc//ProjectModelLinksStatus.md)
|
||||
- [ProjectModelLinksStoragesInner](doc//ProjectModelLinksStoragesInner.md)
|
||||
- [ProjectModelLinksTypes](doc//ProjectModelLinksTypes.md)
|
||||
- [ProjectModelLinksUpdate](doc//ProjectModelLinksUpdate.md)
|
||||
- [ProjectModelLinksUpdateImmediately](doc//ProjectModelLinksUpdateImmediately.md)
|
||||
- [ProjectModelLinksVersions](doc//ProjectModelLinksVersions.md)
|
||||
- [ProjectModelLinksWorkPackages](doc//ProjectModelLinksWorkPackages.md)
|
||||
- [ProjectModelStatusExplanation](doc//ProjectModelStatusExplanation.md)
|
||||
- [ProjectStorageCollectionModel](doc//ProjectStorageCollectionModel.md)
|
||||
- [ProjectStorageCollectionModelAllOfEmbedded](doc//ProjectStorageCollectionModelAllOfEmbedded.md)
|
||||
- [ProjectStorageCollectionModelAllOfLinks](doc//ProjectStorageCollectionModelAllOfLinks.md)
|
||||
- [ProjectStorageCollectionModelAllOfLinksSelf](doc//ProjectStorageCollectionModelAllOfLinksSelf.md)
|
||||
- [ProjectStorageModel](doc//ProjectStorageModel.md)
|
||||
- [ProjectStorageModelLinks](doc//ProjectStorageModelLinks.md)
|
||||
- [ProjectStorageModelLinksCreator](doc//ProjectStorageModelLinksCreator.md)
|
||||
- [ProjectStorageModelLinksProject](doc//ProjectStorageModelLinksProject.md)
|
||||
- [ProjectStorageModelLinksProjectFolder](doc//ProjectStorageModelLinksProjectFolder.md)
|
||||
- [ProjectStorageModelLinksSelf](doc//ProjectStorageModelLinksSelf.md)
|
||||
- [ProjectStorageModelLinksStorage](doc//ProjectStorageModelLinksStorage.md)
|
||||
- [QueryColumnModel](doc//QueryColumnModel.md)
|
||||
- [QueryCreateForm](doc//QueryCreateForm.md)
|
||||
- [QueryFilterInstanceSchemaModel](doc//QueryFilterInstanceSchemaModel.md)
|
||||
- [QueryFilterInstanceSchemaModelLinks](doc//QueryFilterInstanceSchemaModelLinks.md)
|
||||
- [QueryFilterInstanceSchemaModelLinksFilter](doc//QueryFilterInstanceSchemaModelLinksFilter.md)
|
||||
- [QueryFilterInstanceSchemaModelLinksSelf](doc//QueryFilterInstanceSchemaModelLinksSelf.md)
|
||||
- [QueryFilterModel](doc//QueryFilterModel.md)
|
||||
- [QueryModel](doc//QueryModel.md)
|
||||
- [QueryModelLinks](doc//QueryModelLinks.md)
|
||||
- [QueryModelLinksStar](doc//QueryModelLinksStar.md)
|
||||
- [QueryModelLinksUnstar](doc//QueryModelLinksUnstar.md)
|
||||
- [QueryModelLinksUpdate](doc//QueryModelLinksUpdate.md)
|
||||
- [QueryModelLinksUpdateImmediately](doc//QueryModelLinksUpdateImmediately.md)
|
||||
- [QueryOperatorModel](doc//QueryOperatorModel.md)
|
||||
- [QuerySortByModel](doc//QuerySortByModel.md)
|
||||
- [QueryUpdateForm](doc//QueryUpdateForm.md)
|
||||
- [RelationModel](doc//RelationModel.md)
|
||||
- [RelationModelLinks](doc//RelationModelLinks.md)
|
||||
- [RelationModelLinksDelete](doc//RelationModelLinksDelete.md)
|
||||
- [RelationModelLinksFrom](doc//RelationModelLinksFrom.md)
|
||||
- [RelationModelLinksSchema](doc//RelationModelLinksSchema.md)
|
||||
- [RelationModelLinksSelf](doc//RelationModelLinksSelf.md)
|
||||
- [RelationModelLinksTo](doc//RelationModelLinksTo.md)
|
||||
- [RelationModelLinksUpdate](doc//RelationModelLinksUpdate.md)
|
||||
- [RelationModelLinksUpdateImmediately](doc//RelationModelLinksUpdateImmediately.md)
|
||||
- [RevisionModel](doc//RevisionModel.md)
|
||||
- [RevisionModelLinks](doc//RevisionModelLinks.md)
|
||||
- [RevisionModelLinksAuthor](doc//RevisionModelLinksAuthor.md)
|
||||
- [RevisionModelLinksProject](doc//RevisionModelLinksProject.md)
|
||||
- [RevisionModelLinksSelf](doc//RevisionModelLinksSelf.md)
|
||||
- [RevisionModelLinksShowRevision](doc//RevisionModelLinksShowRevision.md)
|
||||
- [RevisionModelMessage](doc//RevisionModelMessage.md)
|
||||
- [RoleModel](doc//RoleModel.md)
|
||||
- [RoleModelLinks](doc//RoleModelLinks.md)
|
||||
- [RoleModelLinksSelf](doc//RoleModelLinksSelf.md)
|
||||
- [RootModel](doc//RootModel.md)
|
||||
- [RootModelLinks](doc//RootModelLinks.md)
|
||||
- [RootModelLinksConfiguration](doc//RootModelLinksConfiguration.md)
|
||||
- [RootModelLinksMemberships](doc//RootModelLinksMemberships.md)
|
||||
- [RootModelLinksPriorities](doc//RootModelLinksPriorities.md)
|
||||
- [RootModelLinksRelations](doc//RootModelLinksRelations.md)
|
||||
- [RootModelLinksSelf](doc//RootModelLinksSelf.md)
|
||||
- [RootModelLinksStatuses](doc//RootModelLinksStatuses.md)
|
||||
- [RootModelLinksTimeEntries](doc//RootModelLinksTimeEntries.md)
|
||||
- [RootModelLinksTypes](doc//RootModelLinksTypes.md)
|
||||
- [RootModelLinksUser](doc//RootModelLinksUser.md)
|
||||
- [RootModelLinksUserPreferences](doc//RootModelLinksUserPreferences.md)
|
||||
- [RootModelLinksWorkPackages](doc//RootModelLinksWorkPackages.md)
|
||||
- [SchemaModel](doc//SchemaModel.md)
|
||||
- [SchemaModelLinks](doc//SchemaModelLinks.md)
|
||||
- [SchemaModelLinksSelf](doc//SchemaModelLinksSelf.md)
|
||||
- [ShowOrValidateFormRequest](doc//ShowOrValidateFormRequest.md)
|
||||
- [StatusModel](doc//StatusModel.md)
|
||||
- [StatusModelLinks](doc//StatusModelLinks.md)
|
||||
- [StatusModelLinksSelf](doc//StatusModelLinksSelf.md)
|
||||
- [StorageFileModel](doc//StorageFileModel.md)
|
||||
- [StorageFileModelAllOfLinks](doc//StorageFileModelAllOfLinks.md)
|
||||
- [StorageFileModelAllOfLinksSelf](doc//StorageFileModelAllOfLinksSelf.md)
|
||||
- [StorageFileUploadLinkModel](doc//StorageFileUploadLinkModel.md)
|
||||
- [StorageFileUploadLinkModelLinks](doc//StorageFileUploadLinkModelLinks.md)
|
||||
- [StorageFileUploadLinkModelLinksDestination](doc//StorageFileUploadLinkModelLinksDestination.md)
|
||||
- [StorageFileUploadLinkModelLinksSelf](doc//StorageFileUploadLinkModelLinksSelf.md)
|
||||
- [StorageFileUploadPreparationModel](doc//StorageFileUploadPreparationModel.md)
|
||||
- [StorageFilesModel](doc//StorageFilesModel.md)
|
||||
- [StorageFilesModelParent](doc//StorageFilesModelParent.md)
|
||||
- [StorageReadModel](doc//StorageReadModel.md)
|
||||
- [StorageReadModelEmbedded](doc//StorageReadModelEmbedded.md)
|
||||
- [StorageReadModelLinks](doc//StorageReadModelLinks.md)
|
||||
- [StorageReadModelLinksAuthorizationState](doc//StorageReadModelLinksAuthorizationState.md)
|
||||
- [StorageReadModelLinksAuthorize](doc//StorageReadModelLinksAuthorize.md)
|
||||
- [StorageReadModelLinksOauthApplication](doc//StorageReadModelLinksOauthApplication.md)
|
||||
- [StorageReadModelLinksOauthClientCredentials](doc//StorageReadModelLinksOauthClientCredentials.md)
|
||||
- [StorageReadModelLinksOpen](doc//StorageReadModelLinksOpen.md)
|
||||
- [StorageReadModelLinksOrigin](doc//StorageReadModelLinksOrigin.md)
|
||||
- [StorageReadModelLinksSelf](doc//StorageReadModelLinksSelf.md)
|
||||
- [StorageReadModelLinksType](doc//StorageReadModelLinksType.md)
|
||||
- [StorageWriteModel](doc//StorageWriteModel.md)
|
||||
- [StorageWriteModelLinks](doc//StorageWriteModelLinks.md)
|
||||
- [StorageWriteModelLinksOrigin](doc//StorageWriteModelLinksOrigin.md)
|
||||
- [StorageWriteModelLinksType](doc//StorageWriteModelLinksType.md)
|
||||
- [TimeEntryActivityModel](doc//TimeEntryActivityModel.md)
|
||||
- [TimeEntryActivityModelEmbedded](doc//TimeEntryActivityModelEmbedded.md)
|
||||
- [TimeEntryActivityModelLinks](doc//TimeEntryActivityModelLinks.md)
|
||||
- [TimeEntryActivityModelLinksSelf](doc//TimeEntryActivityModelLinksSelf.md)
|
||||
- [TimeEntryCollectionModel](doc//TimeEntryCollectionModel.md)
|
||||
- [TimeEntryCollectionModelAllOfEmbedded](doc//TimeEntryCollectionModelAllOfEmbedded.md)
|
||||
- [TimeEntryCollectionModelAllOfLinks](doc//TimeEntryCollectionModelAllOfLinks.md)
|
||||
- [TimeEntryCollectionModelAllOfLinksSelf](doc//TimeEntryCollectionModelAllOfLinksSelf.md)
|
||||
- [TimeEntryModel](doc//TimeEntryModel.md)
|
||||
- [TimeEntryModelComment](doc//TimeEntryModelComment.md)
|
||||
- [TimeEntryModelLinks](doc//TimeEntryModelLinks.md)
|
||||
- [TimeEntryModelLinksActivity](doc//TimeEntryModelLinksActivity.md)
|
||||
- [TimeEntryModelLinksDelete](doc//TimeEntryModelLinksDelete.md)
|
||||
- [TimeEntryModelLinksProject](doc//TimeEntryModelLinksProject.md)
|
||||
- [TimeEntryModelLinksSchema](doc//TimeEntryModelLinksSchema.md)
|
||||
- [TimeEntryModelLinksSelf](doc//TimeEntryModelLinksSelf.md)
|
||||
- [TimeEntryModelLinksUpdate](doc//TimeEntryModelLinksUpdate.md)
|
||||
- [TimeEntryModelLinksUpdateImmediately](doc//TimeEntryModelLinksUpdateImmediately.md)
|
||||
- [TimeEntryModelLinksUser](doc//TimeEntryModelLinksUser.md)
|
||||
- [TimeEntryModelLinksWorkPackage](doc//TimeEntryModelLinksWorkPackage.md)
|
||||
- [TypeModel](doc//TypeModel.md)
|
||||
- [TypeModelLinks](doc//TypeModelLinks.md)
|
||||
- [TypeModelLinksSelf](doc//TypeModelLinksSelf.md)
|
||||
- [UpdateActivityRequest](doc//UpdateActivityRequest.md)
|
||||
- [UpdateActivityRequestComment](doc//UpdateActivityRequestComment.md)
|
||||
- [UpdateUserPreferencesRequest](doc//UpdateUserPreferencesRequest.md)
|
||||
- [UserCollectionModel](doc//UserCollectionModel.md)
|
||||
- [UserCollectionModelAllOfEmbedded](doc//UserCollectionModelAllOfEmbedded.md)
|
||||
- [UserCollectionModelAllOfLinks](doc//UserCollectionModelAllOfLinks.md)
|
||||
- [UserCollectionModelAllOfLinksSelf](doc//UserCollectionModelAllOfLinksSelf.md)
|
||||
- [UserCreateModel](doc//UserCreateModel.md)
|
||||
- [UserModel](doc//UserModel.md)
|
||||
- [UserModelLinks](doc//UserModelLinks.md)
|
||||
- [UserModelLinksDelete](doc//UserModelLinksDelete.md)
|
||||
- [UserModelLinksLock](doc//UserModelLinksLock.md)
|
||||
- [UserModelLinksMemberships](doc//UserModelLinksMemberships.md)
|
||||
- [UserModelLinksSelf](doc//UserModelLinksSelf.md)
|
||||
- [UserModelLinksShowUser](doc//UserModelLinksShowUser.md)
|
||||
- [UserModelLinksUnlock](doc//UserModelLinksUnlock.md)
|
||||
- [UserModelLinksUpdateImmediately](doc//UserModelLinksUpdateImmediately.md)
|
||||
- [ValuesPropertyModel](doc//ValuesPropertyModel.md)
|
||||
- [ValuesPropertyModelLinks](doc//ValuesPropertyModelLinks.md)
|
||||
- [ValuesPropertyModelLinksSchema](doc//ValuesPropertyModelLinksSchema.md)
|
||||
- [ValuesPropertyModelLinksSelf](doc//ValuesPropertyModelLinksSelf.md)
|
||||
- [VersionModel](doc//VersionModel.md)
|
||||
- [VersionModelLinks](doc//VersionModelLinks.md)
|
||||
- [VersionModelLinksAvailableInProjects](doc//VersionModelLinksAvailableInProjects.md)
|
||||
- [VersionModelLinksDefiningProject](doc//VersionModelLinksDefiningProject.md)
|
||||
- [VersionModelLinksSelf](doc//VersionModelLinksSelf.md)
|
||||
- [VersionModelLinksUpdate](doc//VersionModelLinksUpdate.md)
|
||||
- [VersionModelLinksUpdateImmediately](doc//VersionModelLinksUpdateImmediately.md)
|
||||
- [WatchersModel](doc//WatchersModel.md)
|
||||
- [WatchersModelAllOfEmbedded](doc//WatchersModelAllOfEmbedded.md)
|
||||
- [WatchersModelAllOfLinks](doc//WatchersModelAllOfLinks.md)
|
||||
- [WatchersModelAllOfLinksSelf](doc//WatchersModelAllOfLinksSelf.md)
|
||||
- [WeekDayCollectionModel](doc//WeekDayCollectionModel.md)
|
||||
- [WeekDayCollectionModelAllOfEmbedded](doc//WeekDayCollectionModelAllOfEmbedded.md)
|
||||
- [WeekDayCollectionModelAllOfLinks](doc//WeekDayCollectionModelAllOfLinks.md)
|
||||
- [WeekDayCollectionModelAllOfLinksSelf](doc//WeekDayCollectionModelAllOfLinksSelf.md)
|
||||
- [WeekDayCollectionWriteModel](doc//WeekDayCollectionWriteModel.md)
|
||||
- [WeekDayCollectionWriteModelEmbedded](doc//WeekDayCollectionWriteModelEmbedded.md)
|
||||
- [WeekDayModel](doc//WeekDayModel.md)
|
||||
- [WeekDaySelfLinkModel](doc//WeekDaySelfLinkModel.md)
|
||||
- [WeekDaySelfLinkModelSelf](doc//WeekDaySelfLinkModelSelf.md)
|
||||
- [WeekDayWriteModel](doc//WeekDayWriteModel.md)
|
||||
- [WikiPageModel](doc//WikiPageModel.md)
|
||||
- [WikiPageModelLinks](doc//WikiPageModelLinks.md)
|
||||
- [WikiPageModelLinksAddAttachment](doc//WikiPageModelLinksAddAttachment.md)
|
||||
- [WorkPackageModel](doc//WorkPackageModel.md)
|
||||
- [WorkPackageModelDescription](doc//WorkPackageModelDescription.md)
|
||||
- [WorkPackageModelLinks](doc//WorkPackageModelLinks.md)
|
||||
- [WorkPackageModelLinksAddAttachment](doc//WorkPackageModelLinksAddAttachment.md)
|
||||
- [WorkPackageModelLinksAddComment](doc//WorkPackageModelLinksAddComment.md)
|
||||
- [WorkPackageModelLinksAddFileLink](doc//WorkPackageModelLinksAddFileLink.md)
|
||||
- [WorkPackageModelLinksAddRelation](doc//WorkPackageModelLinksAddRelation.md)
|
||||
- [WorkPackageModelLinksAddWatcher](doc//WorkPackageModelLinksAddWatcher.md)
|
||||
- [WorkPackageModelLinksAssignee](doc//WorkPackageModelLinksAssignee.md)
|
||||
- [WorkPackageModelLinksAttachments](doc//WorkPackageModelLinksAttachments.md)
|
||||
- [WorkPackageModelLinksAuthor](doc//WorkPackageModelLinksAuthor.md)
|
||||
- [WorkPackageModelLinksAvailableWatchers](doc//WorkPackageModelLinksAvailableWatchers.md)
|
||||
- [WorkPackageModelLinksBudget](doc//WorkPackageModelLinksBudget.md)
|
||||
- [WorkPackageModelLinksCategory](doc//WorkPackageModelLinksCategory.md)
|
||||
- [WorkPackageModelLinksFileLinks](doc//WorkPackageModelLinksFileLinks.md)
|
||||
- [WorkPackageModelLinksParent](doc//WorkPackageModelLinksParent.md)
|
||||
- [WorkPackageModelLinksPreviewMarkup](doc//WorkPackageModelLinksPreviewMarkup.md)
|
||||
- [WorkPackageModelLinksPriority](doc//WorkPackageModelLinksPriority.md)
|
||||
- [WorkPackageModelLinksProject](doc//WorkPackageModelLinksProject.md)
|
||||
- [WorkPackageModelLinksRelations](doc//WorkPackageModelLinksRelations.md)
|
||||
- [WorkPackageModelLinksRemoveWatcher](doc//WorkPackageModelLinksRemoveWatcher.md)
|
||||
- [WorkPackageModelLinksResponsible](doc//WorkPackageModelLinksResponsible.md)
|
||||
- [WorkPackageModelLinksRevisions](doc//WorkPackageModelLinksRevisions.md)
|
||||
- [WorkPackageModelLinksSchema](doc//WorkPackageModelLinksSchema.md)
|
||||
- [WorkPackageModelLinksSelf](doc//WorkPackageModelLinksSelf.md)
|
||||
- [WorkPackageModelLinksStatus](doc//WorkPackageModelLinksStatus.md)
|
||||
- [WorkPackageModelLinksTimeEntries](doc//WorkPackageModelLinksTimeEntries.md)
|
||||
- [WorkPackageModelLinksType](doc//WorkPackageModelLinksType.md)
|
||||
- [WorkPackageModelLinksUnwatch](doc//WorkPackageModelLinksUnwatch.md)
|
||||
- [WorkPackageModelLinksUpdate](doc//WorkPackageModelLinksUpdate.md)
|
||||
- [WorkPackageModelLinksUpdateImmediately](doc//WorkPackageModelLinksUpdateImmediately.md)
|
||||
- [WorkPackageModelLinksVersion](doc//WorkPackageModelLinksVersion.md)
|
||||
- [WorkPackageModelLinksWatch](doc//WorkPackageModelLinksWatch.md)
|
||||
- [WorkPackageModelLinksWatchers](doc//WorkPackageModelLinksWatchers.md)
|
||||
- [WorkPackagePatchModel](doc//WorkPackagePatchModel.md)
|
||||
- [WorkPackagePatchModelLinks](doc//WorkPackagePatchModelLinks.md)
|
||||
- [WorkPackagesModel](doc//WorkPackagesModel.md)
|
||||
- [WorkPackagesModelAllOfEmbedded](doc//WorkPackagesModelAllOfEmbedded.md)
|
||||
- [WorkPackagesModelAllOfLinks](doc//WorkPackagesModelAllOfLinks.md)
|
||||
- [WorkPackagesModelAllOfLinksSelf](doc//WorkPackagesModelAllOfLinksSelf.md)
|
||||
|
||||
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
### BasicAuth
|
||||
|
||||
- **Type**: HTTP Basic authentication
|
||||
|
||||
|
||||
## Author
|
||||
|
||||
|
||||
|
||||
0
analysis_options.yaml
Normal file
0
analysis_options.yaml
Normal file
248
doc/ActionsCapabilitiesApi.md
Normal file
248
doc/ActionsCapabilitiesApi.md
Normal file
@ -0,0 +1,248 @@
|
||||
# openapi.api.ActionsCapabilitiesApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**listActions**](ActionsCapabilitiesApi.md#listactions) | **GET** /api/v3/actions | List actions
|
||||
[**listCapabilities**](ActionsCapabilitiesApi.md#listcapabilities) | **GET** /api/v3/capabilities | List capabilities
|
||||
[**viewAction**](ActionsCapabilitiesApi.md#viewaction) | **GET** /api/v3/actions/{id} | View action
|
||||
[**viewCapabilities**](ActionsCapabilitiesApi.md#viewcapabilities) | **GET** /api/v3/capabilities/{id} | View capabilities
|
||||
[**viewGlobalContext**](ActionsCapabilitiesApi.md#viewglobalcontext) | **GET** /api/v3/capabilities/context/global | View global context
|
||||
|
||||
|
||||
# **listActions**
|
||||
> Object listActions(filters, sortBy)
|
||||
|
||||
List actions
|
||||
|
||||
Returns a collection of actions. The client can choose to filter the actions similar to how work packages are filtered. In addition to the provided filters, the server will reduce the result set to only contain actions, for which the requesting client has sufficient permissions.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActionsCapabilitiesApi();
|
||||
final filters = [{ "id": { "operator": "=", "values": ["memberships/create"] }" }]; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are: + id: Returns only the action having the id or all actions except those having the id(s).
|
||||
final sortBy = [["id", "asc"]]; // String | JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + *No sort supported yet*
|
||||
|
||||
try {
|
||||
final result = api_instance.listActions(filters, sortBy);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActionsCapabilitiesApi->listActions: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filters** | **String**| JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are: + id: Returns only the action having the id or all actions except those having the id(s). | [optional]
|
||||
**sortBy** | **String**| JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + *No sort supported yet* | [optional] [default to '[["id", "asc"]]']
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **listCapabilities**
|
||||
> Object listCapabilities(filters, sortBy)
|
||||
|
||||
List capabilities
|
||||
|
||||
Returns a collection of actions assigned to a principal in a context. The client can choose to filter the actions similar to how work packages are filtered. In addition to the provided filters, the server will reduce the result set to only contain actions, for which the requesting client has sufficient permissions
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActionsCapabilitiesApi();
|
||||
final filters = [{ "principal": { "operator": "=", "values": ["1"] }" }]; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. + action: Get all capabilities of a certain action + principal: Get all capabilities of a principal + context: Get all capabilities within a context. Note that for a project context the client needs to provide `p{id}`, e.g. `p5` and for the global context a `g`
|
||||
final sortBy = [["id", "asc"]]; // String | JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + id: Sort by the capabilities id
|
||||
|
||||
try {
|
||||
final result = api_instance.listCapabilities(filters, sortBy);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActionsCapabilitiesApi->listCapabilities: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filters** | **String**| JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. + action: Get all capabilities of a certain action + principal: Get all capabilities of a principal + context: Get all capabilities within a context. Note that for a project context the client needs to provide `p{id}`, e.g. `p5` and for the global context a `g` | [optional]
|
||||
**sortBy** | **String**| JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + id: Sort by the capabilities id | [optional] [default to '[["id", "asc"]]']
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewAction**
|
||||
> Object viewAction(id)
|
||||
|
||||
View action
|
||||
|
||||
Returns an individual action.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActionsCapabilitiesApi();
|
||||
final id = work_packages/create; // String | action id which is the name of the action
|
||||
|
||||
try {
|
||||
final result = api_instance.viewAction(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActionsCapabilitiesApi->viewAction: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| action id which is the name of the action |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewCapabilities**
|
||||
> Object viewCapabilities(id)
|
||||
|
||||
View capabilities
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActionsCapabilitiesApi();
|
||||
final id = work_packages/create/p123-567; // String | capability id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewCapabilities(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActionsCapabilitiesApi->viewCapabilities: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| capability id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewGlobalContext**
|
||||
> Object viewGlobalContext()
|
||||
|
||||
View global context
|
||||
|
||||
Returns the global capability context. This context is necessary to consistently link to a context even if the context is not a project.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActionsCapabilitiesApi();
|
||||
|
||||
try {
|
||||
final result = api_instance.viewGlobalContext();
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActionsCapabilitiesApi->viewGlobalContext: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
109
doc/ActivitiesApi.md
Normal file
109
doc/ActivitiesApi.md
Normal file
@ -0,0 +1,109 @@
|
||||
# openapi.api.ActivitiesApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**updateActivity**](ActivitiesApi.md#updateactivity) | **PATCH** /api/v3/activities/{id} | Update activity
|
||||
[**viewActivity**](ActivitiesApi.md#viewactivity) | **GET** /api/v3/activities/{id} | View activity
|
||||
|
||||
|
||||
# **updateActivity**
|
||||
> ActivityModel updateActivity(id, updateActivityRequest)
|
||||
|
||||
Update activity
|
||||
|
||||
Updates an activity's comment and, on success, returns the updated activity.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActivitiesApi();
|
||||
final id = 1; // int | Activity id
|
||||
final updateActivityRequest = UpdateActivityRequest(); // UpdateActivityRequest |
|
||||
|
||||
try {
|
||||
final result = api_instance.updateActivity(id, updateActivityRequest);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActivitiesApi->updateActivity: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Activity id |
|
||||
**updateActivityRequest** | [**UpdateActivityRequest**](UpdateActivityRequest.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**ActivityModel**](ActivityModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewActivity**
|
||||
> ActivityModel viewActivity(id)
|
||||
|
||||
View activity
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ActivitiesApi();
|
||||
final id = 1; // int | Activity id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewActivity(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ActivitiesApi->viewActivity: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Activity id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ActivityModel**](ActivityModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
20
doc/ActivityModel.md
Normal file
20
doc/ActivityModel.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.ActivityModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Activity id | [optional] [readonly]
|
||||
**version** | **int** | Activity version | [optional] [readonly]
|
||||
**comment** | [**ActivityModelComment**](ActivityModelComment.md) | | [optional]
|
||||
**details** | [**List<Formattable>**](Formattable.md) | | [optional] [default to const []]
|
||||
**createdAt** | [**DateTime**](DateTime.md) | Time of creation | [optional] [readonly]
|
||||
**updatedAt** | [**DateTime**](DateTime.md) | Time of update | [optional] [readonly]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
17
doc/ActivityModelComment.md
Normal file
17
doc/ActivityModelComment.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.ActivityModelComment
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**format** | **String** | Indicates the formatting language of the raw text | [readonly]
|
||||
**raw** | **String** | The raw text, as entered by the user | [optional]
|
||||
**html** | **String** | The text converted to HTML according to the format | [optional] [readonly]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/AddWatcherRequest.md
Normal file
15
doc/AddWatcherRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.AddWatcherRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**user** | [**ExecuteCustomActionRequestLinksWorkPackage**](ExecuteCustomActionRequestLinksWorkPackage.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
23
doc/AttachmentModel.md
Normal file
23
doc/AttachmentModel.md
Normal file
@ -0,0 +1,23 @@
|
||||
# openapi.model.AttachmentModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Attachment's id | [optional]
|
||||
**title** | **String** | The name of the file |
|
||||
**fileName** | **String** | The name of the uploaded file |
|
||||
**fileSize** | **int** | The size of the uploaded file in Bytes | [optional]
|
||||
**description** | [**AttachmentModelDescription**](AttachmentModelDescription.md) | |
|
||||
**contentType** | **String** | The files MIME-Type as determined by the server |
|
||||
**digest** | **String** | A checksum for the files content |
|
||||
**createdAt** | [**DateTime**](DateTime.md) | Time of creation |
|
||||
**links** | [**AttachmentModelLinks**](AttachmentModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
17
doc/AttachmentModelDescription.md
Normal file
17
doc/AttachmentModelDescription.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.AttachmentModelDescription
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**format** | **String** | Indicates the formatting language of the raw text | [readonly]
|
||||
**raw** | **String** | The raw text, as entered by the user | [optional]
|
||||
**html** | **String** | The text converted to HTML according to the format | [optional] [readonly]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
19
doc/AttachmentModelLinks.md
Normal file
19
doc/AttachmentModelLinks.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.AttachmentModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**delete** | [**AttachmentModelLinksDelete**](AttachmentModelLinksDelete.md) | | [optional]
|
||||
**self** | [**AttachmentModelLinksSelf**](AttachmentModelLinksSelf.md) | |
|
||||
**container** | [**AttachmentModelLinksContainer**](AttachmentModelLinksContainer.md) | |
|
||||
**author** | [**AttachmentModelLinksAuthor**](AttachmentModelLinksAuthor.md) | |
|
||||
**downloadLocation** | [**AttachmentModelLinksDownloadLocation**](AttachmentModelLinksDownloadLocation.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/AttachmentModelLinksAuthor.md
Normal file
20
doc/AttachmentModelLinksAuthor.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.AttachmentModelLinksAuthor
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/AttachmentModelLinksContainer.md
Normal file
20
doc/AttachmentModelLinksContainer.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.AttachmentModelLinksContainer
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/AttachmentModelLinksDelete.md
Normal file
20
doc/AttachmentModelLinksDelete.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.AttachmentModelLinksDelete
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/AttachmentModelLinksDownloadLocation.md
Normal file
20
doc/AttachmentModelLinksDownloadLocation.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.AttachmentModelLinksDownloadLocation
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/AttachmentModelLinksSelf.md
Normal file
20
doc/AttachmentModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.AttachmentModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
429
doc/AttachmentsApi.md
Normal file
429
doc/AttachmentsApi.md
Normal file
@ -0,0 +1,429 @@
|
||||
# openapi.api.AttachmentsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**addAttachmentToPost**](AttachmentsApi.md#addattachmenttopost) | **POST** /api/v3/posts/{id}/attachments | Add attachment to post
|
||||
[**addAttachmentToWikiPage**](AttachmentsApi.md#addattachmenttowikipage) | **POST** /api/v3/wiki_pages/{id}/attachments | Add attachment to wiki page
|
||||
[**createAttachment**](AttachmentsApi.md#createattachment) | **POST** /api/v3/attachments | Create Attachment
|
||||
[**createWorkPackageAttachment**](AttachmentsApi.md#createworkpackageattachment) | **POST** /api/v3/work_packages/{id}/attachments | Create work package attachment
|
||||
[**deleteAttachment**](AttachmentsApi.md#deleteattachment) | **DELETE** /api/v3/attachments/{id} | Delete attachment
|
||||
[**listAttachmentsByPost**](AttachmentsApi.md#listattachmentsbypost) | **GET** /api/v3/posts/{id}/attachments | List attachments by post
|
||||
[**listAttachmentsByWikiPage**](AttachmentsApi.md#listattachmentsbywikipage) | **GET** /api/v3/wiki_pages/{id}/attachments | List attachments by wiki page
|
||||
[**listWorkPackageAttachments**](AttachmentsApi.md#listworkpackageattachments) | **GET** /api/v3/work_packages/{id}/attachments | List attachments by work package
|
||||
[**viewAttachment**](AttachmentsApi.md#viewattachment) | **GET** /api/v3/attachments/{id} | View attachment
|
||||
|
||||
|
||||
# **addAttachmentToPost**
|
||||
> addAttachmentToPost(id)
|
||||
|
||||
Add attachment to post
|
||||
|
||||
Adds an attachment with the post as it's container.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | ID of the post to receive the attachment
|
||||
|
||||
try {
|
||||
api_instance.addAttachmentToPost(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->addAttachmentToPost: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the post to receive the attachment |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **addAttachmentToWikiPage**
|
||||
> addAttachmentToWikiPage(id)
|
||||
|
||||
Add attachment to wiki page
|
||||
|
||||
Adds an attachment with the wiki page as it's container.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | ID of the wiki page to receive the attachment
|
||||
|
||||
try {
|
||||
api_instance.addAttachmentToWikiPage(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->addAttachmentToWikiPage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the wiki page to receive the attachment |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createAttachment**
|
||||
> AttachmentModel createAttachment()
|
||||
|
||||
Create Attachment
|
||||
|
||||
Clients can create attachments without a container first and attach them later on. This is useful if the container does not exist at the time the attachment is uploaded. After the upload, the client can then claim such containerless attachments for any resource eligible (e.g. WorkPackage) on subsequent requests. The upload and the claiming *must* be done for the same user account. Attachments uploaded by another user cannot be claimed and once claimed for a resource, they cannot be claimed by another. The upload request must be of type `multipart/form-data` with exactly two parts. The first part *must* be called `metadata`. Its content type is expected to be `application/json`, the body *must* be a single JSON object, containing at least the `fileName` and optionally the attachments `description`. The second part *must* be called `file`, its content type *should* match the mime type of the file. The body *must* be the raw content of the file. Note that a `filename` *must* be indicated in the `Content-Disposition` of this part, although it will be ignored. Instead the `fileName` inside the JSON of the metadata part will be used.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
|
||||
try {
|
||||
final result = api_instance.createAttachment();
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->createAttachment: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentModel**](AttachmentModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createWorkPackageAttachment**
|
||||
> AttachmentModel createWorkPackageAttachment(id)
|
||||
|
||||
Create work package attachment
|
||||
|
||||
To add an attachment to a work package, a client needs to issue a request of type `multipart/form-data` with exactly two parts. The first part *must* be called `metadata`. Its content type is expected to be `application/json`, the body *must* be a single JSON object, containing at least the `fileName` and optionally the attachments `description`. The second part *must* be called `file`, its content type *should* match the mime type of the file. The body *must* be the raw content of the file. Note that a `filename` must be indicated in the `Content-Disposition` of this part, however it will be ignored. Instead the `fileName` inside the JSON of the metadata part will be used.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | ID of the work package to receive the attachment
|
||||
|
||||
try {
|
||||
final result = api_instance.createWorkPackageAttachment(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->createWorkPackageAttachment: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the work package to receive the attachment |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentModel**](AttachmentModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deleteAttachment**
|
||||
> deleteAttachment(id)
|
||||
|
||||
Delete attachment
|
||||
|
||||
Permanently deletes the specified attachment.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | Attachment id
|
||||
|
||||
try {
|
||||
api_instance.deleteAttachment(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->deleteAttachment: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Attachment id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **listAttachmentsByPost**
|
||||
> AttachmentsModel listAttachmentsByPost(id)
|
||||
|
||||
List attachments by post
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | ID of the post whose attachments will be listed
|
||||
|
||||
try {
|
||||
final result = api_instance.listAttachmentsByPost(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->listAttachmentsByPost: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the post whose attachments will be listed |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentsModel**](AttachmentsModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **listAttachmentsByWikiPage**
|
||||
> AttachmentsModel listAttachmentsByWikiPage(id)
|
||||
|
||||
List attachments by wiki page
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | ID of the wiki page whose attachments will be listed
|
||||
|
||||
try {
|
||||
final result = api_instance.listAttachmentsByWikiPage(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->listAttachmentsByWikiPage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the wiki page whose attachments will be listed |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentsModel**](AttachmentsModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **listWorkPackageAttachments**
|
||||
> AttachmentsModel listWorkPackageAttachments(id)
|
||||
|
||||
List attachments by work package
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | ID of the work package whose attachments will be listed
|
||||
|
||||
try {
|
||||
final result = api_instance.listWorkPackageAttachments(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->listWorkPackageAttachments: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the work package whose attachments will be listed |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentsModel**](AttachmentsModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewAttachment**
|
||||
> AttachmentModel viewAttachment(id)
|
||||
|
||||
View attachment
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = AttachmentsApi();
|
||||
final id = 1; // int | Attachment id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewAttachment(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling AttachmentsApi->viewAttachment: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Attachment id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AttachmentModel**](AttachmentModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
19
doc/AttachmentsModel.md
Normal file
19
doc/AttachmentsModel.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.AttachmentsModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**total** | **int** | The total amount of elements available in the collection. |
|
||||
**count** | **int** | Actual amount of elements in this response. |
|
||||
**links** | [**AttachmentsModelAllOfLinks**](AttachmentsModelAllOfLinks.md) | |
|
||||
**embedded** | [**AttachmentsModelAllOfEmbedded**](AttachmentsModelAllOfEmbedded.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/AttachmentsModelAllOfEmbedded.md
Normal file
15
doc/AttachmentsModelAllOfEmbedded.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.AttachmentsModelAllOfEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**elements** | [**List<AttachmentsModelAllOfEmbeddedElementsInner>**](AttachmentsModelAllOfEmbeddedElementsInner.md) | | [optional] [default to const []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
23
doc/AttachmentsModelAllOfEmbeddedElementsInner.md
Normal file
23
doc/AttachmentsModelAllOfEmbeddedElementsInner.md
Normal file
@ -0,0 +1,23 @@
|
||||
# openapi.model.AttachmentsModelAllOfEmbeddedElementsInner
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Attachment's id | [optional]
|
||||
**title** | **String** | The name of the file |
|
||||
**fileName** | **String** | The name of the uploaded file |
|
||||
**fileSize** | **int** | The size of the uploaded file in Bytes | [optional]
|
||||
**description** | [**AttachmentModelDescription**](AttachmentModelDescription.md) | |
|
||||
**contentType** | **String** | The files MIME-Type as determined by the server |
|
||||
**digest** | **String** | A checksum for the files content |
|
||||
**createdAt** | [**DateTime**](DateTime.md) | Time of creation |
|
||||
**links** | [**AttachmentModelLinks**](AttachmentModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/AttachmentsModelAllOfLinks.md
Normal file
15
doc/AttachmentsModelAllOfLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.AttachmentsModelAllOfLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**AttachmentsModelAllOfLinksSelf**](AttachmentsModelAllOfLinksSelf.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/AttachmentsModelAllOfLinksSelf.md
Normal file
20
doc/AttachmentsModelAllOfLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.AttachmentsModelAllOfLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/BudgetModel.md
Normal file
15
doc/BudgetModel.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.BudgetModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**BudgetModelLinks**](BudgetModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/BudgetModelLinks.md
Normal file
15
doc/BudgetModelLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.BudgetModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**BudgetModelLinksSelf**](BudgetModelLinksSelf.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/BudgetModelLinksSelf.md
Normal file
20
doc/BudgetModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.BudgetModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
107
doc/BudgetsApi.md
Normal file
107
doc/BudgetsApi.md
Normal file
@ -0,0 +1,107 @@
|
||||
# openapi.api.BudgetsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**viewBudget**](BudgetsApi.md#viewbudget) | **GET** /api/v3/budgets/{id} | view Budget
|
||||
[**viewBudgetsOfAProject**](BudgetsApi.md#viewbudgetsofaproject) | **GET** /api/v3/projects/{id}/budgets | view Budgets of a Project
|
||||
|
||||
|
||||
# **viewBudget**
|
||||
> BudgetModel viewBudget(id)
|
||||
|
||||
view Budget
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = BudgetsApi();
|
||||
final id = 1; // int | Budget id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewBudget(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling BudgetsApi->viewBudget: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Budget id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BudgetModel**](BudgetModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewBudgetsOfAProject**
|
||||
> Object viewBudgetsOfAProject(id)
|
||||
|
||||
view Budgets of a Project
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = BudgetsApi();
|
||||
final id = 1; // int | Project id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewBudgetsOfAProject(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling BudgetsApi->viewBudgetsOfAProject: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Project id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
107
doc/CategoriesApi.md
Normal file
107
doc/CategoriesApi.md
Normal file
@ -0,0 +1,107 @@
|
||||
# openapi.api.CategoriesApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**listCategoriesOfAProject**](CategoriesApi.md#listcategoriesofaproject) | **GET** /api/v3/projects/{id}/categories | List categories of a project
|
||||
[**viewCategory**](CategoriesApi.md#viewcategory) | **GET** /api/v3/categories/{id} | View Category
|
||||
|
||||
|
||||
# **listCategoriesOfAProject**
|
||||
> Object listCategoriesOfAProject(id)
|
||||
|
||||
List categories of a project
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = CategoriesApi();
|
||||
final id = 1; // int | ID of the project whose categories will be listed
|
||||
|
||||
try {
|
||||
final result = api_instance.listCategoriesOfAProject(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling CategoriesApi->listCategoriesOfAProject: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| ID of the project whose categories will be listed |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewCategory**
|
||||
> CategoryModel viewCategory(id)
|
||||
|
||||
View Category
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = CategoriesApi();
|
||||
final id = 1; // int | Category id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewCategory(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling CategoriesApi->viewCategory: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Category id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CategoryModel**](CategoryModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
17
doc/CategoryModel.md
Normal file
17
doc/CategoryModel.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.CategoryModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Category id | [optional] [readonly]
|
||||
**name** | **String** | Category name | [optional]
|
||||
**links** | [**CategoryModelLinks**](CategoryModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
17
doc/CategoryModelLinks.md
Normal file
17
doc/CategoryModelLinks.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.CategoryModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**CategoryModelLinksSelf**](CategoryModelLinksSelf.md) | |
|
||||
**project** | [**CategoryModelLinksProject**](CategoryModelLinksProject.md) | |
|
||||
**defaultAssignee** | [**CategoryModelLinksDefaultAssignee**](CategoryModelLinksDefaultAssignee.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CategoryModelLinksDefaultAssignee.md
Normal file
20
doc/CategoryModelLinksDefaultAssignee.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CategoryModelLinksDefaultAssignee
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CategoryModelLinksProject.md
Normal file
20
doc/CategoryModelLinksProject.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CategoryModelLinksProject
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CategoryModelLinksSelf.md
Normal file
20
doc/CategoryModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CategoryModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
18
doc/CollectionModel.md
Normal file
18
doc/CollectionModel.md
Normal file
@ -0,0 +1,18 @@
|
||||
# openapi.model.CollectionModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**total** | **int** | The total amount of elements available in the collection. |
|
||||
**count** | **int** | Actual amount of elements in this response. |
|
||||
**links** | [**CollectionModelLinks**](CollectionModelLinks.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/CollectionModelLinks.md
Normal file
15
doc/CollectionModelLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.CollectionModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**CollectionModelLinksSelf**](CollectionModelLinksSelf.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CollectionModelLinksSelf.md
Normal file
20
doc/CollectionModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CollectionModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
61
doc/CollectionsApi.md
Normal file
61
doc/CollectionsApi.md
Normal file
@ -0,0 +1,61 @@
|
||||
# openapi.api.CollectionsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**viewAggregatedResult**](CollectionsApi.md#viewaggregatedresult) | **GET** /api/v3/examples | view aggregated result
|
||||
|
||||
|
||||
# **viewAggregatedResult**
|
||||
> viewAggregatedResult(groupBy, showSums)
|
||||
|
||||
view aggregated result
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = CollectionsApi();
|
||||
final groupBy = status; // String | The column to group by. Note: Aggregation is as of now only supported by the work package collection. You can pass any column name as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.
|
||||
final showSums = true; // bool |
|
||||
|
||||
try {
|
||||
api_instance.viewAggregatedResult(groupBy, showSums);
|
||||
} catch (e) {
|
||||
print('Exception when calling CollectionsApi->viewAggregatedResult: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**groupBy** | **String**| The column to group by. Note: Aggregation is as of now only supported by the work package collection. You can pass any column name as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. | [optional]
|
||||
**showSums** | **bool**| | [optional] [default to false]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
15
doc/CommentWorkPackageRequest.md
Normal file
15
doc/CommentWorkPackageRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.CommentWorkPackageRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comment** | [**UpdateActivityRequestComment**](UpdateActivityRequestComment.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
56
doc/ConfigurationApi.md
Normal file
56
doc/ConfigurationApi.md
Normal file
@ -0,0 +1,56 @@
|
||||
# openapi.api.ConfigurationApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**viewConfiguration**](ConfigurationApi.md#viewconfiguration) | **GET** /api/v3/configuration | View configuration
|
||||
|
||||
|
||||
# **viewConfiguration**
|
||||
> ConfigurationModel viewConfiguration()
|
||||
|
||||
View configuration
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = ConfigurationApi();
|
||||
|
||||
try {
|
||||
final result = api_instance.viewConfiguration();
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling ConfigurationApi->viewConfiguration: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**ConfigurationModel**](ConfigurationModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
18
doc/ConfigurationModel.md
Normal file
18
doc/ConfigurationModel.md
Normal file
@ -0,0 +1,18 @@
|
||||
# openapi.model.ConfigurationModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**maximumAttachmentFileSize** | **int** | The maximum allowed size of an attachment in Bytes | [optional] [readonly]
|
||||
**hostName** | **String** | The host name configured for the system | [optional] [readonly]
|
||||
**perPageOptions** | **List<int>** | | [optional] [default to const []]
|
||||
**activeFeatureFlags** | **List<String>** | | [optional] [default to const []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/CreateViewsRequest.md
Normal file
15
doc/CreateViewsRequest.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.CreateViewsRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**CreateViewsRequestLinks**](CreateViewsRequestLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/CreateViewsRequestLinks.md
Normal file
15
doc/CreateViewsRequestLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.CreateViewsRequestLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**query** | [**CreateViewsRequestLinksQuery**](CreateViewsRequestLinksQuery.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/CreateViewsRequestLinksQuery.md
Normal file
15
doc/CreateViewsRequestLinksQuery.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.CreateViewsRequestLinksQuery
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
18
doc/CustomActionModel.md
Normal file
18
doc/CustomActionModel.md
Normal file
@ -0,0 +1,18 @@
|
||||
# openapi.model.CustomActionModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | | [optional]
|
||||
**name** | **String** | The name of the custom action | [optional]
|
||||
**description** | **String** | The description for the custom action | [optional]
|
||||
**links** | [**CustomActionModelLinks**](CustomActionModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
16
doc/CustomActionModelLinks.md
Normal file
16
doc/CustomActionModelLinks.md
Normal file
@ -0,0 +1,16 @@
|
||||
# openapi.model.CustomActionModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**CustomActionModelLinksSelf**](CustomActionModelLinksSelf.md) | |
|
||||
**executeImmediately** | [**CustomActionModelLinksExecuteImmediately**](CustomActionModelLinksExecuteImmediately.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CustomActionModelLinksExecuteImmediately.md
Normal file
20
doc/CustomActionModelLinksExecuteImmediately.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CustomActionModelLinksExecuteImmediately
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CustomActionModelLinksSelf.md
Normal file
20
doc/CustomActionModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CustomActionModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
108
doc/CustomActionsApi.md
Normal file
108
doc/CustomActionsApi.md
Normal file
@ -0,0 +1,108 @@
|
||||
# openapi.api.CustomActionsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**executeCustomAction**](CustomActionsApi.md#executecustomaction) | **POST** /api/v3/custom_actions/{id}/execute | Execute custom action
|
||||
[**getCustomAction**](CustomActionsApi.md#getcustomaction) | **GET** /api/v3/custom_actions/{id} | Get a custom action
|
||||
|
||||
|
||||
# **executeCustomAction**
|
||||
> executeCustomAction(id, executeCustomActionRequest)
|
||||
|
||||
Execute custom action
|
||||
|
||||
A POST to this end point executes the custom action on the work package provided in the payload. The altered work package will be returned. In order to avoid executing the custom action unbeknown to a change that has already taken place, the client has to provide the work package's current lockVersion.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = CustomActionsApi();
|
||||
final id = 1; // int | The id of the custom action to execute
|
||||
final executeCustomActionRequest = ExecuteCustomActionRequest(); // ExecuteCustomActionRequest |
|
||||
|
||||
try {
|
||||
api_instance.executeCustomAction(id, executeCustomActionRequest);
|
||||
} catch (e) {
|
||||
print('Exception when calling CustomActionsApi->executeCustomAction: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| The id of the custom action to execute |
|
||||
**executeCustomActionRequest** | [**ExecuteCustomActionRequest**](ExecuteCustomActionRequest.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getCustomAction**
|
||||
> CustomActionModel getCustomAction(id)
|
||||
|
||||
Get a custom action
|
||||
|
||||
Retrieves a custom action by id.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = CustomActionsApi();
|
||||
final id = 42; // int | The id of the custom action to fetch
|
||||
|
||||
try {
|
||||
final result = api_instance.getCustomAction(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling CustomActionsApi->getCustomAction: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| The id of the custom action to fetch |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CustomActionModel**](CustomActionModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
17
doc/CustomOptionModel.md
Normal file
17
doc/CustomOptionModel.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.CustomOptionModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | The identifier | [optional] [readonly]
|
||||
**value** | **String** | The value defined for this custom option | [optional] [readonly]
|
||||
**links** | [**CustomOptionModelLinks**](CustomOptionModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/CustomOptionModelLinks.md
Normal file
15
doc/CustomOptionModelLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.CustomOptionModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**CustomOptionModelLinksSelf**](CustomOptionModelLinksSelf.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/CustomOptionModelLinksSelf.md
Normal file
20
doc/CustomOptionModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.CustomOptionModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
60
doc/CustomOptionsApi.md
Normal file
60
doc/CustomOptionsApi.md
Normal file
@ -0,0 +1,60 @@
|
||||
# openapi.api.CustomOptionsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**viewCustomOption**](CustomOptionsApi.md#viewcustomoption) | **GET** /api/v3/custom_options/{id} | View Custom Option
|
||||
|
||||
|
||||
# **viewCustomOption**
|
||||
> CustomOptionModel viewCustomOption(id)
|
||||
|
||||
View Custom Option
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = CustomOptionsApi();
|
||||
final id = 1; // int | The custom option's identifier
|
||||
|
||||
try {
|
||||
final result = api_instance.viewCustomOption(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling CustomOptionsApi->viewCustomOption: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| The custom option's identifier |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CustomOptionModel**](CustomOptionModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
19
doc/DayCollectionModel.md
Normal file
19
doc/DayCollectionModel.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.DayCollectionModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**total** | **int** | The total amount of elements available in the collection. |
|
||||
**count** | **int** | Actual amount of elements in this response. |
|
||||
**links** | [**DayCollectionModelAllOfLinks**](DayCollectionModelAllOfLinks.md) | |
|
||||
**embedded** | [**DayCollectionModelAllOfEmbedded**](DayCollectionModelAllOfEmbedded.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/DayCollectionModelAllOfEmbedded.md
Normal file
15
doc/DayCollectionModelAllOfEmbedded.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.DayCollectionModelAllOfEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**elements** | [**List<DayModel>**](DayModel.md) | | [default to const []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/DayCollectionModelAllOfLinks.md
Normal file
15
doc/DayCollectionModelAllOfLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.DayCollectionModelAllOfLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**DayCollectionModelAllOfLinksSelf**](DayCollectionModelAllOfLinksSelf.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/DayCollectionModelAllOfLinksSelf.md
Normal file
20
doc/DayCollectionModelAllOfLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.DayCollectionModelAllOfLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
19
doc/DayModel.md
Normal file
19
doc/DayModel.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.DayModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**date** | [**DateTime**](DateTime.md) | Date of the day. |
|
||||
**name** | **String** | Descriptive name for the day. |
|
||||
**working** | **bool** | `true` for a working day, `false` otherwise. |
|
||||
**links** | [**DayModelLinks**](DayModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
17
doc/DayModelLinks.md
Normal file
17
doc/DayModelLinks.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.DayModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**Link**](Link.md) | |
|
||||
**nonWorkingReasons** | [**List<Link>**](Link.md) | | [optional] [default to const []]
|
||||
**weekDay** | [**DayModelLinksWeekDay**](DayModelLinksWeekDay.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/DayModelLinksWeekDay.md
Normal file
20
doc/DayModelLinksWeekDay.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.DayModelLinksWeekDay
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
19
doc/DocumentModel.md
Normal file
19
doc/DocumentModel.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.DocumentModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | Document's id | [optional] [readonly]
|
||||
**title** | **String** | The title chosen for the collection of documents | [optional] [readonly]
|
||||
**description** | **String** | A text describing the documents | [optional] [readonly]
|
||||
**createdAt** | [**DateTime**](DateTime.md) | The time the document was created at | [optional] [readonly]
|
||||
**links** | [**DocumentModelLinks**](DocumentModelLinks.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
17
doc/DocumentModelLinks.md
Normal file
17
doc/DocumentModelLinks.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.DocumentModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**DocumentModelLinksSelf**](DocumentModelLinksSelf.md) | |
|
||||
**project** | [**DocumentModelLinksProject**](DocumentModelLinksProject.md) | |
|
||||
**attachments** | [**DocumentModelLinksAttachments**](DocumentModelLinksAttachments.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/DocumentModelLinksAttachments.md
Normal file
20
doc/DocumentModelLinksAttachments.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.DocumentModelLinksAttachments
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/DocumentModelLinksProject.md
Normal file
20
doc/DocumentModelLinksProject.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.DocumentModelLinksProject
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/DocumentModelLinksSelf.md
Normal file
20
doc/DocumentModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.DocumentModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
111
doc/DocumentsApi.md
Normal file
111
doc/DocumentsApi.md
Normal file
@ -0,0 +1,111 @@
|
||||
# openapi.api.DocumentsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**listDocuments**](DocumentsApi.md#listdocuments) | **GET** /api/v3/documents | List Documents
|
||||
[**viewDocument**](DocumentsApi.md#viewdocument) | **GET** /api/v3/documents/{id} | View document
|
||||
|
||||
|
||||
# **listDocuments**
|
||||
> Object listDocuments(offset, pageSize, sortBy)
|
||||
|
||||
List Documents
|
||||
|
||||
The documents returned depend on the provided parameters and also on the requesting user's permissions.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = DocumentsApi();
|
||||
final offset = 25; // int | Page number inside the requested collection.
|
||||
final pageSize = 25; // int | Number of elements to display per page.
|
||||
final sortBy = [["created_at", "asc"]]; // String | JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + id: Sort by primary key + created_at: Sort by document creation datetime
|
||||
|
||||
try {
|
||||
final result = api_instance.listDocuments(offset, pageSize, sortBy);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling DocumentsApi->listDocuments: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**offset** | **int**| Page number inside the requested collection. | [optional] [default to 1]
|
||||
**pageSize** | **int**| Number of elements to display per page. | [optional]
|
||||
**sortBy** | **String**| JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are: + id: Sort by primary key + created_at: Sort by document creation datetime | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewDocument**
|
||||
> DocumentModel viewDocument(id)
|
||||
|
||||
View document
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = DocumentsApi();
|
||||
final id = 1; // int | Document id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewDocument(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling DocumentsApi->viewDocument: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Document id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DocumentModel**](DocumentModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
18
doc/ErrorResponse.md
Normal file
18
doc/ErrorResponse.md
Normal file
@ -0,0 +1,18 @@
|
||||
# openapi.model.ErrorResponse
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**embedded** | [**ErrorResponseEmbedded**](ErrorResponseEmbedded.md) | | [optional]
|
||||
**type** | **String** | |
|
||||
**errorIdentifier** | **String** | |
|
||||
**message** | **String** | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/ErrorResponseEmbedded.md
Normal file
15
doc/ErrorResponseEmbedded.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.ErrorResponseEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**details** | [**ErrorResponseEmbeddedDetails**](ErrorResponseEmbeddedDetails.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/ErrorResponseEmbeddedDetails.md
Normal file
15
doc/ErrorResponseEmbeddedDetails.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.ErrorResponseEmbeddedDetails
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**attribute** | **String** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
16
doc/ExecuteCustomActionRequest.md
Normal file
16
doc/ExecuteCustomActionRequest.md
Normal file
@ -0,0 +1,16 @@
|
||||
# openapi.model.ExecuteCustomActionRequest
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**links** | [**ExecuteCustomActionRequestLinks**](ExecuteCustomActionRequestLinks.md) | | [optional]
|
||||
**lockVersion** | **String** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/ExecuteCustomActionRequestLinks.md
Normal file
15
doc/ExecuteCustomActionRequestLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.ExecuteCustomActionRequestLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**workPackage** | [**ExecuteCustomActionRequestLinksWorkPackage**](ExecuteCustomActionRequestLinksWorkPackage.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/ExecuteCustomActionRequestLinksWorkPackage.md
Normal file
15
doc/ExecuteCustomActionRequestLinksWorkPackage.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.ExecuteCustomActionRequestLinksWorkPackage
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
19
doc/FileLinkCollectionReadModel.md
Normal file
19
doc/FileLinkCollectionReadModel.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.FileLinkCollectionReadModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**total** | **int** | The total amount of elements available in the collection. |
|
||||
**count** | **int** | Actual amount of elements in this response. |
|
||||
**links** | [**FileLinkCollectionReadModelAllOfLinks**](FileLinkCollectionReadModelAllOfLinks.md) | |
|
||||
**embedded** | [**FileLinkCollectionReadModelAllOfEmbedded**](FileLinkCollectionReadModelAllOfEmbedded.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/FileLinkCollectionReadModelAllOfEmbedded.md
Normal file
15
doc/FileLinkCollectionReadModelAllOfEmbedded.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.FileLinkCollectionReadModelAllOfEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**elements** | [**List<FileLinkReadModel>**](FileLinkReadModel.md) | | [default to const []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/FileLinkCollectionReadModelAllOfLinks.md
Normal file
15
doc/FileLinkCollectionReadModelAllOfLinks.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.FileLinkCollectionReadModelAllOfLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**FileLinkCollectionReadModelAllOfLinksSelf**](FileLinkCollectionReadModelAllOfLinksSelf.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkCollectionReadModelAllOfLinksSelf.md
Normal file
20
doc/FileLinkCollectionReadModelAllOfLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkCollectionReadModelAllOfLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
19
doc/FileLinkCollectionWriteModel.md
Normal file
19
doc/FileLinkCollectionWriteModel.md
Normal file
@ -0,0 +1,19 @@
|
||||
# openapi.model.FileLinkCollectionWriteModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**total** | **int** | The total amount of elements available in the collection. |
|
||||
**count** | **int** | Actual amount of elements in this response. |
|
||||
**links** | [**CollectionModelLinks**](CollectionModelLinks.md) | |
|
||||
**embedded** | [**FileLinkCollectionWriteModelAllOfEmbedded**](FileLinkCollectionWriteModelAllOfEmbedded.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/FileLinkCollectionWriteModelAllOfEmbedded.md
Normal file
15
doc/FileLinkCollectionWriteModelAllOfEmbedded.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.FileLinkCollectionWriteModelAllOfEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**elements** | [**List<FileLinkWriteModel>**](FileLinkWriteModel.md) | | [default to const []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
22
doc/FileLinkOriginDataModel.md
Normal file
22
doc/FileLinkOriginDataModel.md
Normal file
@ -0,0 +1,22 @@
|
||||
# openapi.model.FileLinkOriginDataModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Linked file's id on the origin |
|
||||
**name** | **String** | Linked file's name on the origin |
|
||||
**mimeType** | **String** | MIME type of the linked file. To link a folder entity, the custom MIME type `application/x-op-directory` MUST be provided. Otherwise it defaults back to an unknown MIME type. | [optional]
|
||||
**size** | **int** | file size on origin in bytes | [optional]
|
||||
**createdAt** | [**DateTime**](DateTime.md) | Timestamp of the creation datetime of the file on the origin | [optional]
|
||||
**lastModifiedAt** | [**DateTime**](DateTime.md) | Timestamp of the datetime of the last modification of the file on the origin | [optional]
|
||||
**createdByName** | **String** | Display name of the author that created the file on the origin | [optional]
|
||||
**lastModifiedByName** | **String** | Display name of the author that modified the file on the origin last | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
21
doc/FileLinkReadModel.md
Normal file
21
doc/FileLinkReadModel.md
Normal file
@ -0,0 +1,21 @@
|
||||
# openapi.model.FileLinkReadModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **int** | File link id |
|
||||
**type** | **String** | |
|
||||
**createdAt** | [**DateTime**](DateTime.md) | Time of creation | [optional]
|
||||
**updatedAt** | [**DateTime**](DateTime.md) | Time of the most recent change to the file link | [optional]
|
||||
**originData** | [**FileLinkOriginDataModel**](FileLinkOriginDataModel.md) | |
|
||||
**embedded** | [**FileLinkReadModelEmbedded**](FileLinkReadModelEmbedded.md) | | [optional]
|
||||
**links** | [**FileLinkReadModelLinks**](FileLinkReadModelLinks.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
16
doc/FileLinkReadModelEmbedded.md
Normal file
16
doc/FileLinkReadModelEmbedded.md
Normal file
@ -0,0 +1,16 @@
|
||||
# openapi.model.FileLinkReadModelEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**storage** | [**StorageReadModel**](StorageReadModel.md) | |
|
||||
**container** | [**WorkPackageModel**](WorkPackageModel.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
25
doc/FileLinkReadModelLinks.md
Normal file
25
doc/FileLinkReadModelLinks.md
Normal file
@ -0,0 +1,25 @@
|
||||
# openapi.model.FileLinkReadModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**FileLinkReadModelLinksSelf**](FileLinkReadModelLinksSelf.md) | |
|
||||
**storage** | [**FileLinkReadModelLinksStorage**](FileLinkReadModelLinksStorage.md) | |
|
||||
**container** | [**FileLinkReadModelLinksContainer**](FileLinkReadModelLinksContainer.md) | |
|
||||
**creator** | [**FileLinkReadModelLinksCreator**](FileLinkReadModelLinksCreator.md) | |
|
||||
**delete** | [**FileLinkReadModelLinksDelete**](FileLinkReadModelLinksDelete.md) | | [optional]
|
||||
**permission** | [**FileLinkReadModelLinksPermission**](FileLinkReadModelLinksPermission.md) | |
|
||||
**originOpen** | [**FileLinkReadModelLinksOriginOpen**](FileLinkReadModelLinksOriginOpen.md) | |
|
||||
**staticOriginOpen** | [**FileLinkReadModelLinksStaticOriginOpen**](FileLinkReadModelLinksStaticOriginOpen.md) | |
|
||||
**originOpenLocation** | [**FileLinkReadModelLinksOriginOpenLocation**](FileLinkReadModelLinksOriginOpenLocation.md) | |
|
||||
**staticOriginOpenLocation** | [**FileLinkReadModelLinksStaticOriginOpenLocation**](FileLinkReadModelLinksStaticOriginOpenLocation.md) | |
|
||||
**staticOriginDownload** | [**FileLinkReadModelLinksStaticOriginDownload**](FileLinkReadModelLinksStaticOriginDownload.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksContainer.md
Normal file
20
doc/FileLinkReadModelLinksContainer.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksContainer
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksCreator.md
Normal file
20
doc/FileLinkReadModelLinksCreator.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksCreator
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksDelete.md
Normal file
20
doc/FileLinkReadModelLinksDelete.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksDelete
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksOriginOpen.md
Normal file
20
doc/FileLinkReadModelLinksOriginOpen.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksOriginOpen
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksOriginOpenLocation.md
Normal file
20
doc/FileLinkReadModelLinksOriginOpenLocation.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksOriginOpenLocation
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksPermission.md
Normal file
20
doc/FileLinkReadModelLinksPermission.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksPermission
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksSelf.md
Normal file
20
doc/FileLinkReadModelLinksSelf.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksSelf
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksStaticOriginDownload.md
Normal file
20
doc/FileLinkReadModelLinksStaticOriginDownload.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksStaticOriginDownload
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksStaticOriginOpen.md
Normal file
20
doc/FileLinkReadModelLinksStaticOriginOpen.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksStaticOriginOpen
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksStaticOriginOpenLocation.md
Normal file
20
doc/FileLinkReadModelLinksStaticOriginOpenLocation.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksStaticOriginOpenLocation
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/FileLinkReadModelLinksStorage.md
Normal file
20
doc/FileLinkReadModelLinksStorage.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.FileLinkReadModelLinksStorage
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/FileLinkWriteModel.md
Normal file
15
doc/FileLinkWriteModel.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.FileLinkWriteModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**originData** | [**FileLinkOriginDataModel**](FileLinkOriginDataModel.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
728
doc/FileLinksApi.md
Normal file
728
doc/FileLinksApi.md
Normal file
@ -0,0 +1,728 @@
|
||||
# openapi.api.FileLinksApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createStorage**](FileLinksApi.md#createstorage) | **POST** /api/v3/storages | Creates a storage.
|
||||
[**createStorageOauthCredentials**](FileLinksApi.md#createstorageoauthcredentials) | **POST** /api/v3/storages/{id}/oauth_client_credentials | Creates an oauth client credentials object for a storage.
|
||||
[**createWorkPackageFileLink**](FileLinksApi.md#createworkpackagefilelink) | **POST** /api/v3/work_packages/{id}/file_links | Creates file links.
|
||||
[**deleteFileLink**](FileLinksApi.md#deletefilelink) | **DELETE** /api/v3/file_links/{id} | Removes a file link.
|
||||
[**deleteStorage**](FileLinksApi.md#deletestorage) | **DELETE** /api/v3/storages/{id} | Delete a storage
|
||||
[**downloadFileLink**](FileLinksApi.md#downloadfilelink) | **GET** /api/v3/file_links/{id}/download | Creates a download uri of the linked file.
|
||||
[**getProjectStorage**](FileLinksApi.md#getprojectstorage) | **GET** /api/v3/project_storages/{id} | Gets a project storage
|
||||
[**getStorage**](FileLinksApi.md#getstorage) | **GET** /api/v3/storages/{id} | Get a storage
|
||||
[**getStorageFiles**](FileLinksApi.md#getstoragefiles) | **GET** /api/v3/storages/{id}/files | Gets files of a storage.
|
||||
[**listProjectStorages**](FileLinksApi.md#listprojectstorages) | **GET** /api/v3/project_storages | Gets a list of project storages
|
||||
[**listWorkPackageFileLinks**](FileLinksApi.md#listworkpackagefilelinks) | **GET** /api/v3/work_packages/{id}/file_links | Gets all file links of a work package
|
||||
[**openFileLink**](FileLinksApi.md#openfilelink) | **GET** /api/v3/file_links/{id}/open | Creates an opening uri of the linked file.
|
||||
[**prepareStorageFileUpload**](FileLinksApi.md#preparestoragefileupload) | **POST** /api/v3/storages/{id}/files/prepare_upload | Preparation of a direct upload of a file to the given storage.
|
||||
[**updateStorage**](FileLinksApi.md#updatestorage) | **PATCH** /api/v3/storages/{id} | Update a storage
|
||||
[**viewFileLink**](FileLinksApi.md#viewfilelink) | **GET** /api/v3/file_links/{id} | Gets a file link.
|
||||
|
||||
|
||||
# **createStorage**
|
||||
> StorageReadModel createStorage(storageWriteModel)
|
||||
|
||||
Creates a storage.
|
||||
|
||||
Creates a storage resource. When creating a storage, a confidential OAuth 2 provider application is created automatically. The oauth client id and secret of the created OAuth application are returned in the response. **IMPORTANT:** This is the only time, the oauth client secret is visible to the consumer. After that, the secret is hidden. To update the storage with OAuth client credentials, which enable the storage resource to behave as an OAuth 2 client against an external OAuth 2 provider application, another request must be made to create those, see `POST /api/v3/storages/{id}/oauth_client_credentials`.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final storageWriteModel = StorageWriteModel(); // StorageWriteModel |
|
||||
|
||||
try {
|
||||
final result = api_instance.createStorage(storageWriteModel);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->createStorage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**storageWriteModel** | [**StorageWriteModel**](StorageWriteModel.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**StorageReadModel**](StorageReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createStorageOauthCredentials**
|
||||
> StorageReadModel createStorageOauthCredentials(id, oAuthClientCredentialsWriteModel)
|
||||
|
||||
Creates an oauth client credentials object for a storage.
|
||||
|
||||
Inserts the OAuth 2 credentials into the storage, to allow the storage to act as an OAuth 2 client. Calling this endpoint on a storage that already contains OAuth 2 client credentials will replace them.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Storage id
|
||||
final oAuthClientCredentialsWriteModel = OAuthClientCredentialsWriteModel(); // OAuthClientCredentialsWriteModel |
|
||||
|
||||
try {
|
||||
final result = api_instance.createStorageOauthCredentials(id, oAuthClientCredentialsWriteModel);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->createStorageOauthCredentials: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Storage id |
|
||||
**oAuthClientCredentialsWriteModel** | [**OAuthClientCredentialsWriteModel**](OAuthClientCredentialsWriteModel.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**StorageReadModel**](StorageReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createWorkPackageFileLink**
|
||||
> FileLinkCollectionReadModel createWorkPackageFileLink(id, fileLinkCollectionWriteModel)
|
||||
|
||||
Creates file links.
|
||||
|
||||
Creates file links on a work package. The request is interpreted as a bulk insert, where every element of the collection is validated separately. Each element contains the origin meta data and a link to the storage, the file link is about to point to. The storage link can be provided as a resource link with id or as the host url. The file's id and name are considered mandatory information. The rest of the origin meta data SHOULD be provided by the client. The _mimeType_ SHOULD be a standard mime type. An empty mime type will be handled as unknown. To link a folder, the custom mime type `application/x-op-directory` MUST be used. Up to 20 file links can be submitted at once. If any element data is invalid, no file links will be created. If a file link with matching origin id, work package, and storage already exists, then it will not create an additional file link or update the meta data. Instead the information from the existing file link will be returned.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Work package id
|
||||
final fileLinkCollectionWriteModel = FileLinkCollectionWriteModel(); // FileLinkCollectionWriteModel |
|
||||
|
||||
try {
|
||||
final result = api_instance.createWorkPackageFileLink(id, fileLinkCollectionWriteModel);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->createWorkPackageFileLink: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Work package id |
|
||||
**fileLinkCollectionWriteModel** | [**FileLinkCollectionWriteModel**](FileLinkCollectionWriteModel.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**FileLinkCollectionReadModel**](FileLinkCollectionReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deleteFileLink**
|
||||
> deleteFileLink(id)
|
||||
|
||||
Removes a file link.
|
||||
|
||||
Removes a file link on a work package. The request contains only the file link identifier as a path parameter. No request body is needed.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 42; // int | File link id
|
||||
|
||||
try {
|
||||
api_instance.deleteFileLink(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->deleteFileLink: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| File link id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deleteStorage**
|
||||
> deleteStorage(id)
|
||||
|
||||
Delete a storage
|
||||
|
||||
Deletes a storage resource. This also deletes all related records, like the created oauth application, client, and any file links created within this storage.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Storage id
|
||||
|
||||
try {
|
||||
api_instance.deleteStorage(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->deleteStorage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Storage id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **downloadFileLink**
|
||||
> downloadFileLink(id)
|
||||
|
||||
Creates a download uri of the linked file.
|
||||
|
||||
Creates a uri to download the origin file linked by the given file link. This uri depends on the storage type and is always located on the origin storage itself.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 42; // int | File link id
|
||||
|
||||
try {
|
||||
api_instance.downloadFileLink(id);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->downloadFileLink: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| File link id |
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getProjectStorage**
|
||||
> ProjectStorageModel getProjectStorage(id)
|
||||
|
||||
Gets a project storage
|
||||
|
||||
Gets a project storage resource. This resource contains all data that is applicable on the relation between a storage and a project.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Project storage id
|
||||
|
||||
try {
|
||||
final result = api_instance.getProjectStorage(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->getProjectStorage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Project storage id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ProjectStorageModel**](ProjectStorageModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getStorage**
|
||||
> StorageReadModel getStorage(id)
|
||||
|
||||
Get a storage
|
||||
|
||||
Gets a storage resource. As a side effect, a live connection to the storages origin is established to retrieve connection state data.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Storage id
|
||||
|
||||
try {
|
||||
final result = api_instance.getStorage(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->getStorage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Storage id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**StorageReadModel**](StorageReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getStorageFiles**
|
||||
> StorageFilesModel getStorageFiles(id, parent)
|
||||
|
||||
Gets files of a storage.
|
||||
|
||||
Gets a collection of files from a storage. If no `parent` context is given, the result is the content of the document root. With `parent` context given, the result contains the collections of files/directories from within the given parent file id. If given `parent` context is no directory, `400 Bad Request` is returned.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Storage id
|
||||
final parent = /my/data; // String | Parent file identification
|
||||
|
||||
try {
|
||||
final result = api_instance.getStorageFiles(id, parent);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->getStorageFiles: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Storage id |
|
||||
**parent** | **String**| Parent file identification | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**StorageFilesModel**](StorageFilesModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **listProjectStorages**
|
||||
> ProjectStorageCollectionModel listProjectStorages(filters)
|
||||
|
||||
Gets a list of project storages
|
||||
|
||||
Gets a collection of all project storages that meet the provided filters and the user has permission to see them.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final filters = [{ "project_id": { "operator": "=", "values": ["42"] }}, { "storage_id": { "operator": "=", "values": ["1337"] }}]; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are: - project_id - storage_id
|
||||
|
||||
try {
|
||||
final result = api_instance.listProjectStorages(filters);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->listProjectStorages: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**filters** | **String**| JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are: - project_id - storage_id | [optional] [default to '[]']
|
||||
|
||||
### Return type
|
||||
|
||||
[**ProjectStorageCollectionModel**](ProjectStorageCollectionModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **listWorkPackageFileLinks**
|
||||
> FileLinkCollectionReadModel listWorkPackageFileLinks(id, filters)
|
||||
|
||||
Gets all file links of a work package
|
||||
|
||||
Gets all file links of a work package. As a side effect, for every file link a request is sent to the storage's origin to fetch live data and patch the file link's data before returning, as well as retrieving permissions of the user on this origin file.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Work package id
|
||||
final filters = [{"storage":{"operator":"=","values":["42"]}}]; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. The following filters are supported: - storage
|
||||
|
||||
try {
|
||||
final result = api_instance.listWorkPackageFileLinks(id, filters);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->listWorkPackageFileLinks: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Work package id |
|
||||
**filters** | **String**| JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. The following filters are supported: - storage | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**FileLinkCollectionReadModel**](FileLinkCollectionReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **openFileLink**
|
||||
> openFileLink(id, location)
|
||||
|
||||
Creates an opening uri of the linked file.
|
||||
|
||||
Creates a uri to open the origin file linked by the given file link. This uri depends on the storage type and is always located on the origin storage itself.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 42; // int | File link id
|
||||
final location = true; // bool | Boolean flag indicating, if the file should be opened directly or rather the directory location.
|
||||
|
||||
try {
|
||||
api_instance.openFileLink(id, location);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->openFileLink: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| File link id |
|
||||
**location** | **bool**| Boolean flag indicating, if the file should be opened directly or rather the directory location. | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **prepareStorageFileUpload**
|
||||
> StorageFileUploadLinkModel prepareStorageFileUpload(id, storageFileUploadPreparationModel)
|
||||
|
||||
Preparation of a direct upload of a file to the given storage.
|
||||
|
||||
Executes a request that prepares a link for a direct upload to the storage. The background here is, that the client needs to make a direct request to the storage instance for file uploading, but should not get access to the credentials, which are stored in the backend. The response contains a link object, that enables the client to execute a file upload without the real credentials.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Storage id
|
||||
final storageFileUploadPreparationModel = StorageFileUploadPreparationModel(); // StorageFileUploadPreparationModel |
|
||||
|
||||
try {
|
||||
final result = api_instance.prepareStorageFileUpload(id, storageFileUploadPreparationModel);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->prepareStorageFileUpload: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Storage id |
|
||||
**storageFileUploadPreparationModel** | [**StorageFileUploadPreparationModel**](StorageFileUploadPreparationModel.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**StorageFileUploadLinkModel**](StorageFileUploadLinkModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updateStorage**
|
||||
> StorageReadModel updateStorage(id, storageWriteModel)
|
||||
|
||||
Update a storage
|
||||
|
||||
Updates a storage resource. Only data that is not generated by the server can be updated. This excludes the OAuth 2 application data.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 1337; // int | Storage id
|
||||
final storageWriteModel = StorageWriteModel(); // StorageWriteModel |
|
||||
|
||||
try {
|
||||
final result = api_instance.updateStorage(id, storageWriteModel);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->updateStorage: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| Storage id |
|
||||
**storageWriteModel** | [**StorageWriteModel**](StorageWriteModel.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**StorageReadModel**](StorageReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **viewFileLink**
|
||||
> FileLinkReadModel viewFileLink(id)
|
||||
|
||||
Gets a file link.
|
||||
|
||||
Gets a single file link resource of a work package.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FileLinksApi();
|
||||
final id = 42; // int | File link id
|
||||
|
||||
try {
|
||||
final result = api_instance.viewFileLink(id);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FileLinksApi->viewFileLink: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **int**| File link id |
|
||||
|
||||
### Return type
|
||||
|
||||
[**FileLinkReadModel**](FileLinkReadModel.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/hal+json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
17
doc/Formattable.md
Normal file
17
doc/Formattable.md
Normal file
@ -0,0 +1,17 @@
|
||||
# openapi.model.Formattable
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**format** | **String** | Indicates the formatting language of the raw text | [readonly]
|
||||
**raw** | **String** | The raw text, as entered by the user | [optional]
|
||||
**html** | **String** | The text converted to HTML according to the format | [optional] [readonly]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
60
doc/FormsApi.md
Normal file
60
doc/FormsApi.md
Normal file
@ -0,0 +1,60 @@
|
||||
# openapi.api.FormsApi
|
||||
|
||||
## Load the API package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
All URIs are relative to *https://community.openproject.org*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**showOrValidateForm**](FormsApi.md#showorvalidateform) | **POST** /api/v3/example/form | show or validate form
|
||||
|
||||
|
||||
# **showOrValidateForm**
|
||||
> Object showOrValidateForm(showOrValidateFormRequest)
|
||||
|
||||
show or validate form
|
||||
|
||||
This is an example of how a form might look like. Note that this endpoint does not exist in the actual implementation.
|
||||
|
||||
### Example
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
// TODO Configure HTTP basic authorization: BasicAuth
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').username = 'YOUR_USERNAME'
|
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('BasicAuth').password = 'YOUR_PASSWORD';
|
||||
|
||||
final api_instance = FormsApi();
|
||||
final showOrValidateFormRequest = ShowOrValidateFormRequest(); // ShowOrValidateFormRequest |
|
||||
|
||||
try {
|
||||
final result = api_instance.showOrValidateForm(showOrValidateFormRequest);
|
||||
print(result);
|
||||
} catch (e) {
|
||||
print('Exception when calling FormsApi->showOrValidateForm: $e\n');
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**showOrValidateFormRequest** | [**ShowOrValidateFormRequest**](ShowOrValidateFormRequest.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Object**](Object.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[BasicAuth](../README.md#BasicAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/hal+json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
21
doc/GridCollectionModel.md
Normal file
21
doc/GridCollectionModel.md
Normal file
@ -0,0 +1,21 @@
|
||||
# openapi.model.GridCollectionModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**total** | **int** | The total amount of elements available in the collection. |
|
||||
**count** | **int** | Actual amount of elements in this response. |
|
||||
**links** | [**PaginatedCollectionModelAllOfLinks**](PaginatedCollectionModelAllOfLinks.md) | |
|
||||
**pageSize** | **int** | Amount of elements that a response will hold. |
|
||||
**offset** | **int** | The page number that is requested from paginated collection. |
|
||||
**embedded** | [**GridCollectionModelAllOfEmbedded**](GridCollectionModelAllOfEmbedded.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
15
doc/GridCollectionModelAllOfEmbedded.md
Normal file
15
doc/GridCollectionModelAllOfEmbedded.md
Normal file
@ -0,0 +1,15 @@
|
||||
# openapi.model.GridCollectionModelAllOfEmbedded
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**elements** | [**List<GridReadModel>**](GridReadModel.md) | | [default to const []]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
22
doc/GridReadModel.md
Normal file
22
doc/GridReadModel.md
Normal file
@ -0,0 +1,22 @@
|
||||
# openapi.model.GridReadModel
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **String** | |
|
||||
**id** | **int** | Grid's id |
|
||||
**rowCount** | **int** | The number of rows the grid has |
|
||||
**columnCount** | **int** | The number of columns the grid has |
|
||||
**widgets** | [**List<GridWidgetModel>**](GridWidgetModel.md) | | [default to const []]
|
||||
**createdAt** | [**DateTime**](DateTime.md) | The time the grid was created. | [optional]
|
||||
**updatedAt** | [**DateTime**](DateTime.md) | The time the grid was last updated. | [optional]
|
||||
**links** | [**GridReadModelLinks**](GridReadModelLinks.md) | |
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
21
doc/GridReadModelLinks.md
Normal file
21
doc/GridReadModelLinks.md
Normal file
@ -0,0 +1,21 @@
|
||||
# openapi.model.GridReadModelLinks
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**self** | [**GridReadModelLinksSelf**](GridReadModelLinksSelf.md) | |
|
||||
**attachments** | [**GridReadModelLinksAttachments**](GridReadModelLinksAttachments.md) | | [optional]
|
||||
**addAttachment** | [**GridReadModelLinksAddAttachment**](GridReadModelLinksAddAttachment.md) | | [optional]
|
||||
**scope** | [**GridReadModelLinksScope**](GridReadModelLinksScope.md) | |
|
||||
**updateImmediately** | [**GridReadModelLinksUpdateImmediately**](GridReadModelLinksUpdateImmediately.md) | | [optional]
|
||||
**update** | [**GridReadModelLinksUpdate**](GridReadModelLinksUpdate.md) | | [optional]
|
||||
**delete** | [**GridReadModelLinksDelete**](GridReadModelLinksDelete.md) | | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/GridReadModelLinksAddAttachment.md
Normal file
20
doc/GridReadModelLinksAddAttachment.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.GridReadModelLinksAddAttachment
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
20
doc/GridReadModelLinksAttachments.md
Normal file
20
doc/GridReadModelLinksAttachments.md
Normal file
@ -0,0 +1,20 @@
|
||||
# openapi.model.GridReadModelLinksAttachments
|
||||
|
||||
## Load the model package
|
||||
```dart
|
||||
import 'package:openapi/api.dart';
|
||||
```
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**href** | **String** | URL to the referenced resource (might be relative) |
|
||||
**title** | **String** | Representative label for the resource | [optional]
|
||||
**templated** | **bool** | If true the href contains parts that need to be replaced by the client | [optional] [default to false]
|
||||
**method** | **String** | The HTTP verb to use when requesting the resource | [optional] [default to 'GET']
|
||||
**payload** | [**Object**](.md) | The payload to send in the request to achieve the desired result | [optional]
|
||||
**identifier** | **String** | An optional unique identifier to the link object | [optional]
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user