Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 5.55 KB

QueryFilterInstanceSchemaApi.md

File metadata and controls

153 lines (104 loc) · 5.55 KB

openproject_dart_sdk.api.QueryFilterInstanceSchemaApi

Load the API package

import 'package:openproject_dart_sdk/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
apiV3ProjectsIdQueriesFilterInstanceSchemasGet GET /api/v3/projects/{id}/queries/filter_instance_schemas List Query Filter Instance Schemas for Project
apiV3QueriesFilterInstanceSchemasGet GET /api/v3/queries/filter_instance_schemas List Query Filter Instance Schemas
apiV3QueriesFilterInstanceSchemasIdentifierGet GET /api/v3/queries/filter_instance_schemas/{identifier} View Query Filter Instance Schema

apiV3ProjectsIdQueriesFilterInstanceSchemasGet

apiV3ProjectsIdQueriesFilterInstanceSchemasGet(id)

List Query Filter Instance Schemas for Project

Returns the list of QueryFilterInstanceSchemas defined for a query of the specified project.

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 = QueryFilterInstanceSchemaApi();
final id = 56; // int | Id of the project.

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

Parameters

Name Type Description Notes
id int Id of the project.

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]

apiV3QueriesFilterInstanceSchemasGet

apiV3QueriesFilterInstanceSchemasGet()

List Query Filter Instance Schemas

Returns the list of QueryFilterInstanceSchemas defined for a global query. That is a query not assigned to a project.

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

try {
    api_instance.apiV3QueriesFilterInstanceSchemasGet();
} catch (e) {
    print('Exception when calling QueryFilterInstanceSchemaApi->apiV3QueriesFilterInstanceSchemasGet: $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]

apiV3QueriesFilterInstanceSchemasIdentifierGet

apiV3QueriesFilterInstanceSchemasIdentifierGet(identifier)

View Query Filter Instance Schema

Retreive an individual QueryFilterInstanceSchema as identified by the id parameter.

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 = QueryFilterInstanceSchemaApi();
final identifier = identifier_example; // String | QueryFilterInstanceSchema identifier. The identifier is the filter identifier.

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

Parameters

Name Type Description Notes
identifier String QueryFilterInstanceSchema identifier. The identifier is the filter identifier.

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]