No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0-oas3
- Build package: org.openapitools.codegen.languages.DartClientCodegen
Dart 2.12 or later
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
openproject_dart_sdk:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
openproject_dart_sdk:
path: /path/to/openproject_dart_sdk
TODO
Please follow the installation procedure and then run the following:
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');
}
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActivitiesApi | apiV3ActivitiesIdGet | GET /api/v3/activities/{id} | View activity |
| ActivitiesApi | apiV3ActivitiesIdPatch | PATCH /api/v3/activities/{id} | Update activity |
| AttachmentsApi | apiV3AttachmentsIdDelete | DELETE /api/v3/attachments/{id} | Delete attachment |
| AttachmentsApi | apiV3AttachmentsIdGet | GET /api/v3/attachments/{id} | View attachment |
| AttachmentsApi | apiV3WorkPackagesIdAttachmentsGet | GET /api/v3/work_packages/{id}/attachments | List attachments |
| AttachmentsApi | apiV3WorkPackagesIdAttachmentsPost | POST /api/v3/work_packages/{id}/attachments | Add attachment |
| BudgetsApi | apiV3BudgetsIdGet | GET /api/v3/budgets/{id} | |
| CategoriesApi | apiV3CategoriesIdGet | GET /api/v3/categories/{id} | View Category |
| CategoriesApi | apiV3ProjectsProjectIdCategoriesGet | GET /api/v3/projects/{project_id}/categories | List categories of a project |
| CollectionsApi | apiV3ExamplesGet | GET /api/v3/examples | view aggregated result |
| ConfigurationApi | apiV3ConfigurationGet | GET /api/v3/configuration | View configuration |
| CustomActionsApi | apiV3CustomActionsCustomActionIdExecutePost | POST /api/v3/custom_actions/{custom_action_id}/execute | Execute custom action |
| CustomActionsApi | apiV3CustomActionsCustomActionIdGet | GET /api/v3/custom_actions/{custom_action_id} | View custom action |
| CustomObjectsApi | apiV3CustomObjectsIdGet | GET /api/v3/custom_objects/{id} | View Custom Object |
| FormsApi | apiV3ExampleFormPost | POST /api/v3/example/form | show or validate form |
| HelpTextsApi | apiV3HelpTextsGet | GET /api/v3/help_texts | List all help texts |
| HelpTextsApi | apiV3HelpTextsIdGet | GET /api/v3/help_texts/{id} | View help text |
| NewsApi | apiV3NewsGet | GET /api/v3/news | list news |
| NewsApi | apiV3NewsIdGet | GET /api/v3/news/{id} | view news |
| PreviewingApi | apiV3RenderPlainPost | POST /api/v3/render/plain | Preview plain document |
| PreviewingApi | apiV3RenderTextilePost | POST /api/v3/render/textile | Preview Textile document |
| PrincipalsApi | apiV3PrincipalsGet | GET /api/v3/principals | List principals |
| PrioritiesApi | apiV3PrioritiesGet | GET /api/v3/priorities | List all Priorities |
| PrioritiesApi | apiV3PrioritiesIdGet | GET /api/v3/priorities/{id} | View Priority |
| ProjectsApi | apiV3ProjectsAvailableParentProjectsGet | GET /api/v3/projects/available_parent_projects | list available parent project candidates |
| ProjectsApi | apiV3ProjectsGet | GET /api/v3/projects | List projects |
| ProjectsApi | apiV3ProjectsIdDelete | DELETE /api/v3/projects/{id} | delete project |
| ProjectsApi | apiV3ProjectsIdGet | GET /api/v3/projects/{id} | View project |
| ProjectsApi | apiV3ProjectsIdPatch | PATCH /api/v3/projects/{id} | update project |
| ProjectsApi | apiV3ProjectsPost | POST /api/v3/projects | create project |
| ProjectsApi | apiV3VersionsIdProjectsGet | GET /api/v3/versions/{id}/projects | List projects with version |
| QueriesApi | apiV3ProjectsIdQueriesDefaultGet | GET /api/v3/projects/{id}/queries/default | View default query for project |
| QueriesApi | apiV3ProjectsIdQueriesSchemaGet | GET /api/v3/projects/{id}/queries/schema | View schema for project queries |
| QueriesApi | apiV3QueriesAvailableProjectsGet | GET /api/v3/queries/available_projects | Available projects |
| QueriesApi | apiV3QueriesDefaultGet | GET /api/v3/queries/default | View default query |
| QueriesApi | apiV3QueriesFormPost | POST /api/v3/queries/form | Query Create Form |
| QueriesApi | apiV3QueriesGet | GET /api/v3/queries | List queries |
| QueriesApi | apiV3QueriesIdDelete | DELETE /api/v3/queries/{id} | Delete query |
| QueriesApi | apiV3QueriesIdGet | GET /api/v3/queries/{id} | View query |
| QueriesApi | apiV3QueriesIdPatch | PATCH /api/v3/queries/{id} | Edit Query |
| QueriesApi | apiV3QueriesIdStarPatch | PATCH /api/v3/queries/{id}/star | Star query |
| QueriesApi | apiV3QueriesIdUnstarPatch | PATCH /api/v3/queries/{id}/unstar | Unstar query |
| QueriesApi | apiV3QueriesPost | POST /api/v3/queries | Create query |
| QueriesApi | apiV3QueriesSchemaGet | GET /api/v3/queries/schema | View schema for global queries |
| QueryColumnsApi | apiV3QueriesColumnsIdGet | GET /api/v3/queries/columns/{id} | View Query Column |
| QueryFilterInstanceSchemaApi | apiV3ProjectsIdQueriesFilterInstanceSchemasGet | GET /api/v3/projects/{id}/queries/filter_instance_schemas | List Query Filter Instance Schemas for Project |
| QueryFilterInstanceSchemaApi | apiV3QueriesFilterInstanceSchemasGet | GET /api/v3/queries/filter_instance_schemas | List Query Filter Instance Schemas |
| QueryFilterInstanceSchemaApi | apiV3QueriesFilterInstanceSchemasIdentifierGet | GET /api/v3/queries/filter_instance_schemas/{identifier} | View Query Filter Instance Schema |
| QueryFiltersApi | apiV3QueriesFiltersIdGet | GET /api/v3/queries/filters/{id} | View Query Filter |
| QueryOperatorsApi | apiV3QueriesOperatorsIdGet | GET /api/v3/queries/operators/{id} | View Query Operator |
| QuerySortBysApi | apiV3QueriesSortBysIdGet | GET /api/v3/queries/sort_bys/{id} | View Query Sort By |
| RelationsApi | apiV3RelationsGet | GET /api/v3/relations | List Relations |
| RelationsApi | apiV3RelationsIdDelete | DELETE /api/v3/relations/{id} | Delete Relation |
| RelationsApi | apiV3RelationsIdFormPost | POST /api/v3/relations/{id}/form | Relation edit form |
| RelationsApi | apiV3RelationsIdGet | GET /api/v3/relations/{id} | View Relation |
| RelationsApi | apiV3RelationsIdPatch | PATCH /api/v3/relations/{id} | Edit Relation |
| RelationsApi | apiV3RelationsSchemaGet | GET /api/v3/relations/schema | View relation schema |
| RelationsApi | apiV3RelationsSchemaTypeGet | GET /api/v3/relations/schema/{type} | View relation schema for type |
| RevisionsApi | apiV3RevisionsIdGet | GET /api/v3/revisions/{id} | View revision |
| RolesApi | apiV3RolesGet | GET /api/v3/roles | List roles |
| RolesApi | apiV3RolesIdGet | GET /api/v3/roles/{id} | View role |
| RootApi | apiV3Get | GET /api/v3 | View root |
| SchemasApi | apiV3ExampleSchemaGet | GET /api/v3/example/schema | view the schema |
| StatusesApi | apiV3StatusesGet | GET /api/v3/statuses | List all Statuses |
| StatusesApi | apiV3StatusesIdGet | GET /api/v3/statuses/{id} | View Status |
| StringObjectsApi | apiV3StringObjectsGet | GET /api/v3/string_objects | View String Object |
| TimeEntriesApi | apiV3TimeEntriesGet | GET /api/v3/time_entries | List Time entries |
| TimeEntriesApi | apiV3TimeEntriesIdDelete | DELETE /api/v3/time_entries/{id} | delete time entry |
| TimeEntriesApi | apiV3TimeEntriesIdGet | GET /api/v3/time_entries/{id} | View time entry |
| TimeEntriesApi | apiV3TimeEntriesPost | POST /api/v3/time_entries | create time entry |
| TimeEntryActivitiesApi | apiV3TimeEntriesActivitiesIdGet | GET /api/v3/time_entries/activities/{id} | View time entries activity |
| TypesApi | apiV3ProjectsProjectIdTypesGet | GET /api/v3/projects/{project_id}/types | List types available in a project |
| TypesApi | apiV3TypesGet | GET /api/v3/types | List all Types |
| TypesApi | apiV3TypesIdGet | GET /api/v3/types/{id} | View Type |
| UserPreferencesApi | apiV3MyPreferencesGet | GET /api/v3/my_preferences | Show my preferences |
| UserPreferencesApi | apiV3MyPreferencesPatch | PATCH /api/v3/my_preferences | Update UserPreferences |
| UsersApi | apiV3UsersGet | GET /api/v3/users | List Users |
| UsersApi | apiV3UsersIdDelete | DELETE /api/v3/users/{id} | Delete user |
| UsersApi | apiV3UsersIdGet | GET /api/v3/users/{id} | View user |
| UsersApi | apiV3UsersIdLockDelete | DELETE /api/v3/users/{id}/lock | Remove Lock |
| UsersApi | apiV3UsersIdLockPost | POST /api/v3/users/{id}/lock | Set Lock |
| UsersApi | apiV3UsersIdPatch | PATCH /api/v3/users/{id} | Update user |
| UsersApi | apiV3UsersPost | POST /api/v3/users | Create User |
| VersionsApi | apiV3ProjectsProjectIdVersionsGet | GET /api/v3/projects/{project_id}/versions | List versions available in a project |
| VersionsApi | apiV3VersionsGet | GET /api/v3/versions | List versions |
| VersionsApi | apiV3VersionsIdGet | GET /api/v3/versions/{id} | View version |
| WorkPackagesApi | apiV3ProjectsIdWorkPackagesFormPost | POST /api/v3/projects/{id}/work_packages/form | Work Package Create Form |
| WorkPackagesApi | apiV3ProjectsIdWorkPackagesGet | GET /api/v3/projects/{id}/work_packages | List Work Packages |
| WorkPackagesApi | apiV3ProjectsIdWorkPackagesPost | POST /api/v3/projects/{id}/work_packages | Create Work Package |
| WorkPackagesApi | apiV3ProjectsProjectIdAvailableAssigneesGet | GET /api/v3/projects/{project_id}/available_assignees | Available assignees |
| WorkPackagesApi | apiV3ProjectsProjectIdAvailableResponsiblesGet | GET /api/v3/projects/{project_id}/available_responsibles | Available responsibles |
| WorkPackagesApi | apiV3WorkPackagesFormPost | POST /api/v3/work_packages/form | Work Package Create Form |
| WorkPackagesApi | apiV3WorkPackagesGet | GET /api/v3/work_packages | List Work Packages |
| WorkPackagesApi | apiV3WorkPackagesIdActivitiesGet | GET /api/v3/work_packages/{id}/activities | List work package activities |
| WorkPackagesApi | apiV3WorkPackagesIdActivitiesPost | POST /api/v3/work_packages/{id}/activities | Comment work package |
| WorkPackagesApi | apiV3WorkPackagesIdAvailableProjectsGet | GET /api/v3/work_packages/{id}/available_projects | Available projects |
| WorkPackagesApi | apiV3WorkPackagesIdAvailableRelationCandidatesGet | GET /api/v3/work_packages/{id}/available_relation_candidates | Available relation candidates |
| WorkPackagesApi | apiV3WorkPackagesIdAvailableWatchersGet | GET /api/v3/work_packages/{id}/available_watchers | Available watchers |
| WorkPackagesApi | apiV3WorkPackagesIdDelete | DELETE /api/v3/work_packages/{id} | Delete Work Package |
| WorkPackagesApi | apiV3WorkPackagesIdFormPost | POST /api/v3/work_packages/{id}/form | Work Package Edit Form |
| WorkPackagesApi | apiV3WorkPackagesIdGet | GET /api/v3/work_packages/{id} | View Work Package |
| WorkPackagesApi | apiV3WorkPackagesIdPatch | PATCH /api/v3/work_packages/{id} | Edit Work Package |
| WorkPackagesApi | apiV3WorkPackagesIdRelationsFormPost | POST /api/v3/work_packages/{id}/relations/form | Relation create form |
| WorkPackagesApi | apiV3WorkPackagesIdRevisionsGet | GET /api/v3/work_packages/{id}/revisions | Revisions |
| WorkPackagesApi | apiV3WorkPackagesPost | POST /api/v3/work_packages | Create Work Package |
| WorkPackagesApi | apiV3WorkPackagesSchemasGet | GET /api/v3/work_packages/schemas/ | List Work Package Schemas |
| WorkPackagesApi | apiV3WorkPackagesSchemasIdentifierGet | GET /api/v3/work_packages/schemas/{identifier} | View Work Package Schema |
| WorkPackagesApi | apiV3WorkPackagesWorkPackageIdRelationsGet | GET /api/v3/work_packages/{work_package_id}/relations | List relations |
| WorkPackagesApi | apiV3WorkPackagesWorkPackageIdRelationsPost | POST /api/v3/work_packages/{work_package_id}/relations | Create Relation |
| WorkPackagesApi | apiV3WorkPackagesWorkPackageIdWatchersGet | GET /api/v3/work_packages/{work_package_id}/watchers | List watchers |
| WorkPackagesApi | apiV3WorkPackagesWorkPackageIdWatchersIdDelete | DELETE /api/v3/work_packages/{work_package_id}/watchers/{id} | Remove watcher |
| WorkPackagesApi | apiV3WorkPackagesWorkPackageIdWatchersPost | POST /api/v3/work_packages/{work_package_id}/watchers | Add watcher |
- Activity
- ActivityLinks
- ApiV3CustomActionsCustomActionIdExecuteLinks
- ApiV3CustomActionsCustomActionIdExecuteLinksWorkPackage
- Attachment
- Budget
- BudgetLinks
- Categories
- CategoriesEmbedded
- Category
- CategoryLinks
- Comment
- Configuration
- Description
- Digest
- Filter
- InlineObject
- InlineObject1
- InlineObject2
- InlineObject3
- InlineObject4
- InlineObject5
- InlineObject6
- Link
- News
- NewsEmbedded
- NewsLinks
- NewsList
- NewsListEmbedded
- NewsListLinks
- Priorities
- PrioritiesEmbedded
- PrioritiesLinks
- Priority
- PriorityLinks
- Project
- ProjectLinks
- Projects
- ProjectsEmbedded
- ProjectsLinks
- Root
- RootLinks
- Status
- StatusLinks
- Statuses
- StatusesEmbedded
- StatusesLinks
- TimeEntries
- TimeEntriesActivity
- TimeEntriesActivityEmbedded
- TimeEntriesActivityLinks
- TimeEntriesEmbedded
- TimeEntriesLinks
- TimeEntry
- TimeEntryEmbedded
- TimeEntryLinks
- User
- UserLinks
- UserPreferences
- UserPreferencesLinks
- Users
- UsersEmbedded
- Version
- VersionLinks
- Versions
- VersionsEmbedded
- WPType
- WPTypeLinks
- WPTypes
- WPTypesEmbedded
- WorkPackage
- WorkPackageEmbedded
- WorkPackageLinks
- WorkPackagePatch
- WorkPackages
- WorkPackagesEmbedded
- Type: HTTP Basic authentication
- Type: OAuth
- Flow: accessCode
- Authorization URL: /oauth/authorize
- Scopes: N/A