All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
deleteUserSubscription | DELETE /workspaces/{workspaceId}/users/{login}/tag-subscriptions/{tagName} | Delete tag subscription of user |
getAdminInWorkspace | GET /workspaces/{workspaceId}/users/admin | Get admin for workspace |
getTagSubscriptionsForUser | GET /workspaces/{workspaceId}/users/{login}/tag-subscriptions | Get tag subscriptions of user |
getUsersInWorkspace | GET /workspaces/{workspaceId}/users | Get users in workspace |
updateUserSubscription | PUT /workspaces/{workspaceId}/users/{login}/tag-subscriptions/{tagName} | Update or create tag subscription of user |
whoAmI | GET /workspaces/{workspaceId}/users/me | Get authenticated user details |
deleteUserSubscription(workspaceId, login, tagName)
Delete tag subscription of 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.UsersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var login = "login_example"; // String | User login
var tagName = "tagName_example"; // String | Tag name
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteUserSubscription(workspaceId, login, tagName, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
login | String | User login | |
tagName | String | Tag name |
null (empty response body)
UserDTO getAdminInWorkspace(workspaceId)
Get admin for workspace
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.UsersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getAdminInWorkspace(workspaceId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |
[TagSubscriptionDTO] getTagSubscriptionsForUser(workspaceId, login)
Get tag subscriptions of 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.UsersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var login = "login_example"; // String | User login
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getTagSubscriptionsForUser(workspaceId, login, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
login | String | User login |
[UserDTO] getUsersInWorkspace(workspaceId)
Get users in workspace
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.UsersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getUsersInWorkspace(workspaceId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |
TagSubscriptionDTO updateUserSubscription(workspaceId, login, tagName, body)
Update or create tag subscription of 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.UsersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var login = "login_example"; // String | User login
var tagName = "tagName_example"; // String | Tag name
var body = new DocdokuPlmApi.TagSubscriptionDTO(); // TagSubscriptionDTO | Tag subscription to update or create
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateUserSubscription(workspaceId, login, tagName, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
login | String | User login | |
tagName | String | Tag name | |
body | TagSubscriptionDTO | Tag subscription to update or create |
UserDTO whoAmI(workspaceId)
Get authenticated user details
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.UsersApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.whoAmI(workspaceId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |