DocdokuPlmApi.ChangeItemsApi

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

Method HTTP request Description
addTagToChangeIssue POST /workspaces/{workspaceId}/changes/issues/{issueId}/tags Attached a new tag to a change issue
addTagToChangeOrder POST /workspaces/{workspaceId}/changes/orders/{orderId}/tags Add new tag to order
addTagsToChangeRequest POST /workspaces/{workspaceId}/changes/requests/{requestId}/tags Attach a new tag to a change request
createIssue POST /workspaces/{workspaceId}/changes/issues Create a new change issue
createMilestone POST /workspaces/{workspaceId}/changes/milestones Create a new milestone
createOrder POST /workspaces/{workspaceId}/changes/orders Create order
createRequest POST /workspaces/{workspaceId}/changes/requests Create request
getIssue GET /workspaces/{workspaceId}/changes/issues/{issueId} Get change issue with given id
getIssues GET /workspaces/{workspaceId}/changes/issues Get change issues for given parameters
getMilestone GET /workspaces/{workspaceId}/changes/milestones/{milestoneId} Get a milestone by id
getMilestones GET /workspaces/{workspaceId}/changes/milestones Get milestones for given parameters
getOrder GET /workspaces/{workspaceId}/changes/orders/{orderId} Get order
getOrders GET /workspaces/{workspaceId}/changes/orders Get orders for given parameters
getOrdersByMilestone GET /workspaces/{workspaceId}/changes/milestones/{milestoneId}/orders Get change orders for a given milestone
getRequest GET /workspaces/{workspaceId}/changes/requests/{requestId} Get change request by id
getRequests GET /workspaces/{workspaceId}/changes/requests Get requests for given parameters
getRequestsByMilestone GET /workspaces/{workspaceId}/changes/milestones/{milestoneId}/requests Get change requests for a given milestone
removeIssue DELETE /workspaces/{workspaceId}/changes/issues/{issueId} Delete change issue
removeMilestone DELETE /workspaces/{workspaceId}/changes/milestones/{milestoneId} Delete milestone
removeOrder DELETE /workspaces/{workspaceId}/changes/orders/{orderId} Delete order
removeRequest DELETE /workspaces/{workspaceId}/changes/requests/{requestId} Delete change request
removeTagFromChangeRequest DELETE /workspaces/{workspaceId}/changes/requests/{requestId}/tags/{tagName} Delete tag attached to a change request
removeTagsFromChangeIssue DELETE /workspaces/{workspaceId}/changes/issues/{issueId}/tags/{tagName} Delete a tag attached to a change issue
removeTagsFromChangeOrder DELETE /workspaces/{workspaceId}/changes/orders/{orderId}/tags/{tagName} Delete tag attached to order
saveAffectedIssues PUT /workspaces/{workspaceId}/changes/requests/{requestId}/affected-issues Attach issue to a change request
saveAffectedRequests PUT /workspaces/{workspaceId}/changes/orders/{orderId}/affected-requests Attach request to order
saveChangeIssueAffectedDocuments PUT /workspaces/{workspaceId}/changes/issues/{issueId}/affected-documents Attach a document to a change issue
saveChangeIssueAffectedParts PUT /workspaces/{workspaceId}/changes/issues/{issueId}/affected-parts Attach a part to a change issue
saveChangeItemTags PUT /workspaces/{workspaceId}/changes/issues/{issueId}/tags Update tags attached to a change issue
saveChangeOrderAffectedDocuments PUT /workspaces/{workspaceId}/changes/orders/{orderId}/affected-documents Attach document to order
saveChangeOrderAffectedParts PUT /workspaces/{workspaceId}/changes/orders/{orderId}/affected-parts Attach part to order
saveChangeOrderTags PUT /workspaces/{workspaceId}/changes/orders/{orderId}/tags Update tag attached to order
saveChangeRequestAffectedDocuments PUT /workspaces/{workspaceId}/changes/requests/{requestId}/affected-documents Attach document to a change request
saveChangeRequestAffectedParts PUT /workspaces/{workspaceId}/changes/requests/{requestId}/affected-parts Attach part to a change request
saveChangeRequestTags PUT /workspaces/{workspaceId}/changes/requests/{requestId}/tags Update tag attached to a change request
searchIssuesByName GET /workspaces/{workspaceId}/changes/issues/link Search change issue with given name
searchRequestsByName GET /workspaces/{workspaceId}/changes/requests/link Search request with given name
updateChangeIssueACL PUT /workspaces/{workspaceId}/changes/issues/{issueId}/acl Update ACL of a change issue
updateChangeOrderACL PUT /workspaces/{workspaceId}/changes/orders/{orderId}/acl Update ACL of the order
updateChangeRequestACL PUT /workspaces/{workspaceId}/changes/requests/{requestId}/acl Update ACL of a change request
updateIssue PUT /workspaces/{workspaceId}/changes/issues/{issueId} Update change issue
updateMilestone PUT /workspaces/{workspaceId}/changes/milestones/{milestoneId} Update milestone
updateMilestoneACL PUT /workspaces/{workspaceId}/changes/milestones/{milestoneId}/acl Update ACL of a milestone
updateOrder PUT /workspaces/{workspaceId}/changes/orders/{orderId} Update order
updateRequest PUT /workspaces/{workspaceId}/changes/requests/{requestId} Update change request

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
body TagListDTO Tag list to add

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

