open-project-flutter-api/doc/PrioritiesApi.md
2023-11-05 19:54:17 +01:00

104 lines
2.6 KiB
Markdown

# openapi.api.PrioritiesApi
## Load the API package
```dart
import 'package:openapi/api.dart';
```
All URIs are relative to *https://community.openproject.org*
Method | HTTP request | Description
------------- | ------------- | -------------
[**listAllPriorities**](PrioritiesApi.md#listallpriorities) | **GET** /api/v3/priorities | List all Priorities
[**viewPriority**](PrioritiesApi.md#viewpriority) | **GET** /api/v3/priorities/{id} | View Priority
# **listAllPriorities**
> Object listAllPriorities()
List all Priorities
### 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 = PrioritiesApi();
try {
final result = api_instance.listAllPriorities();
print(result);
} catch (e) {
print('Exception when calling PrioritiesApi->listAllPriorities: $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)
# **viewPriority**
> PriorityModel viewPriority(id)
View Priority
### 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 = PrioritiesApi();
final id = 1; // int | Priority id
try {
final result = api_instance.viewPriority(id);
print(result);
} catch (e) {
print('Exception when calling PrioritiesApi->viewPriority: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **int**| Priority id |
### Return type
[**PriorityModel**](PriorityModel.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)