DocdokuPlmApi.PartEffectivitiesApi

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

createEffectivity

EffectivityDTO createEffectivity(body, workspaceId, partNumber, partVersion)

Create an Effectivity for a given PartRevision

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

var body = new DocdokuPlmApi.EffectivityDTO(); // EffectivityDTO | Effectivity to create

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

var partNumber = "partNumber_example"; // String | Part revision number

var partVersion = "partVersion_example"; // String | Part revision version


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

Parameters

Return type

EffectivityDTO

Authorization

authorization

HTTP request headers

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

deleteEffectivity

deleteEffectivity(workspaceId, partNumber, partVersion, effectivityId)

Delete effectivity from given part revision

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

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

var partNumber = "partNumber_example"; // String | Part revision number

var partVersion = "partVersion_example"; // String | Part revision version

var effectivityId = 56; // Number | Effectivity id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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

getEffectivities

[EffectivityDTO] getEffectivities(workspaceId, partNumber, partVersion)

Get effectivities of a given PartRevision

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

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

var partNumber = "partNumber_example"; // String | Part revision number

var partVersion = "partVersion_example"; // String | Part revision version


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

Parameters

Return type

[EffectivityDTO]

Authorization

authorization

HTTP request headers

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