All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
getAssignedTasksForGivenUser | GET /workspaces/{workspaceId}/tasks/{assignedUserLogin}/assigned | Get assigned tasks for given user |
getDocumentsWhereGivenUserHasAssignedTasks | GET /workspaces/{workspaceId}/tasks/{assignedUserLogin}/documents | Get document revisions where user has assigned tasks |
getPartsWhereGivenUserHasAssignedTasks | GET /workspaces/{workspaceId}/tasks/{assignedUserLogin}/parts | Get part revisions where user has assigned tasks |
getTask | GET /workspaces/{workspaceId}/tasks/{taskId} | Get task by id |
processTask | PUT /workspaces/{workspaceId}/tasks/{taskId}/process | Approve or reject task on a document or part revision |
[TaskDTO] getAssignedTasksForGivenUser(workspaceId, assignedUserLogin)
Get assigned tasks for given user
var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;
// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';
var apiInstance = new DocdokuPlmApi.TasksApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var assignedUserLogin = "assignedUserLogin_example"; // String | Assigned user login
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getAssignedTasksForGivenUser(workspaceId, assignedUserLogin, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
assignedUserLogin | String | Assigned user login |
[DocumentRevisionDTO] getDocumentsWhereGivenUserHasAssignedTasks(workspaceId, assignedUserLogin, opts)
Get document revisions where user has assigned tasks
var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;
// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';
var apiInstance = new DocdokuPlmApi.TasksApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var assignedUserLogin = "assignedUserLogin_example"; // String | Assigned user login
var opts = {
'filter': "filter_example" // String | Status filter
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getDocumentsWhereGivenUserHasAssignedTasks(workspaceId, assignedUserLogin, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
assignedUserLogin | String | Assigned user login | |
filter | String | Status filter | [optional] |
[PartRevisionDTO] getPartsWhereGivenUserHasAssignedTasks(workspaceId, assignedUserLogin, opts)
Get part revisions where user has assigned tasks
var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;
// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';
var apiInstance = new DocdokuPlmApi.TasksApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var assignedUserLogin = "assignedUserLogin_example"; // String | Assigned user login
var opts = {
'filter': "filter_example" // String | Task status filter
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getPartsWhereGivenUserHasAssignedTasks(workspaceId, assignedUserLogin, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
assignedUserLogin | String | Assigned user login | |
filter | String | Task status filter | [optional] |
TaskDTO getTask(workspaceId, taskId)
Get task by id
var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;
// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';
var apiInstance = new DocdokuPlmApi.TasksApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var taskId = "taskId_example"; // String | Task id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getTask(workspaceId, taskId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
taskId | String | Task id |
processTask(workspaceId, taskId, body)
Approve or reject task on a document or part revision
var DocdokuPlmApi = require('docdoku-plm-api');
var defaultClient = DocdokuPlmApi.ApiClient.instance;
// Configure API key authorization: authorization
var authorization = defaultClient.authentications['authorization'];
authorization.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//authorization.apiKeyPrefix = 'Token';
var apiInstance = new DocdokuPlmApi.TasksApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var taskId = "taskId_example"; // String | Task id
var body = new DocdokuPlmApi.TaskProcessDTO(); // TaskProcessDTO | Task process data
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.processTask(workspaceId, taskId, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
taskId | String | Task id | |
body | TaskProcessDTO | Task process data |
null (empty response body)