Skip to content

Latest commit

 

History

History
339 lines (234 loc) · 11.9 KB

RelationsApi.md

File metadata and controls

339 lines (234 loc) · 11.9 KB
Raw

openproject_dart_sdk.api.RelationsApi

Load the API package

import 'package:openproject_dart_sdk/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
apiV3RelationsGet GET /api/v3/relations List Relations
apiV3RelationsIdDelete DELETE /api/v3/relations/{id} Delete Relation
apiV3RelationsIdFormPost POST /api/v3/relations/{id}/form Relation edit form
apiV3RelationsIdGet GET /api/v3/relations/{id} View Relation
apiV3RelationsIdPatch PATCH /api/v3/relations/{id} Edit Relation
apiV3RelationsSchemaGet GET /api/v3/relations/schema View relation schema
apiV3RelationsSchemaTypeGet GET /api/v3/relations/schema/{type} View relation schema for type

apiV3RelationsGet

apiV3RelationsGet(filters, sortBy)

List Relations

Lists all relations according to the given (optional, logically conjunctive) filters and ordered by ID. The response only includes relations between work packages which the user is allowed to see.

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 = RelationsApi();
final filters = filters_example; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](#queries) endpoint. Valid fields to filter by are:  + id - ID of relation  + from - ID of work package from which the filtered relations emanates.  + to - ID of work package to which this related points.  + involved - ID of either the `from` or the `to` work package.  + type - The type of relation to filter by, e.g. \"follows\".
final sortBy = sortBy_example; // String | JSON specifying sort criteria. Accepts the same format as returned by the [queries](#queries) endpoint.

try {
    api_instance.apiV3RelationsGet(filters, sortBy);
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsGet: $e\n');
}

Parameters

Name Type Description Notes
filters String JSON specifying filter conditions. Accepts the same format as returned by the queries endpoint. Valid fields to filter by are: + id - ID of relation + from - ID of work package from which the filtered relations emanates. + to - ID of work package to which this related points. + involved - ID of either the from or the to work package. + type - The type of relation to filter by, e.g. "follows". [optional]
sortBy String JSON specifying sort criteria. Accepts the same format as returned by the queries endpoint. [optional]

Return type

void (empty response body)

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]

apiV3RelationsIdDelete

apiV3RelationsIdDelete(id)

Delete Relation

Deletes the relation.

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 = RelationsApi();
final id = 56; // int | Relation ID

try {
    api_instance.apiV3RelationsIdDelete(id);
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsIdDelete: $e\n');
}

Parameters

Name Type Description Notes
id int Relation ID

Return type

void (empty response body)

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]

apiV3RelationsIdFormPost

apiV3RelationsIdFormPost(id)

Relation edit form

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 = RelationsApi();
final id = 56; // int | ID of the relation being modified

try {
    api_instance.apiV3RelationsIdFormPost(id);
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsIdFormPost: $e\n');
}

Parameters

Name Type Description Notes
id int ID of the relation being modified

Return type

void (empty response body)

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]

apiV3RelationsIdGet

apiV3RelationsIdGet(id)

View Relation

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 = RelationsApi();
final id = 56; // int | Relation id

try {
    api_instance.apiV3RelationsIdGet(id);
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsIdGet: $e\n');
}

Parameters

Name Type Description Notes
id int Relation id

Return type

void (empty response body)

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]

apiV3RelationsIdPatch

apiV3RelationsIdPatch(id)

Edit Relation

When calling this endpoint the client provides a single object, containing the properties and links that it wants to change, in the body. It is only allowed to provide properties or links supporting the write operation. Note that changing the type of a relation invariably also changes the respective reverseType as well as the "name" of it. The returned Relation object will reflect that change. For instance if you change a Relation's type to "follows" then the reverseType will be changed to precedes.

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 = RelationsApi();
final id = 56; // int | Relation ID

try {
    api_instance.apiV3RelationsIdPatch(id);
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsIdPatch: $e\n');
}

Parameters

Name Type Description Notes
id int Relation ID

Return type

void (empty response body)

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]

apiV3RelationsSchemaGet

apiV3RelationsSchemaGet()

View relation schema

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 = RelationsApi();

try {
    api_instance.apiV3RelationsSchemaGet();
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsSchemaGet: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

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]

apiV3RelationsSchemaTypeGet

apiV3RelationsSchemaTypeGet(type)

View relation schema for type

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 = RelationsApi();
final type = type_example; // String | Type of the schema

try {
    api_instance.apiV3RelationsSchemaTypeGet(type);
} catch (e) {
    print('Exception when calling RelationsApi->apiV3RelationsSchemaTypeGet: $e\n');
}

Parameters

Name Type Description Notes
type String Type of the schema

Return type

void (empty response body)

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]