DocdokuPlmApi.OrdersApi

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

Method	HTTP request	Description
addTagToChangeOrder	POST /workspaces/{workspaceId}/changes/orders/{orderId}/tags	Add new tag to order
createOrder	POST /workspaces/{workspaceId}/changes/orders	Create order
getOrder	GET /workspaces/{workspaceId}/changes/orders/{orderId}	Get order
getOrders	GET /workspaces/{workspaceId}/changes/orders	Get orders for given parameters
removeOrder	DELETE /workspaces/{workspaceId}/changes/orders/{orderId}	Delete order
removeTagsFromChangeOrder	DELETE /workspaces/{workspaceId}/changes/orders/{orderId}/tags/{tagName}	Delete tag attached to order
saveAffectedRequests	PUT /workspaces/{workspaceId}/changes/orders/{orderId}/affected-requests	Attach request to order
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
updateChangeOrderACL	PUT /workspaces/{workspaceId}/changes/orders/{orderId}/acl	Update ACL of the order
updateOrder	PUT /workspaces/{workspaceId}/changes/orders/{orderId}	Update order

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	TagListDTO	Tag list to add

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

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

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

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

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

Content-Type: Not defined
Accept: application/json

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

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

Content-Type: Not defined
Accept: application/json

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

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

Content-Type: application/json
Accept: Not defined

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
tagName	String	Tag name

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	ChangeRequestListDTO	Change requests to save as affected

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	DocumentIterationListDTO	Documents to save as affected

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	PartIterationListDTO	Parts to save as affected

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	TagListDTO	Tag list to add

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	ACLDTO	ACL rules to set

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
orderId	Number	Order id
body	ChangeOrderDTO	Change order to update

Return type

ChangeOrderDTO

Authorization

authorization

HTTP request headers

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