DocdokuPlmApi.EffectivityApi

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

Method HTTP request Description
getEffectivity GET /workspaces/{workspaceId}/effectivities/{effectivityId} Get an effectivity from its ID
updateEffectivity PUT /workspaces/{workspaceId}/effectivities/{effectivityId} Update effectivity

getEffectivity

EffectivityDTO getEffectivity(workspaceId, effectivityId)

Get an effectivity from its 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.EffectivityApi();

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

var effectivityId = 56; // Number | Effectivity id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
effectivityId Number Effectivity id

Return type

EffectivityDTO

Authorization

authorization

HTTP request headers

updateEffectivity

EffectivityDTO updateEffectivity(workspaceId, effectivityId, body)

Update effectivity

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

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

var effectivityId = 56; // Number | Effectivity id

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


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
effectivityId Number Effectivity id
body EffectivityDTO Effectivity values to update

Return type

EffectivityDTO

Authorization

authorization

HTTP request headers