ActivitiesApi.md

openproject_dart_sdk.api.ActivitiesApi

Load the API package

import 'package:openproject_dart_sdk/api.dart';

All URIs are relative to http://localhost

Method	HTTP request	Description
apiV3ActivitiesIdGet	GET /api/v3/activities/{id}	View activity
apiV3ActivitiesIdPatch	PATCH /api/v3/activities/{id}	Update activity

apiV3ActivitiesIdGet

Activity apiV3ActivitiesIdGet(id)

View activity

Example

import 'package:openproject_dart_sdk/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';
// TODO Configure OAuth2 access token for authorization: oAuth
//defaultApiClient.getAuthentication<OAuth>('oAuth').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ActivitiesApi();
final id = 56; // int | Activity id

try {
    final result = api_instance.apiV3ActivitiesIdGet(id);
    print(result);
} catch (e) {
    print('Exception when calling ActivitiesApi->apiV3ActivitiesIdGet: $e\n');
}

Parameters

Name	Type	Description	Notes
id	int	Activity id

Return type

Activity

Authorization

basicAuth, oAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

apiV3ActivitiesIdPatch

apiV3ActivitiesIdPatch(id, comment)

Update activity

Updates an activity's comment and, on success, returns the updated activity.

Example

import 'package:openproject_dart_sdk/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';
// TODO Configure OAuth2 access token for authorization: oAuth
//defaultApiClient.getAuthentication<OAuth>('oAuth').accessToken = 'YOUR_ACCESS_TOKEN';

final api_instance = ActivitiesApi();
final id = 56; // int | Activity id
final comment = Comment(); // Comment | 

try {
    api_instance.apiV3ActivitiesIdPatch(id, comment);
} catch (e) {
    print('Exception when calling ActivitiesApi->apiV3ActivitiesIdPatch: $e\n');
}

Parameters

Name	Type	Description	Notes
id	int	Activity id
comment	Comment		[optional]

Return type

void (empty response body)

Authorization

basicAuth, oAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/hal+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]