Skip to content

gosticks/open-project-flutter-api

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits

doc

doc

 
 

lib

lib

 
 

test

test

 
 

README.md

README.md

 
 

analysis_options.yaml

analysis_options.yaml

 
 

git_push.sh

git_push.sh

 
 

pubspec.lock

pubspec.lock

 
 

pubspec.yaml

pubspec.yaml

 
 

spec.yml

spec.yml

 
 

Repository files navigation

openapi

You're looking at the current stable documentation of the OpenProject APIv3. If you're interested in the current development version, please go to github.com/opf.

Introduction

The documentation for the APIv3 is written according to the OpenAPI 3.0 Specification. You can either view the static version of this documentation on the website or the interactive version, rendered with OpenAPI Explorer, in your OpenProject installation under /api/docs. In the latter you can try out the various API endpoints directly interacting with our OpenProject data. Moreover you can access the specification source itself under /api/v3/spec.json and /api/v3/spec.yml (e.g. here).

The APIv3 is a hypermedia REST API, a shorthand for "Hypermedia As The Engine Of Application State" (HATEOAS). This means that each endpoint of this API will have links to other resources or actions defined in the resulting body.

These related resources and actions for any given resource will be context sensitive. For example, only actions that the authenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any given response.

As an example, if you fetch a work package through the Work Package endpoint, the update link will only be present when the user you authenticated has been granted a permission to update the work package in the assigned project.

HAL+JSON

HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API. Read more in the following specification: https://tools.ietf.org/html/draft-kelly-json-hal-08

OpenProject API implementation of HAL+JSON format enriches JSON and introduces a few meta properties:

  • _type - specifies the type of the resource (e.g.: WorkPackage, Project)
  • _links - contains all related resource and action links available for the resource
  • _embedded - contains all embedded objects

HAL does not guarantee that embedded resources are embedded in their full representation, they might as well be partially represented (e.g. some properties can be left out). However in this API you have the guarantee that whenever a resource is embedded, it is embedded in its full representation.

API response structure

All API responses contain a single HAL+JSON object, even collections of objects are technically represented by a single HAL+JSON object that itself contains its members. More details on collections can be found in the Collections Section.

Authentication

The API supports the following authentication schemes: OAuth2, session based authentication, and basic auth.

Depending on the settings of the OpenProject instance many resources can be accessed without being authenticated. In case the instance requires authentication on all requests the client will receive an HTTP 401 status code in response to any request.

Otherwise unauthenticated clients have all the permissions of the anonymous user.

Session-based Authentication

This means you have to login to OpenProject via the Web-Interface to be authenticated in the API. This method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.

In this case, you always need to pass the HTTP header X-Requested-With \"XMLHttpRequest\" for authentication.

API Key through Basic Auth

Users can authenticate towards the API v3 using basic auth with the user name apikey (NOT your login) and the API key as the password. Users can find their API key on their account page.

Example:

API_KEY=2519132cdf62dcf5a66fd96394672079f9e9cad1
curl -u apikey:$API_KEY https://community.openproject.com/api/v3/users/42

OAuth2.0 authentication

OpenProject allows authentication and authorization with OAuth2 with Authorization code flow, as well as Client credentials operation modes.

To get started, you first need to register an application in the OpenProject OAuth administration section of your installation. This will save an entry for your application with a client unique identifier (client_id) and an accompanying secret key (client_secret).

You can then use one the following guides to perform the supported OAuth 2.0 flows:

Why not username and password?

The simplest way to do basic auth would be to use a user's username and password naturally. However, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.

Using username and password directly would have some advantages:

  • It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.

  • No extra logic for token management necessary.

On the other hand using API keys has some advantages too, which is why we went for that:

  • If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.

  • They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.

Most importantly users may not actually have a password to begin with. Specifically when they have registered through an OpenID Connect provider.

Cross-Origin Resource Sharing (CORS)

By default, the OpenProject API is not responding with any CORS headers. If you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.

Please see our API settings documentation on how to selectively enable CORS.

Allowed HTTP methods

  • GET - Get a single resource or collection of resources

  • POST - Create a new resource or perform

  • PATCH - Update a resource

  • DELETE - Delete a resource

