DocdokuPlmApi.MilestonesApi

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

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

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

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

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

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

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

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

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

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

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

Return type

[MilestoneDTO]

Authorization

authorization

HTTP request headers

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

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

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

Return type

[ChangeOrderDTO]

Authorization

authorization

HTTP request headers

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

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

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

Return type

[ChangeRequestDTO]

Authorization

authorization

HTTP request headers

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

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

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

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

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

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

Return type

MilestoneDTO

Authorization

authorization

HTTP request headers

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

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

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

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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