Vmoso-task-api NPM

vmoso-task-api

VmosoTaskApi - JavaScript client for vmoso-task-api Description about Task 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-22T14:07:17.495Z
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 vmoso-task-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/vmoso-task-api then install it via:

    npm install YOUR_USERNAME/vmoso-task-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 VmosoTaskApi = require('vmoso-task-api');

var defaultClient = VmosoTaskApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var api = new VmosoTaskApi.TaskApi()

var key = "key_example"; // {String} 

var input = new VmosoTaskApi.AddParticipantsInput(); // {AddParticipantsInput} AddParticipants Input


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addParticipants(key, input, callback);

Documentation for API Endpoints

All URIs are relative to https://www.vmoso.com/svc

Class	Method	HTTP request
VmosoTaskApi.TaskApi	addParticipants	PUT /tasks/{key}/participants/add
VmosoTaskApi.TaskApi	checkAttachmentsInTask	GET /tasks/{key}/checkAttachmentKeys
VmosoTaskApi.TaskApi	checkTemplateName	POST /tasks/checktplname
VmosoTaskApi.TaskApi	cloneToDraft	POST /tasks/{key}/saveAsDraft
VmosoTaskApi.TaskApi	cloneToTemplate	POST /tasks/{key}/saveAsTemplate
VmosoTaskApi.TaskApi	createChat	POST /tasks/createChat
VmosoTaskApi.TaskApi	createDraft	POST /tasks/createDraft
VmosoTaskApi.TaskApi	createFromDraft	POST /tasks/createTaskByDraft/{key}
VmosoTaskApi.TaskApi	createTask	POST /tasks
VmosoTaskApi.TaskApi	createTemplate	POST /tasks/createTemplate
VmosoTaskApi.TaskApi	deleteTask	DELETE /tasks/{key}
VmosoTaskApi.TaskApi	getChatBrief	GET /tasks/getChatBrief/{key}
VmosoTaskApi.TaskApi	getDraft	GET /tasks/viewDraft/{key}
VmosoTaskApi.TaskApi	getFeedbackTask	GET /tasks/feedback
VmosoTaskApi.TaskApi	getHistory	GET /tasks/{key}/history
VmosoTaskApi.TaskApi	getMembersForReminder	GET /tasks/{key}/remindableMember
VmosoTaskApi.TaskApi	getParticipants	GET /tasks/{key}/participants/sort/{sortType}
VmosoTaskApi.TaskApi	getRelatedTasks	GET /tasks/{key}/getRelated/
VmosoTaskApi.TaskApi	getTask	GET /tasks/{key}
VmosoTaskApi.TaskApi	getTemplate	GET /tasks/viewTemplate/{key}
VmosoTaskApi.TaskApi	getUserRolesInTask	GET /tasks/{key}/checkUserKeys
VmosoTaskApi.TaskApi	rejectTask	PUT /tasks/{key}/reject
VmosoTaskApi.TaskApi	removeParticipants	PUT /tasks/{key}/participants/remove
VmosoTaskApi.TaskApi	sendReminder	PUT /tasks/{key}/remind
VmosoTaskApi.TaskApi	unsubscribeAlien	POST /tasks/alienUnsubscribe
VmosoTaskApi.TaskApi	updateDraft	PUT /tasks/updateDraft
VmosoTaskApi.TaskApi	updateState	PUT /tasks/{key}/setState/{stateType}
VmosoTaskApi.TaskApi	updateStatus	PUT /tasks/{key}/setStatus/{statusType}
VmosoTaskApi.TaskApi	updateTask	PUT /tasks/{key}
VmosoTaskApi.TaskApi	updateTemplate	PUT /tasks/updateTemplate
VmosoTaskApi.TaskApi	verifyParticipantEmails	GET /tasks/participants/checkEmails

Documentation for Models

Documentation for Authorization

vmoso_auth

Type: API key
API key parameter name: X-CV-Authorization
Location: HTTP header

superagent

@everything-registry/sub-chunk-3065

1.0.0

9 years ago