DocdokuPlmApi.WorkspaceWorkflowsApi

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

Method HTTP request Description
createWorkspaceWorkflow POST /workspaces/{workspaceId}/workspace-workflows Instantiate a workspace workflow from given workflow model
deleteWorkspaceWorkflow DELETE /workspaces/{workspaceId}/workspace-workflows/{workspaceWorkflowId} Delete a workspace workflow
getWorkspaceWorkflow GET /workspaces/{workspaceId}/workspace-workflows/{workspaceWorkflowId} Get a workspace workflow by id
getWorkspaceWorkflowList GET /workspaces/{workspaceId}/workspace-workflows Get workspace workflow list in given workspace

createWorkspaceWorkflow

WorkspaceWorkflowDTO createWorkspaceWorkflow(workspaceId, body)

Instantiate a workspace workflow from given 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.WorkspaceWorkflowsApi();

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

var body = new DocdokuPlmApi.WorkspaceWorkflowCreationDTO(); // WorkspaceWorkflowCreationDTO | Workspace workflow to create


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
body WorkspaceWorkflowCreationDTO Workspace workflow to create

Return type

WorkspaceWorkflowDTO

Authorization

authorization

HTTP request headers

deleteWorkspaceWorkflow

deleteWorkspaceWorkflow(workspaceId, workspaceWorkflowId)

Delete a workspace workflow

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

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

var workspaceWorkflowId = "workspaceWorkflowId_example"; // String | Workspace workflow id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
workspaceWorkflowId String Workspace workflow id

Return type

null (empty response body)

Authorization

authorization

HTTP request headers

getWorkspaceWorkflow

WorkspaceWorkflowDTO getWorkspaceWorkflow(workspaceId, workspaceWorkflowId)

Get a workspace workflow 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.WorkspaceWorkflowsApi();

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

var workspaceWorkflowId = "workspaceWorkflowId_example"; // String | Workspace workflow id


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
workspaceWorkflowId String Workspace workflow id

Return type

WorkspaceWorkflowDTO

Authorization

authorization

HTTP request headers

getWorkspaceWorkflowList

[WorkspaceWorkflowDTO] getWorkspaceWorkflowList(workspaceId)

Get workspace workflow list 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.WorkspaceWorkflowsApi();

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

Parameters

Name Type Description Notes
workspaceId String Workspace id

Return type

[WorkspaceWorkflowDTO]

Authorization

authorization

HTTP request headers