addTagToChangeOrder

ChangeOrderDTO addTagToChangeOrder(workspaceId, orderId, body)

Add new tag to order

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

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

var orderId = 56; // Number | Order 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.addTagToChangeOrder(workspaceId, orderId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body TagListDTO Tag list to add

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

addTagsToChangeRequest

ChangeRequestDTO addTagsToChangeRequest(workspaceId, requestId, body)

Attach a new tag to a change request

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

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

var requestId = 56; // Number | Request 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.addTagsToChangeRequest(workspaceId, requestId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body TagListDTO Tag list to add

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
body ChangeIssueDTO Change issue to create

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

createMilestone

MilestoneDTO createMilestone(workspaceId, body)

Create a new milestone

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

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

var body = new DocdokuPlmApi.MilestoneDTO(); // MilestoneDTO | Milestone to create


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
body MilestoneDTO Milestone to create

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

createOrder

ChangeOrderDTO createOrder(workspaceId, body)

Create order

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

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

var body = new DocdokuPlmApi.ChangeOrderDTO(); // ChangeOrderDTO | Change order to create


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
body ChangeOrderDTO Change order to create

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

createRequest

ChangeRequestDTO createRequest(workspaceId, body)

Create request

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

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

var body = new DocdokuPlmApi.ChangeRequestDTO(); // ChangeRequestDTO | Change request to create


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
body ChangeRequestDTO Change request to create

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id

Return type

[ChangeIssueDTO]

Authorization

authorization

HTTP request headers

getMilestone

MilestoneDTO getMilestone(workspaceId, milestoneId)

Get a milestone by 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.ChangeItemsApi();

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

var milestoneId = 56; // Number | Milestone id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
milestoneId Number Milestone id

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

getMilestones

[MilestoneDTO] getMilestones(workspaceId)

Get milestones 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.ChangeItemsApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[MilestoneDTO]

Authorization

authorization

HTTP request headers

getOrder

ChangeOrderDTO getOrder(workspaceId, orderId)

Get order

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

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

var orderId = 56; // Number | Order id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

getOrders

[ChangeOrderDTO] getOrders(workspaceId)

Get orders 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.ChangeItemsApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[ChangeOrderDTO]

Authorization

authorization

HTTP request headers

getOrdersByMilestone

[ChangeOrderDTO] getOrdersByMilestone(workspaceId, milestoneId)

Get change orders for a given milestone

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

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