Compression

Responses are compressed if requested by the client. Currently gzip and deflate are supported. The client signals the desired compression by setting the Accept-Encoding header. If no Accept-Encoding header is send, Accept-Encoding: identity is assumed which will result in the API responding uncompressed.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 3
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

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 = ActionsCapabilitiesApi();
final filters = [{ "id": { "operator": "=", "values": ["memberships/create"] }" }]; // String | JSON specifying filter conditions. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported filters are:  + id: Returns only the action having the id or all actions except those having the id(s).
final sortBy = [["id", "asc"]]; // String | JSON specifying sort criteria. Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Currently supported sorts are:  + *No sort supported yet*

try {
    final result = api_instance.listActions(filters, sortBy);
    print(result);
} catch (e) {
    print('Exception when calling ActionsCapabilitiesApi->listActions: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://community.openproject.org

Class Method HTTP request Description
ActionsCapabilitiesApi listActions GET /api/v3/actions List actions
ActionsCapabilitiesApi listCapabilities GET /api/v3/capabilities List capabilities
ActionsCapabilitiesApi viewAction GET /api/v3/actions/{id} View action
ActionsCapabilitiesApi viewCapabilities GET /api/v3/capabilities/{id} View capabilities
ActionsCapabilitiesApi viewGlobalContext GET /api/v3/capabilities/context/global View global context
ActivitiesApi updateActivity PATCH /api/v3/activities/{id} Update activity
ActivitiesApi viewActivity GET /api/v3/activities/{id} View activity
AttachmentsApi addAttachmentToPost POST /api/v3/posts/{id}/attachments Add attachment to post
AttachmentsApi addAttachmentToWikiPage POST /api/v3/wiki_pages/{id}/attachments Add attachment to wiki page
AttachmentsApi createAttachment POST /api/v3/attachments Create Attachment
AttachmentsApi createWorkPackageAttachment POST /api/v3/work_packages/{id}/attachments Create work package attachment
AttachmentsApi deleteAttachment DELETE /api/v3/attachments/{id} Delete attachment
AttachmentsApi listAttachmentsByPost GET /api/v3/posts/{id}/attachments List attachments by post
AttachmentsApi listAttachmentsByWikiPage GET /api/v3/wiki_pages/{id}/attachments List attachments by wiki page
AttachmentsApi listWorkPackageAttachments GET /api/v3/work_packages/{id}/attachments List attachments by work package
AttachmentsApi viewAttachment GET /api/v3/attachments/{id} View attachment
BudgetsApi viewBudget GET /api/v3/budgets/{id} view Budget
BudgetsApi viewBudgetsOfAProject GET /api/v3/projects/{id}/budgets view Budgets of a Project
CategoriesApi listCategoriesOfAProject GET /api/v3/projects/{id}/categories List categories of a project
CategoriesApi viewCategory GET /api/v3/categories/{id} View Category
CollectionsApi viewAggregatedResult GET /api/v3/examples view aggregated result
ConfigurationApi viewConfiguration GET /api/v3/configuration View configuration
CustomActionsApi executeCustomAction POST /api/v3/custom_actions/{id}/execute Execute custom action
CustomActionsApi getCustomAction GET /api/v3/custom_actions/{id} Get a custom action
CustomOptionsApi viewCustomOption GET /api/v3/custom_options/{id} View Custom Option
DocumentsApi listDocuments GET /api/v3/documents List Documents
DocumentsApi viewDocument GET /api/v3/documents/{id} View document
FileLinksApi createStorage POST /api/v3/storages Creates a storage.
FileLinksApi createStorageOauthCredentials POST /api/v3/storages/{id}/oauth_client_credentials Creates an oauth client credentials object for a storage.
FileLinksApi createWorkPackageFileLink POST /api/v3/work_packages/{id}/file_links Creates file links.
FileLinksApi deleteFileLink DELETE /api/v3/file_links/{id} Removes a file link.
FileLinksApi deleteStorage DELETE /api/v3/storages/{id} Delete a storage
FileLinksApi downloadFileLink GET /api/v3/file_links/{id}/download Creates a download uri of the linked file.
FileLinksApi getProjectStorage GET /api/v3/project_storages/{id} Gets a project storage
FileLinksApi getStorage GET /api/v3/storages/{id} Get a storage
FileLinksApi getStorageFiles GET /api/v3/storages/{id}/files Gets files of a storage.
FileLinksApi listProjectStorages GET /api/v3/project_storages Gets a list of project storages
FileLinksApi listWorkPackageFileLinks GET /api/v3/work_packages/{id}/file_links Gets all file links of a work package
FileLinksApi openFileLink GET /api/v3/file_links/{id}/open Creates an opening uri of the linked file.
FileLinksApi prepareStorageFileUpload POST /api/v3/storages/{id}/files/prepare_upload Preparation of a direct upload of a file to the given storage.
FileLinksApi updateStorage PATCH /api/v3/storages/{id} Update a storage
FileLinksApi viewFileLink GET /api/v3/file_links/{id} Gets a file link.
FormsApi showOrValidateForm POST /api/v3/example/form show or validate form
GridsApi createGrid POST /api/v3/grids Create a grid
GridsApi getGrid GET /api/v3/grids/{id} Get a grid
GridsApi gridCreateForm POST /api/v3/grids/form Grid Create Form
GridsApi gridUpdateForm POST /api/v3/grids/{id}/form Grid Update Form
GridsApi listGrids GET /api/v3/grids List grids
GridsApi updateGrid PATCH /api/v3/grids/{id} Update a grid
GroupsApi createGroup POST /api/v3/groups Create group
GroupsApi deleteGroup DELETE /api/v3/groups/{id} Delete group
GroupsApi getGroup GET /api/v3/groups/{id} Get group
GroupsApi listGroups GET /api/v3/groups List groups
GroupsApi updateGroup PATCH /api/v3/groups/{id} Update group
HelpTextsApi getHelpText GET /api/v3/help_texts/{id} Get help text
HelpTextsApi listHelpTexts GET /api/v3/help_texts List help texts
MembershipsApi availableProjectsForMemberships GET /api/v3/memberships/available_projects Available projects for memberships
MembershipsApi createMembership POST /api/v3/memberships Create membership
MembershipsApi deleteMembership DELETE /api/v3/memberships/{id} Delete membership
MembershipsApi listMemberships GET /api/v3/memberships List memberships
MembershipsApi membershipCreateForm POST /api/v3/memberships/form Membership create form
MembershipsApi membershipUpdateForm POST /api/v3/memberships/{id}/form Membership update form
MembershipsApi updateMembership PATCH /api/v3/memberships/{id} Update membership
MembershipsApi viewMembership GET /api/v3/memberships/{id} View membership
MembershipsApi viewMembershipSchema GET /api/v3/memberships/schema View membership schema
NewsApi listNews GET /api/v3/news List News
NewsApi viewNews GET /api/v3/news/{id} View news
NotificationsApi listNotifications GET /api/v3/notifications Get notification collection
NotificationsApi readNotification POST /api/v3/notifications/{id}/read_ian Read notification
NotificationsApi readNotifications POST /api/v3/notifications/read_ian Read all notifications
NotificationsApi unreadNotification POST /api/v3/notifications/{id}/unread_ian Unread notification
NotificationsApi unreadNotifications POST /api/v3/notifications/unread_ian Unread all notifications
NotificationsApi viewNotification GET /api/v3/notifications/{id} Get the notification
NotificationsApi viewNotificationDetail GET /api/v3/notifications/{notification_id}/details/{id} Get a notification detail
OAuth2Api getOauthApplication GET /api/v3/oauth_applications/{id} Get the oauth application.
OAuth2Api getOauthClientCredentials GET /api/v3/oauth_client_credentials/{id} Get the oauth client credentials object.
PostsApi viewPost GET /api/v3/posts/{id} View Post
PreviewingApi previewMarkdownDocument POST /api/v3/render/markdown Preview Markdown document
PreviewingApi previewPlainDocument POST /api/v3/render/plain Preview plain document
PrincipalsApi listPrincipals GET /api/v3/principals List principals
PrioritiesApi listAllPriorities GET /api/v3/priorities List all Priorities
PrioritiesApi viewPriority GET /api/v3/priorities/{id} View Priority
ProjectsApi createProject POST /api/v3/projects Create project
ProjectsApi createProjectCopy POST /api/v3/projects/{id}/copy Create project copy
ProjectsApi deleteProject DELETE /api/v3/projects/{id} Delete Project
ProjectsApi listAvailableParentProjectCandidates GET /api/v3/projects/available_parent_projects List available parent project candidates
ProjectsApi listProjects GET /api/v3/projects List projects
ProjectsApi listProjectsWithVersion GET /api/v3/versions/{id}/projects List projects having version
ProjectsApi projectCopyForm POST /api/v3/projects/{id}/copy/form Project copy form
ProjectsApi projectCreateForm POST /api/v3/projects/form Project create form
ProjectsApi projectUpdateForm POST /api/v3/projects/{id}/form Project update form
ProjectsApi updateProject PATCH /api/v3/projects/{id} Update Project
ProjectsApi viewProject GET /api/v3/projects/{id} View project
ProjectsApi viewProjectSchema GET /api/v3/projects/schema View project schema
ProjectsApi viewProjectStatus GET /api/v3/project_statuses/{id} View project status
QueriesApi availableProjectsForQuery GET /api/v3/queries/available_projects Available projects for query
QueriesApi createQuery POST /api/v3/queries Create query
QueriesApi deleteQuery DELETE /api/v3/queries/{id} Delete query
QueriesApi editQuery PATCH /api/v3/queries/{id} Edit Query
QueriesApi listQueries GET /api/v3/queries List queries
QueriesApi queryCreateForm POST /api/v3/queries/form Query Create Form
QueriesApi queryUpdateForm POST /api/v3/queries/{id}/form Query Update Form
QueriesApi starQuery PATCH /api/v3/queries/{id}/star Star query
QueriesApi unstarQuery PATCH /api/v3/queries/{id}/unstar Unstar query
QueriesApi viewDefaultQuery GET /api/v3/queries/default View default query
QueriesApi viewDefaultQueryForProject GET /api/v3/projects/{id}/queries/default View default query for project
QueriesApi viewQuery GET /api/v3/queries/{id} View query
QueriesApi viewSchemaForGlobalQueries GET /api/v3/queries/schema View schema for global queries
QueriesApi viewSchemaForProjectQueries GET /api/v3/projects/{id}/queries/schema View schema for project queries
QueryColumnsApi viewQueryColumn GET /api/v3/queries/columns/{id} View Query Column
QueryFilterInstanceSchemaApi listQueryFilterInstanceSchemas GET /api/v3/queries/filter_instance_schemas List Query Filter Instance Schemas
QueryFilterInstanceSchemaApi listQueryFilterInstanceSchemasForProject GET /api/v3/projects/{id}/queries/filter_instance_schemas List Query Filter Instance Schemas for Project
QueryFilterInstanceSchemaApi viewQueryFilterInstanceSchema GET /api/v3/queries/filter_instance_schemas/{id} View Query Filter Instance Schema
QueryFiltersApi viewQueryFilter GET /api/v3/queries/filters/{id} View Query Filter
QueryOperatorsApi viewQueryOperator GET /api/v3/queries/operators/{id} View Query Operator
QuerySortBysApi viewQuerySortBy GET /api/v3/queries/sort_bys/{id} View Query Sort By
RelationsApi deleteRelation DELETE /api/v3/relations/{id} Delete Relation
RelationsApi editRelation PATCH /api/v3/relations/{id} Edit Relation
RelationsApi listRelations GET /api/v3/relations List Relations
RelationsApi relationEditForm POST /api/v3/relations/{id}/form Relation edit form
RelationsApi viewRelation GET /api/v3/relations/{id} View Relation
RelationsApi viewRelationSchema GET /api/v3/relations/schema View relation schema
RelationsApi viewRelationSchemaForType GET /api/v3/relations/schema/{type} View relation schema for type
RevisionsApi viewRevision GET /api/v3/revisions/{id} View revision
RolesApi listRoles GET /api/v3/roles List roles
RolesApi viewRole GET /api/v3/roles/{id} View role
RootApi viewRoot GET /api/v3 View root
SchemasApi viewTheSchema GET /api/v3/example/schema view the schema
StatusesApi listAllStatuses GET /api/v3/statuses List all Statuses
StatusesApi viewStatus GET /api/v3/statuses/{id} View Status
TimeEntriesApi availableProjectsForTimeEntries GET /api/v3/time_entries/available_projects Available projects for time entries
TimeEntriesApi createTimeEntry POST /api/v3/time_entries Create time entry
TimeEntriesApi deleteTimeEntry DELETE /api/v3/time_entries/{id} Delete time entry
TimeEntriesApi getTimeEntry GET /api/v3/time_entries/{id} Get time entry
TimeEntriesApi listTimeEntries GET /api/v3/time_entries List time entries
TimeEntriesApi timeEntryCreateForm POST /api/v3/time_entries/form Time entry create form
TimeEntriesApi timeEntryUpdateForm POST /api/v3/time_entries/{id}/form Time entry update form
TimeEntriesApi updateTimeEntry PATCH /api/v3/time_entries/{id} update time entry
TimeEntriesApi viewTimeEntrySchema GET /api/v3/time_entries/schema View time entry schema
TimeEntryActivitiesApi getTimeEntriesActivity GET /api/v3/time_entries/activity/{id} View time entries activity
TypesApi listAllTypes GET /api/v3/types List all Types
TypesApi listTypesAvailableInAProject GET /api/v3/projects/{id}/types List types available in a project
TypesApi viewType GET /api/v3/types/{id} View Type
UserPreferencesApi showMyPreferences GET /api/v3/my_preferences Show my preferences
UserPreferencesApi updateUserPreferences PATCH /api/v3/my_preferences Update my preferences
UsersApi createUser POST /api/v3/users Create User
UsersApi deleteUser DELETE /api/v3/users/{id} Delete user
UsersApi listUsers GET /api/v3/users List Users
UsersApi lockUser POST /api/v3/users/{id}/lock Lock user
UsersApi unlockUser DELETE /api/v3/users/{id}/lock Unlock user
UsersApi updateUser PATCH /api/v3/users/{id} Update user
UsersApi userUpdateForm POST /api/v3/users/{id}/form User update form
UsersApi viewUser GET /api/v3/users/{id} View user
UsersApi viewUserSchema GET /api/v3/users/schema View user schema
ValuesPropertyApi viewNotificationDetail GET /api/v3/notifications/{notification_id}/details/{id} Get a notification detail
ValuesPropertyApi viewValuesSchema GET /api/v3/values/schema/{id} View Values schema
VersionsApi availableProjectsForVersions GET /api/v3/versions/available_projects Available projects for versions
VersionsApi createVersion POST /api/v3/versions Create version
VersionsApi deleteVersion DELETE /api/v3/versions/{id} Delete version
VersionsApi listVersions GET /api/v3/versions List versions
VersionsApi listVersionsAvailableInAProject GET /api/v3/projects/{id}/versions List versions available in a project
VersionsApi updateVersion PATCH /api/v3/versions/{id} Update Version
VersionsApi versionCreateForm POST /api/v3/versions/form Version create form
VersionsApi versionUpdateForm POST /api/v3/versions/{id}/form Version update form
VersionsApi viewVersion GET /api/v3/versions/{id} View version
VersionsApi viewVersionSchema GET /api/v3/versions/schema View version schema
ViewsApi createViews POST /api/v3/views/{id} Create view
ViewsApi listViews GET /api/v3/views List views
ViewsApi viewView GET /api/v3/views/{id} View view
WikiPagesApi viewWikiPage GET /api/v3/wiki_pages/{id} View Wiki Page
WorkPackagesApi addWatcher POST /api/v3/work_packages/{id}/watchers Add watcher
WorkPackagesApi availableAssignees GET /api/v3/projects/{id}/available_assignees Available assignees
WorkPackagesApi availableProjectsForWorkPackage GET /api/v3/work_packages/{id}/available_projects Available projects for work package
WorkPackagesApi availableResponsibles GET /api/v3/projects/{id}/available_responsibles Available responsibles
WorkPackagesApi availableWatchers GET /api/v3/work_packages/{id}/available_watchers Available watchers
WorkPackagesApi commentWorkPackage POST /api/v3/work_packages/{id}/activities Comment work package
WorkPackagesApi createProjectWorkPackage POST /api/v3/projects/{id}/work_packages Create work package in project
WorkPackagesApi createRelation POST /api/v3/work_packages/{id}/relations Create Relation
WorkPackagesApi createWorkPackage POST /api/v3/work_packages Create Work Package
WorkPackagesApi createWorkPackageFileLink POST /api/v3/work_packages/{id}/file_links Creates file links.
WorkPackagesApi deleteWorkPackage DELETE /api/v3/work_packages/{id} Delete Work Package
WorkPackagesApi getProjectWorkPackageCollection GET /api/v3/projects/{id}/work_packages Get work packages of project
WorkPackagesApi listAvailableRelationCandidates GET /api/v3/work_packages/{id}/available_relation_candidates Available relation candidates
WorkPackagesApi listRelations GET /api/v3/work_packages/{id}/relations List relations
WorkPackagesApi listWatchers GET /api/v3/work_packages/{id}/watchers List watchers
WorkPackagesApi listWorkPackageActivities GET /api/v3/work_packages/{id}/activities List work package activities
WorkPackagesApi listWorkPackageFileLinks GET /api/v3/work_packages/{id}/file_links Gets all file links of a work package
WorkPackagesApi listWorkPackageSchemas GET /api/v3/work_packages/schemas List Work Package Schemas
WorkPackagesApi listWorkPackages GET /api/v3/work_packages List work packages
WorkPackagesApi removeWatcher DELETE /api/v3/work_packages/{id}/watchers/{user_id} Remove watcher
WorkPackagesApi revisions GET /api/v3/work_packages/{id}/revisions Revisions
WorkPackagesApi updateWorkPackage PATCH /api/v3/work_packages/{id} Update a Work Package
WorkPackagesApi viewWorkPackage GET /api/v3/work_packages/{id} View Work Package
WorkPackagesApi viewWorkPackageSchema GET /api/v3/work_packages/schemas/{identifier} View Work Package Schema
WorkPackagesApi workPackageCreateForm POST /api/v3/work_packages/form Work Package Create Form
WorkPackagesApi workPackageCreateFormForProject POST /api/v3/projects/{id}/work_packages/form Work Package Create Form For Project
WorkPackagesApi workPackageEditForm POST /api/v3/work_packages/{id}/form Work Package Edit Form
WorkScheduleApi createNonWorkingDay POST /api/v3/days/non_working Creates a non-working day (NOT IMPLEMENTED)
WorkScheduleApi deleteNonWorkingDay DELETE /api/v3/days/non_working/{date} Removes a non-working day (NOT IMPLEMENTED)
WorkScheduleApi listDays GET /api/v3/days Lists days
WorkScheduleApi listNonWorkingDays GET /api/v3/days/non_working Lists all non working days
WorkScheduleApi listWeekDays GET /api/v3/days/week Lists week days
WorkScheduleApi updateNonWorkingDay PATCH /api/v3/days/non_working/{date} Update a non-working day attributes (NOT IMPLEMENTED)
WorkScheduleApi updateWeekDay PATCH /api/v3/days/week/{day} Update a week day attributes (NOT IMPLEMENTED)
WorkScheduleApi updateWeekDays PATCH /api/v3/days/week Update week days (NOT IMPLEMENTED)
WorkScheduleApi viewDay GET /api/v3/days/{date} View day
WorkScheduleApi viewNonWorkingDay GET /api/v3/days/non_working/{date} View a non-working day
WorkScheduleApi viewWeekDay GET /api/v3/days/week/{day} View a week day

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP Basic authentication

Author

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages