teamwork-server-api v1.0.0
teamwork-server-api
TeamworkServerApi - JavaScript client for teamwork-server-api Teamwork Server API This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2016-06-14T06:44:35.780Z
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install teamwork-server-api --save
git
If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/teamwork-server-api then install it via:
npm install YOUR_USERNAME/teamwork-server-api --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Getting Started
Please follow the installation instruction and execute the following JS code:
var TeamworkServerApi = require('teamwork-server-api');
var api = new TeamworkServerApi.ClientApi()
var corsDomain = new TeamworkServerApi.CORSDomain(); // {CORSDomain} CORS is removed sucessfully
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.azClientStorageaccessDelete(corsDomain, callback);
Documentation for API Endpoints
All URIs are relative to http://esqteamworkapi.azurewebsites.net/v1
Class | Method | HTTP request | Description |
---|---|---|---|
TeamworkServerApi.ClientApi | azClientStorageaccessDelete | DELETE /az/client/storageaccess | Un-Grant CORS to a particular domain for the Azure Storage Account. |
TeamworkServerApi.ClientApi | azClientStorageaccessGet | GET /az/client/storageaccess | Get domains granted with CORS for the Azure Storage Account. |
TeamworkServerApi.ClientApi | azClientStorageaccessPost | POST /az/client/storageaccess | Grant CORS to a particular domain for the Azure Storage Account. |
TeamworkServerApi.ClientApi | azClientStorageaccessStorageAccountStorageKeyGet | GET /az/client/storageaccess/{storageAccount}/{storageKey} | Get domains granted with CORS for the Azure Storage Account. |
TeamworkServerApi.DefaultApi | azClientStorageaccessOptions | OPTIONS /az/client/storageaccess | CORS Preflight request |
TeamworkServerApi.DefaultApi | azDeptNameOptions | OPTIONS /az/dept/{name} | CORS Preflight request |
TeamworkServerApi.DefaultApi | azDeptNameTasksOptions | OPTIONS /az/dept/{name}/tasks | CORS Preflight request |
TeamworkServerApi.DefaultApi | azDeptNameWorksWorkNameOptions | OPTIONS /az/dept/{name}/works/{workName} | CORS Preflight request |
TeamworkServerApi.DefaultApi | azDeptOptions | OPTIONS /az/dept | CORS Preflight request |
TeamworkServerApi.DefaultApi | azOrgOptions | OPTIONS /az/org | CORS Preflight request |
TeamworkServerApi.DepartmentApi | azDeptGet | GET /az/dept | Get all departments of an organization |
TeamworkServerApi.DepartmentApi | azDeptNameDelete | DELETE /az/dept/{name} | Delete a department from an organization. |
TeamworkServerApi.DepartmentApi | azDeptNameGet | GET /az/dept/{name} | Get a department of an organization |
TeamworkServerApi.DepartmentApi | azDeptNamePost | POST /az/dept/{name} | Add a department to an organization. If the department already exists, it will be updated. |
TeamworkServerApi.OrganizationApi | azOrgDelete | DELETE /az/org | Delete an organization. |
TeamworkServerApi.OrganizationApi | azOrgPost | POST /az/org | Create a new organization |
TeamworkServerApi.TaskApi | azDeptNameTasksGet | GET /az/dept/{name}/tasks | Get all tasks of a department |
TeamworkServerApi.TaskApi | azDeptNameTasksPost | POST /az/dept/{name}/tasks | Add a task list to the department. If the department already exists, it will be updated. |
TeamworkServerApi.TaskApi | azDeptNameWorksWorkNameDelete | DELETE /az/dept/{name}/works/{workName} | Delete all tasks of a work for a particular department |
Documentation for Models
- TeamworkServerApi.AzureStorageInfo
- TeamworkServerApi.CORSDomain
- TeamworkServerApi.Department
- TeamworkServerApi.Error
- TeamworkServerApi.TaskItem
Documentation for Authorization
All endpoints do not require authorization.
8 years ago