All URIs are relative to http://docdokuplm.net/eplmp-server-rest/api
Method | HTTP request | Description |
---|---|---|
createLOV | POST /workspaces/{workspaceId}/lov | Create a new ListOfValues |
deleteLOV | DELETE /workspaces/{workspaceId}/lov/{name} | Delete a ListOfValues |
getLOV | GET /workspaces/{workspaceId}/lov/{name} | Get a ListOfValues from the given parameters |
getLOVs | GET /workspaces/{workspaceId}/lov | Get a list of ListOfValues for given parameters |
updateLOV | PUT /workspaces/{workspaceId}/lov/{name} | Update a ListOfValues |
ListOfValuesDTO createLOV(workspaceId, body)
Create a new ListOfValues
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.ListOfValuesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var body = new DocdokuPlmApi.ListOfValuesDTO(); // ListOfValuesDTO | LOV to create
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.createLOV(workspaceId, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
body | ListOfValuesDTO | LOV to create |
deleteLOV(workspaceId, name)
Delete a ListOfValues
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.ListOfValuesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var name = "name_example"; // String | Name
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteLOV(workspaceId, name, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
name | String | Name |
null (empty response body)
ListOfValuesDTO getLOV(workspaceId, name)
Get a ListOfValues from the given parameters
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.ListOfValuesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var name = "name_example"; // String | Name
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getLOV(workspaceId, name, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
name | String | Name |
[ListOfValuesDTO] getLOVs(workspaceId)
Get a list of ListOfValues for given parameters
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.ListOfValuesApi();
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.getLOVs(workspaceId, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id |
ListOfValuesDTO updateLOV(workspaceId, name, body)
Update a ListOfValues
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.ListOfValuesApi();
var workspaceId = "workspaceId_example"; // String | Workspace id
var name = "name_example"; // String | Name
var body = new DocdokuPlmApi.ListOfValuesDTO(); // ListOfValuesDTO | LOV to update
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateLOV(workspaceId, name, body, callback);
Name | Type | Description | Notes |
---|---|---|---|
workspaceId | String | Workspace id | |
name | String | Name | |
body | ListOfValuesDTO | LOV to update |