DocdokuPlmApi.GroupsApi

All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api

Method HTTP request Description
deleteUserGroupSubscription DELETE /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions/{tagName} Delete tag subscription of given user group
getGroups GET /workspaces/{workspaceId}/groups Get user groups in given workspace
getTagSubscriptionsForGroup GET /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions Get tag subscriptions of given user group
getUsersInGroup GET /workspaces/{workspaceId}/groups/{groupId}/users Get users of given user group
updateUserGroupSubscription PUT /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions/{tagName} Update or create tag subscription of given user group

deleteUserGroupSubscription

deleteUserGroupSubscription(workspaceId, groupId, tagName)

Delete tag subscription of given user group

Example

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.GroupsApi();

var workspaceId = "workspaceId_example"; // String | Workspace id

var groupId = "groupId_example"; // String | Group id id

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.deleteUserGroupSubscription(workspaceId, groupId, tagName, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
groupId String Group id id
tagName String Tag name

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

getGroups

[UserGroupDTO] getGroups(workspaceId)

Get user groups in given workspace

Example

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.GroupsApi();

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.getGroups(workspaceId, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[UserGroupDTO]

Authorization

authorization

HTTP request headers

getTagSubscriptionsForGroup

[TagSubscriptionDTO] getTagSubscriptionsForGroup(workspaceId, groupId)

Get tag subscriptions of given user group

Example

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.GroupsApi();

var workspaceId = "workspaceId_example"; // String | Workspace id

var groupId = "groupId_example"; // String | Group id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getTagSubscriptionsForGroup(workspaceId, groupId, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
groupId String Group id

Return type

[TagSubscriptionDTO]

Authorization

authorization

HTTP request headers

getUsersInGroup

[UserDTO] getUsersInGroup(workspaceId, groupId)

Get users of given user group

Example

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.GroupsApi();

var workspaceId = "workspaceId_example"; // String | Workspace id

var groupId = "groupId_example"; // String | Group id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getUsersInGroup(workspaceId, groupId, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
groupId String Group id

Return type

[UserDTO]

Authorization

authorization

HTTP request headers

updateUserGroupSubscription

TagSubscriptionDTO updateUserGroupSubscription(workspaceId, groupId, tagName, body)

Update or create tag subscription of given user group

Example

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.GroupsApi();

var workspaceId = "workspaceId_example"; // String | Workspace id

var groupId = "groupId_example"; // String | Group id

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.updateUserGroupSubscription(workspaceId, groupId, tagName, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
groupId String Group id
tagName String Tag name
body TagSubscriptionDTO Tag subscription to update or create

Return type

TagSubscriptionDTO

Authorization

authorization

HTTP request headers