DocdokuPlmApi.RequestsApi

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

Method	HTTP request	Description
addTagsToChangeRequest	POST /workspaces/{workspaceId}/changes/requests/{requestId}/tags	Attach a new tag to a change request
createRequest	POST /workspaces/{workspaceId}/changes/requests	Create request
getRequest	GET /workspaces/{workspaceId}/changes/requests/{requestId}	Get change request by id
getRequests	GET /workspaces/{workspaceId}/changes/requests	Get requests for given parameters
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
saveAffectedIssues	PUT /workspaces/{workspaceId}/changes/requests/{requestId}/affected-issues	Attach issue to a change request
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
searchRequestsByName	GET /workspaces/{workspaceId}/changes/requests/link	Search request with given name
updateChangeRequestACL	PUT /workspaces/{workspaceId}/changes/requests/{requestId}/acl	Update ACL of a change request
updateRequest	PUT /workspaces/{workspaceId}/changes/requests/{requestId}	Update change request

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

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

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

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

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

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

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

Content-Type: Not defined
Accept: application/json

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

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

Content-Type: Not defined
Accept: application/json

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

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

Content-Type: application/json
Accept: Not defined

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

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
workspaceId	String	Workspace id
requestId	Number	Request id
tagName	String	Tag to remove

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

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
workspaceId	String	Workspace id
requestId	Number	Request id
body	ChangeIssueListDTO	Change issues to save as affected

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
requestId	Number	Request id
body	DocumentIterationListDTO	Document list to save as affected

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

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

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

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

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

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

Content-Type: Not defined
Accept: application/json

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

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

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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

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

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
workspaceId	String	Workspace id
requestId	Number	Request id
body	ChangeRequestDTO	Request to update

Return type

ChangeRequestDTO

Authorization

authorization

HTTP request headers

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