DocdokuPlmApi.SharedApi

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

Method HTTP request Description
getDocumentWithSharedEntity GET /shared/{uuid}/documents Get shared document from resource token
getPartWithSharedEntity GET /shared/{uuid}/parts Get shared part from resource token
getPublicSharedDocumentRevision GET /shared/{workspaceId}/documents/{documentId}-{documentVersion} Get public shared document revision
getPublicSharedPartRevision GET /shared/{workspaceId}/parts/{partNumber}-{partVersion} Get public shared part revision

getDocumentWithSharedEntity

DocumentRevisionDTO getDocumentWithSharedEntity(uuid, opts)

Get shared document from resource token

Example

var DocdokuPlmApi = require('docdoku-plm-api');

var apiInstance = new DocdokuPlmApi.SharedApi();

var uuid = "uuid_example"; // String | Resource token

var opts = { 
  'password': "password_example" // String | Password for resource
};

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

Parameters

Name Type Description Notes
uuid String Resource token
password String Password for resource [optional]

Return type

DocumentRevisionDTO

Authorization

No authorization required

HTTP request headers

getPartWithSharedEntity

PartRevisionDTO getPartWithSharedEntity(uuid, opts)

Get shared part from resource token

Example

var DocdokuPlmApi = require('docdoku-plm-api');

var apiInstance = new DocdokuPlmApi.SharedApi();

var uuid = "uuid_example"; // String | Resource token

var opts = { 
  'password': "password_example" // String | Password for resource
};

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

Parameters

Name Type Description Notes
uuid String Resource token
password String Password for resource [optional]

Return type

PartRevisionDTO

Authorization

No authorization required

HTTP request headers

getPublicSharedDocumentRevision

DocumentRevisionDTO getPublicSharedDocumentRevision(workspaceId, documentId, documentVersion)

Get public shared document revision

Example

var DocdokuPlmApi = require('docdoku-plm-api');

var apiInstance = new DocdokuPlmApi.SharedApi();

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

var documentId = "documentId_example"; // String | Document master id

var documentVersion = "documentVersion_example"; // String | Document version


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
documentId String Document master id
documentVersion String Document version

Return type

DocumentRevisionDTO

Authorization

No authorization required

HTTP request headers

getPublicSharedPartRevision

PartRevisionDTO getPublicSharedPartRevision(workspaceId, partNumber, partVersion)

Get public shared part revision

Example

var DocdokuPlmApi = require('docdoku-plm-api');

var apiInstance = new DocdokuPlmApi.SharedApi();

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

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

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


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

Parameters

Name Type Description Notes
workspaceId String Workspace id
partNumber String Part number
partVersion String Part version

Return type

PartRevisionDTO

Authorization

No authorization required

HTTP request headers