DocdokuPlmApi.IssuesApi

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

addTagToChangeIssue

ChangeIssueDTO addTagToChangeIssue(workspaceId, issueId, body)

Attached a new tag to a change issue

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

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

var issueId = 56; // Number | Issue id

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


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

createIssue

ChangeIssueDTO createIssue(workspaceId, body)

Create a new change issue

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

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

var body = new DocdokuPlmApi.ChangeIssueDTO(); // ChangeIssueDTO | Change issue to create


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

getIssue

ChangeIssueDTO getIssue(workspaceId, issueId)

Get change issue with given 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.IssuesApi();

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

var issueId = 56; // Number | Issue id


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

getIssues

[ChangeIssueDTO] getIssues(workspaceId)

Get change issues for given parameters

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

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

Parameters

Return type

[ChangeIssueDTO]

Authorization

authorization

HTTP request headers

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

removeIssue

ChangeIssueDTO removeIssue(workspaceId, issueId)

Delete change issue

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

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

var issueId = 56; // Number | Issue id


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

removeTagsFromChangeIssue

ChangeIssueDTO removeTagsFromChangeIssue(workspaceId, issueId, tagName)

Delete a tag attached to a change issue

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

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

var issueId = 56; // Number | Issue 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. Returned data: ' + data);
  }
};
apiInstance.removeTagsFromChangeIssue(workspaceId, issueId, tagName, callback);

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

saveChangeIssueAffectedDocuments

ChangeIssueDTO saveChangeIssueAffectedDocuments(workspaceId, issueId, body)

Attach a document to a change issue

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

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

var issueId = 56; // Number | Issue id

var body = new DocdokuPlmApi.DocumentIterationListDTO(); // DocumentIterationListDTO | Document list to save as affected


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

saveChangeIssueAffectedParts

ChangeIssueDTO saveChangeIssueAffectedParts(workspaceId, issueId, body)

Attach a part to a change issue

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

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

var issueId = 56; // Number | Issue id

var body = new DocdokuPlmApi.PartIterationListDTO(); // PartIterationListDTO | Part list to save as affected


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

saveChangeItemTags

ChangeIssueDTO saveChangeItemTags(workspaceId, issueId, body)

Update tags attached to a change issue

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

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

var issueId = 56; // Number | Issue id

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


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

searchIssuesByName

[ChangeIssueDTO] searchIssuesByName(workspaceId, q)

Search change issue with given name

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

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

var q = "q_example"; // String | Query


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

Parameters

Return type

[ChangeIssueDTO]

Authorization

authorization

HTTP request headers

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

updateChangeIssueACL

ChangeIssueDTO updateChangeIssueACL(workspaceId, issueId, body)

Update ACL of a change issue

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

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

var issueId = 56; // Number | Issue id

var body = new DocdokuPlmApi.ACLDTO(); // ACLDTO | ACL rules to set


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

updateIssue

ChangeIssueDTO updateIssue(workspaceId, issueId, body)

Update change issue

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

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

var issueId = 56; // Number | Issue id

var body = new DocdokuPlmApi.ChangeIssueDTO(); // ChangeIssueDTO | Change issue to update


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

Parameters

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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