var milestoneId = 56; // Number | Milestone id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
milestoneId Number Milestone id

Return type

[ChangeOrderDTO]

Authorization

authorization

HTTP request headers

getRequest

ChangeRequestDTO getRequest(workspaceId, requestId)

Get change request by 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.ChangeItemsApi();

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

var requestId = 56; // Number | Request id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

getRequests

[ChangeRequestDTO] getRequests(workspaceId)

Get requests 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.ChangeItemsApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[ChangeRequestDTO]

Authorization

authorization

HTTP request headers

getRequestsByMilestone

[ChangeRequestDTO] getRequestsByMilestone(workspaceId, milestoneId)

Get change requests for a given milestone

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

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

var milestoneId = 56; // Number | Milestone id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
milestoneId Number Milestone id

Return type

[ChangeRequestDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

removeMilestone

removeMilestone(workspaceId, milestoneId)

Delete milestone

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

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

var milestoneId = 56; // Number | Milestone id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
milestoneId Number Milestone id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

removeOrder

removeOrder(workspaceId, orderId)

Delete order

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

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

var orderId = 56; // Number | Order id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

removeRequest

ChangeRequestDTO removeRequest(workspaceId, requestId)

Delete change request

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

var workspaceId = "workspaceId_example"; // String | 

var requestId = 56; // Number | 


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

Parameters

Name Type Description Notes
workspaceId String
requestId Number

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

removeTagFromChangeRequest

ChangeRequestDTO removeTagFromChangeRequest(workspaceId, requestId, tagName)

Delete tag attached to a change request

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

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

var requestId = 56; // Number | Request id

var tagName = "tagName_example"; // String | Tag to remove


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
tagName String Tag to remove

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
tagName String Tag name

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

removeTagsFromChangeOrder

ChangeOrderDTO removeTagsFromChangeOrder(workspaceId, orderId, tagName)

Delete tag attached to order

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

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

var orderId = 56; // Number | Order 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.removeTagsFromChangeOrder(workspaceId, orderId, tagName, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
tagName String Tag name

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

saveAffectedIssues

ChangeRequestDTO saveAffectedIssues(workspaceId, requestId, body)

Attach issue to a change request

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

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

var requestId = 56; // Number | Request id

var body = new DocdokuPlmApi.ChangeIssueListDTO(); // ChangeIssueListDTO | Change issues 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.saveAffectedIssues(workspaceId, requestId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body ChangeIssueListDTO Change issues to save as affected

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

saveAffectedRequests

ChangeOrderDTO saveAffectedRequests(workspaceId, orderId, body)

Attach request to order

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

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

var orderId = 56; // Number | Order id

var body = new DocdokuPlmApi.ChangeRequestListDTO(); // ChangeRequestListDTO | Change requests 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.saveAffectedRequests(workspaceId, orderId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body ChangeRequestListDTO Change requests to save as affected

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
body DocumentIterationListDTO Document list to save as affected

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
body PartIterationListDTO Part list to save as affected

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
body TagListDTO Tag list to add

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

saveChangeOrderAffectedDocuments

ChangeOrderDTO saveChangeOrderAffectedDocuments(workspaceId, orderId, body)

Attach document to order

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

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

var orderId = 56; // Number | Order id

var body = new DocdokuPlmApi.DocumentIterationListDTO(); // DocumentIterationListDTO | Documents 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.saveChangeOrderAffectedDocuments(workspaceId, orderId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body DocumentIterationListDTO Documents to save as affected

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

saveChangeOrderAffectedParts

ChangeOrderDTO saveChangeOrderAffectedParts(workspaceId, orderId, body)

Attach part to order

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

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

var orderId = 56; // Number | Order id

var body = new DocdokuPlmApi.PartIterationListDTO(); // PartIterationListDTO | Parts 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.saveChangeOrderAffectedParts(workspaceId, orderId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body PartIterationListDTO Parts to save as affected

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

saveChangeOrderTags

ChangeOrderDTO saveChangeOrderTags(workspaceId, orderId, body)

Update tag attached to order

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

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

var orderId = 56; // Number | Order 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.saveChangeOrderTags(workspaceId, orderId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body TagListDTO Tag list to add

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

saveChangeRequestAffectedDocuments

ChangeRequestDTO saveChangeRequestAffectedDocuments(workspaceId, requestId, body)

Attach document to a change request

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

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

var requestId = 56; // Number | Request 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.saveChangeRequestAffectedDocuments(workspaceId, requestId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body DocumentIterationListDTO Document list to save as affected

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

saveChangeRequestAffectedParts

ChangeRequestDTO saveChangeRequestAffectedParts(workspaceId, requestId, body)

Attach part to a change request

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

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

var requestId = 56; // Number | Request id

var body = new DocdokuPlmApi.PartIterationListDTO(); // PartIterationListDTO | Parts 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.saveChangeRequestAffectedParts(workspaceId, requestId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body PartIterationListDTO Parts to save as affected

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

saveChangeRequestTags

ChangeRequestDTO saveChangeRequestTags(workspaceId, requestId, body)

Update tag attached to a change request

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

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

var requestId = 56; // Number | Request 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.saveChangeRequestTags(workspaceId, requestId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body TagListDTO Tag list to add

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
q String Query

Return type

[ChangeIssueDTO]

Authorization

authorization

HTTP request headers

searchRequestsByName

[ChangeRequestDTO] searchRequestsByName(workspaceId, q)

Search request 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.ChangeItemsApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id
q String Query

Return type

[ChangeRequestDTO]

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
body ACLDTO ACL rules to set

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

updateChangeOrderACL

ChangeOrderDTO updateChangeOrderACL(workspaceId, orderId, body)

Update ACL of the order

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

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

var orderId = 56; // Number | Order 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.updateChangeOrderACL(workspaceId, orderId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body ACLDTO ACL rules to set

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

updateChangeRequestACL

ChangeRequestDTO updateChangeRequestACL(workspaceId, requestId, body)

Update ACL of a change request

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

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

var requestId = 56; // Number | Request 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.updateChangeRequestACL(workspaceId, requestId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body ACLDTO ACL rules to set

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

Name Type Description Notes
workspaceId String Workspace id
issueId Number Issue id
body ChangeIssueDTO Change issue to update

Return type

ChangeIssueDTO

Authorization

authorization

HTTP request headers

updateMilestone

MilestoneDTO updateMilestone(workspaceId, milestoneId, body)

Update milestone

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

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

var milestoneId = 56; // Number | Milestone id

var body = new DocdokuPlmApi.MilestoneDTO(); // MilestoneDTO | Milestone to update


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
milestoneId Number Milestone id
body MilestoneDTO Milestone to update

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

updateMilestoneACL

updateMilestoneACL(workspaceId, milestoneId, body)

Update ACL of a milestone

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

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

var milestoneId = 56; // Number | Milestone 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.');
  }
};
apiInstance.updateMilestoneACL(workspaceId, milestoneId, body, callback);

Parameters

Name Type Description Notes
workspaceId String Workspace id
milestoneId Number Milestone id
body ACLDTO ACL rules to set

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

updateOrder

ChangeOrderDTO updateOrder(workspaceId, orderId, body)

Update order

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

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

var orderId = 56; // Number | Order id

var body = new DocdokuPlmApi.ChangeOrderDTO(); // ChangeOrderDTO | Change order to update


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
orderId Number Order id
body ChangeOrderDTO Change order to update

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

updateRequest

ChangeRequestDTO updateRequest(workspaceId, requestId, body)

Update change request

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

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

var requestId = 56; // Number | Request id

var body = new DocdokuPlmApi.ChangeRequestDTO(); // ChangeRequestDTO | Request to update


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
requestId Number Request id
body ChangeRequestDTO Request to update

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers