DocdokuPlmApi.TagsApi

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

createDocumentMasterInRootFolderWithTag

[DocumentRevisionDTO] createDocumentMasterInRootFolderWithTag(workspaceId, body, tagId)

Create a new document master and its first revision with given tag

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

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

var body = new DocdokuPlmApi.DocumentCreationDTO(); // DocumentCreationDTO | Document to create

var tagId = "tagId_example"; // String | Tag id


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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createTag

TagDTO createTag(workspaceId, body)

Create a new tag in 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.TagsApi();

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

var body = new DocdokuPlmApi.TagDTO(); // TagDTO | Tag to create


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

Parameters

Return type

TagDTO

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createTags

createTags(workspaceId, body)

Create new tags in 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.TagsApi();

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

var body = new DocdokuPlmApi.TagListDTO(); // TagListDTO | Tag list to create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.createTags(workspaceId, body, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

deleteTag

deleteTag(workspaceId, tagId)

Delete a tag in 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.TagsApi();

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

var tagId = "tagId_example"; // String | Tag id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteTag(workspaceId, tagId, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getDocumentsWithGivenTagIdAndWorkspaceId

[DocumentRevisionDTO] getDocumentsWithGivenTagIdAndWorkspaceId(workspaceId, tagId)

Get document revisions from given tag id

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

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

var tagId = "tagId_example"; // String | Tag id


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

Parameters

Return type

[DocumentRevisionDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getTagsInWorkspace

[TagDTO] getTagsInWorkspace(workspaceId)

Get tags 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.TagsApi();

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

Parameters

Return type

[TagDTO]

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: application/json