DocdokuPlmApi.WorkflowModelsApi

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

createWorkflowModel

WorkflowModelDTO createWorkflowModel(workspaceId, body)

Create a new workflow model

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

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

var body = new DocdokuPlmApi.WorkflowModelDTO(); // WorkflowModelDTO | Workflow model to create rules to set


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

Parameters

Return type

WorkflowModelDTO

Authorization

authorization

HTTP request headers

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

delWorkflowModel

delWorkflowModel(workspaceId, workflowModelId)

Delete a workflow model

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

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

var workflowModelId = "workflowModelId_example"; // String | Workflow model id


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

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

getWorkflowModelInWorkspace

WorkflowModelDTO getWorkflowModelInWorkspace(workspaceId, workflowModelId)

Get workflow model 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.WorkflowModelsApi();

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

var workflowModelId = "workflowModelId_example"; // String | Workflow model id


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

Parameters

Return type

WorkflowModelDTO

Authorization

authorization

HTTP request headers

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

getWorkflowModelsInWorkspace

[WorkflowModelDTO] getWorkflowModelsInWorkspace(workspaceId)

Get workflow models in given workspace

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

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.getWorkflowModelsInWorkspace(workspaceId, callback);

Parameters

Return type

[WorkflowModelDTO]

Authorization

authorization

HTTP request headers

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

updateWorkflowModel

WorkflowModelDTO updateWorkflowModel(workspaceId, workflowModelId, body)

Update a workflow model

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

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

var workflowModelId = "workflowModelId_example"; // String | Workflow model id

var body = new DocdokuPlmApi.WorkflowModelDTO(); // WorkflowModelDTO | Workflow model to update


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

Parameters

Return type

WorkflowModelDTO

Authorization

authorization

HTTP request headers

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

updateWorkflowModelACL

updateWorkflowModelACL(workspaceId, workflowModelId, body)

Update workflow model ACL

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

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

var workflowModelId = "workflowModelId_example"; // String | Workflow model 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.updateWorkflowModelACL(workspaceId, workflowModelId, body, callback);

Parameters

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

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