NetilionApiDocumentation.EventApi

All URIs are relative to https://localhost/v1

Method	HTTP request	Description
addDocumentsToEvent	POST /events/{event_id}/documents	Add documents to an event
createEvent	POST /events	Create a new event
createEventForAsset	POST /assets/{asset_id}/events	Create a new event for an asset
createEventForInstrumentation	POST /instrumentations/{instrumentation_id}/events	Create a new event for an instrumentation
deleteEvent	DELETE /events/{id}	Delete an event
getAssetsOfEvent	GET /events/{event_id}/assets	Get all assets of one event
getDocumentsOfEvent	GET /events/{event_id}/documents	Get all documents of an event
getEventById	GET /events/{id}	Get a single event
getEventIdStatus	GET /events/{event_id}/status	Get the status of a specific event
getEventIdType	GET /events/{event_id}/type	Get the type of a specific event
getEventStatusesOptions	GET /events/{event_id}/status-options	Get all possible statuses for the specified event
getEventTypeesOptions	GET /events/{event_id}/type-options	Get all possible types for the specified event
getEvents	GET /events	Get a range of events
getEventsOfAsset	GET /assets/{asset_id}/events	Get all events of one asset
getEventsOfInstrumentation	GET /instrumentations/{instrumentation_id}/events	Get all events of one instrumentation
getInstrumentationsOfEvent	GET /events/{event_id}/instrumentations	Get all instrumentations of one event
getSpecificationsOfEvent	GET /events/{event_id}/specifications	Get specifications of an event
removeAssetsFromEvent	DELETE /events/{event_id}/assets	Remove assets from an event
removeDocumentsFromEvent	DELETE /events/{event_id}/documents	Remove documents from an event
removeEventFromAsset	DELETE /assets/{asset_id}/events	Remove events from an asset
removeEventFromInstrumentation	DELETE /instrumentations/{instrumentation_id}/events	Remove events from an instrumentation
removeInstrumentationsFromEvent	DELETE /events/{event_id}/instrumentations	Remove instrumentations from an event
removeSpecificationsFromEvent	DELETE /events/{event_id}/specifications	Delete specifications of an event
renameSpecificationsOfEvent	PATCH /events/{event_id}/specifications/rename	Rename a specification key
replaceDocumentsOfEvent	PATCH /events/{event_id}/documents	Replace the documents of an event
updateEvent	PATCH /events/{id}	Update an event
updateSpecificationsOfEvent	PATCH /events/{event_id}/specifications	Update specifications of an event

addDocumentsToEvent

addDocumentsToEvent(eventId, body)

Add documents to an event

Add one or more documents to an event.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the asset to which the documents will be added

var body = new NetilionApiDocumentation.DocumentIDs(); // DocumentIDs | Resources that shall be added.

apiInstance.addDocumentsToEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the asset to which the documents will be added
body	DocumentIDs	Resources that shall be added.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

createEvent

EventResponse createEvent(body)

Create a new event

Event must have a name, status, type and at least one asset or an instrumentation

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var body = new NetilionApiDocumentation.EventRequest(); // EventRequest | Event object that needs to be created.

apiInstance.createEvent(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	EventRequest	Event object that needs to be created.

Return type

EventResponse

Authorization

API-Key, Authentication

HTTP request headers

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

createEventForAsset

EventResponse createEventForAsset(assetId, body)

Create a new event for an asset

Events must have a name, and can have a start_datetime (if not provided, the date of creation will be used as default value), end_datetime, event_type, event_status, description and responsible

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var assetId = 789; // Number | Id of the asset

var body = new NetilionApiDocumentation.EventRequestNoAssets(); // EventRequestNoAssets | Object to be created.

apiInstance.createEventForAsset(assetId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
assetId	Number	Id of the asset
body	EventRequestNoAssets	Object to be created.

Return type

EventResponse

Authorization

API-Key, Authentication

HTTP request headers

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

createEventForInstrumentation

EventResponse createEventForInstrumentation(instrumentationId, body)

Create a new event for an instrumentation

Events must have a name, and can have a start_datetime (if not provided, the date of creation will be used as default value), end_datetime, event_type, event_status, description and responsible

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var instrumentationId = 789; // Number | Id of the instrumentation

var body = new NetilionApiDocumentation.EventRequestNoInstrumentations(); // EventRequestNoInstrumentations | Object to be created.

apiInstance.createEventForInstrumentation(instrumentationId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
instrumentationId	Number	Id of the instrumentation
body	EventRequestNoInstrumentations	Object to be created.

Return type

EventResponse

Authorization

API-Key, Authentication

HTTP request headers

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

deleteEvent

deleteEvent(id)

Delete an event

Delete a specific resource identified by the id in the URL.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var id = 789; // Number | Id of the event to delete

apiInstance.deleteEvent(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	Id of the event to delete

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

getAssetsOfEvent

AssetsResponse getAssetsOfEvent(eventId, opts)

Get all assets of one event

Returns a list of all assets of an event that are available in your scope. You can apply query parameters in the request to get a filtered list. If the query has no matches, the response will show an empty array. Possible include values: ```status, tenant, parent, pictures, product, product.manufacturer, product.pictures, product.status, product.categories, product.categories.parent, specifications, specifications[key1,key2], product.tenant, product.manufacturer.tenant, status.tenant, instrumentations ```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'serialNumber': "serialNumber_example", // String | Filter accepts `*` as wildcard
  'productId': "productId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'productCategoryId': "productCategoryId_example", // String | One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).
  'parentId': "parentId_example", // String | One or multiple ids (comma list). \"null\" to retrieve all objects without parent, \"!null\" for all objects with parent.
  'manufacturerId': "manufacturerId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusCode': "statusCode_example", // String | Filter accepts `*` as wildcard
  'productionDate': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'productionDateFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'productionDateTo': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'specificationsKey': "specificationsKey_example", // String | Filter accepts `*` as wildcard (if used as single specifications filter), supports comma list of keys in connection with specifications_value filter
  'specificationsValue': "specificationsValue_example", // String | Filter accepts `*` as wildcard, supports comma list of values in connection with specifications_key filter. Does not work for vectors
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `serial_number`, `created_at` or `updated_at`, `last_seen_at`, add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getAssetsOfEvent(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
serialNumber	String	Filter accepts `*` as wildcard	[optional]
productId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
productCategoryId	String	One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).	[optional]
parentId	String	One or multiple ids (comma list). "null" to retrieve all objects without parent, "!null" for all objects with parent.	[optional]
manufacturerId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusCode	String	Filter accepts `*` as wildcard	[optional]
productionDate	Date	Expected date format is YYYY-MM-DD	[optional]
productionDateFrom	Date	Expected date format is YYYY-MM-DD	[optional]
productionDateTo	Date	Expected date format is YYYY-MM-DD	[optional]
specificationsKey	String	Filter accepts `*` as wildcard (if used as single specifications filter), supports comma list of keys in connection with specifications_value filter	[optional]
specificationsValue	String	Filter accepts `*` as wildcard, supports comma list of values in connection with specifications_key filter. Does not work for vectors	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `serial_number`, `created_at` or `updated_at`, `last_seen_at`, add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

AssetsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getDocumentsOfEvent

DocumentsResponse getDocumentsOfEvent(eventId, opts)

Get all documents of an event

Returns a list of documents. If the query has no matches, the response is an empty list. Possible include values: ```status, tenant, classification, categories, categories.parent, attachments```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'classificationId': "classificationId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'documentVersion': "documentVersion_example", // String | Filter accepts `*` as wildcard
  '_number': "_number_example", // String | Filter accepts `*` as wildcard
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'categoryId': "categoryId_example", // String | One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).
  'validFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'validUntil': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD
  'validAt': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DD or YYYY-MM or YYYY
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getDocumentsOfEvent(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
classificationId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
documentVersion	String	Filter accepts `*` as wildcard	[optional]
_number	String	Filter accepts `*` as wildcard	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
categoryId	String	One or multiple ids (comma list). By adding `+` after the id, the filter considers the given category and all its children (e.g. 3+).	[optional]
validFrom	Date	Expected date format is YYYY-MM-DD	[optional]
validUntil	Date	Expected date format is YYYY-MM-DD	[optional]
validAt	Date	Expected date format is YYYY-MM-DD or YYYY-MM or YYYY	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

DocumentsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getEventById

EventResponse getEventById(id, opts)

Get a single event

Get a specific event identified by the id in the URL. Possible include values: ```assets, instrumentations, status, type```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var id = 789; // Number | Id of the event to fetch

var opts = { 
  'include': "include_example", // String | Comma separated list of objects to include in response
};
apiInstance.getEventById(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	Id of the event to fetch
include	String	Comma separated list of objects to include in response	[optional]

Return type

EventResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getEventIdStatus

EventStatusResponse getEventIdStatus(eventId, opts)

Get the status of a specific event

Returns the status of the event. Parameters supporting translation: ```name, description```. To get a translation set Accept-Language.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var opts = { 
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getEventIdStatus(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

EventStatusResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getEventIdType

EventTypeResponse getEventIdType(eventId, opts)

Get the type of a specific event

Returns the type of the event. Parameters supporting translation: ```name, description```. To get a translation set Accept-Language.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var opts = { 
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getEventIdType(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

EventTypeResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getEventStatusesOptions

EventStatuses getEventStatusesOptions(eventId, opts)

Get all possible statuses for the specified event

Returns a list of all possible event statuses for the specified event. You can apply the query parameters listed below to get a filtered list. Parameters supporting translation: ```name, description```. To get a translation set Accept-Language.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'code': "code_example", // String | Filter accepts `*` as wildcard
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getEventStatusesOptions(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
code	String	Filter accepts `*` as wildcard	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

EventStatuses

Authorization

API-Key, Authentication

HTTP request headers

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

getEventTypeesOptions

EventTypes getEventTypeesOptions(eventId, opts)

Get all possible types for the specified event

Returns a list of all possible event types for the specified event. You can apply the query parameters listed below to get a filtered list. Parameters supporting translation: ```name, description```. To get a translation set Accept-Language.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'code': "code_example", // String | Filter accepts `*` as wildcard
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
  'acceptLanguage': "acceptLanguage_example" // String | The client's accepted languages. One or several (e.g. fr,de,en)
};
apiInstance.getEventTypeesOptions(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
code	String	Filter accepts `*` as wildcard	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]
acceptLanguage	String	The client's accepted languages. One or several (e.g. fr,de,en)	[optional]

Return type

EventTypes

Authorization

API-Key, Authentication

HTTP request headers

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

getEvents

EventsResponse getEvents(opts)

Get a range of events

Returns a list of events. If the query has no matches, the response is an empty list. Possible include values: ```assets, instrumentations, status, type```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'typeId': "typeId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'startDatetime': "startDatetime_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'startDatetimeFrom': "startDatetimeFrom_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'startDatetimeTo': "startDatetimeTo_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetime': "endDatetime_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetimeFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetimeTo': "endDatetimeTo_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `start_datetime`, `end_datetime`, `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getEvents(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
typeId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
startDatetime	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
startDatetimeFrom	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
startDatetimeTo	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetime	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetimeFrom	Date	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetimeTo	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `start_datetime`, `end_datetime`, `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

EventsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getEventsOfAsset

EventsResponse getEventsOfAsset(assetId, , opts)

Get all events of one asset

Returns a list of all events belonging to an asset in your accessible scope. You can apply query parameters in the request to get a filtered list. If the query has no matches, the response will show an empty array. Possible include values: ``assets, instrumentations, status, type``

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var assetId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'typeId': "typeId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'startDatetime': "startDatetime_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'startDatetimeFrom': "startDatetimeFrom_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'startDatetimeTo': "startDatetimeTo_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetime': "endDatetime_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetimeFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetimeTo': "endDatetimeTo_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `start_datetime`, `end_datetime`, `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getEventsOfAsset(assetId, , opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
assetId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
typeId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
startDatetime	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
startDatetimeFrom	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
startDatetimeTo	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetime	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetimeFrom	Date	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetimeTo	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `start_datetime`, `end_datetime`, `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

EventsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getEventsOfInstrumentation

EventsResponse getEventsOfInstrumentation(instrumentationId, , opts)

Get all events of one instrumentation

Returns a list of all events belonging to an instrumentation in your accessible scope. You can apply query parameters in the request to get a filtered list. If the query has no matches, the response will show an empty array. Possible include values: ``assets, instrumentations, status, type``

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var instrumentationId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'name': "name_example", // String | Filter accepts `*` as wildcard
  'typeId': "typeId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'startDatetime': "startDatetime_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'startDatetimeFrom': "startDatetimeFrom_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'startDatetimeTo': "startDatetimeTo_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetime': "endDatetime_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetimeFrom': new Date("2013-10-20"), // Date | Expected date format is YYYY-MM-DDThh:mm:ss
  'endDatetimeTo': "endDatetimeTo_example", // String | Expected date format is YYYY-MM-DDThh:mm:ss
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `start_datetime`, `end_datetime`, `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getEventsOfInstrumentation(instrumentationId, , opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
instrumentationId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
name	String	Filter accepts `*` as wildcard	[optional]
typeId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
startDatetime	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
startDatetimeFrom	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
startDatetimeTo	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetime	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetimeFrom	Date	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
endDatetimeTo	String	Expected date format is YYYY-MM-DDThh:mm:ss	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
orderBy	String	Order result by attribute value, accepts `start_datetime`, `end_datetime`, `id`, `created_at` or `updated_at`. Add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

EventsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getInstrumentationsOfEvent

InstrumentationsResponse getInstrumentationsOfEvent(eventId, opts)

Get all instrumentations of one event

Returns a list of all instrumentations of an event that are available in your scope. You can apply query parameters in the request to get a filtered list. If the query has no matches, the response will show an empty array. Possible include values: ```specifications, specifications[key1,key2], pictures, tenant, parent, status, type, type.tenant, type.parent```

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | The resource defined in the URL

var opts = { 
  'page': 56, // Number | Page number to load
  'perPage': 56, // Number | Number of items to load per page
  'include': "include_example", // String | Comma separated list of objects to include in response
  'tag': "tag_example", // String | Filter accepts `*` as wildcard
  'statusId': "statusId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'typeId': "typeId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'parentId': "parentId_example", // String | One or multiple ids (comma list). \"null\" to retrieve all objects without parent, \"!null\" for all objects with parent.
  'tenantId': "tenantId_example", // String | One or multiple ids (comma list). Expected id format is integer
  'specificationsKey': "specificationsKey_example", // String | Filter accepts `*` as wildcard (if used as single specifications filter), supports comma list of keys in connection with specifications_value filter
  'specificationsValue': "specificationsValue_example", // String | Filter accepts `*` as wildcard, supports comma list of values in connection with specifications_key filter. Does not work for vectors
  'criticality': "criticality_example", // String | Filter accepts undefined, low, medium or high
  'accessibility': "accessibility_example", // String | Filter accepts undefined, easy, moderate or difficult
  'nodeId': "nodeId_example", // String | One or multiple ids (comma list). Filter acccepts \"null\" for all objects with no nodes assigned or \"!null\" for any assigned node
  'assetStatusId': "assetStatusId_example", // String | One or multiple ids (comma list). Expected id format is integer. This retrieves all Instrumentations where at least one of its assets has one of the given statuses.
  'orderBy': "orderBy_example" // String | Order result by attribute value, accepts `id`, `tag`, `created_at` or `updated_at`, add `-` as a prefix for descending order. Default value is `id`
};
apiInstance.getInstrumentationsOfEvent(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	The resource defined in the URL
page	Number	Page number to load	[optional]
perPage	Number	Number of items to load per page	[optional]
include	String	Comma separated list of objects to include in response	[optional]
tag	String	Filter accepts `*` as wildcard	[optional]
statusId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
typeId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
parentId	String	One or multiple ids (comma list). "null" to retrieve all objects without parent, "!null" for all objects with parent.	[optional]
tenantId	String	One or multiple ids (comma list). Expected id format is integer	[optional]
specificationsKey	String	Filter accepts `*` as wildcard (if used as single specifications filter), supports comma list of keys in connection with specifications_value filter	[optional]
specificationsValue	String	Filter accepts `*` as wildcard, supports comma list of values in connection with specifications_key filter. Does not work for vectors	[optional]
criticality	String	Filter accepts undefined, low, medium or high	[optional]
accessibility	String	Filter accepts undefined, easy, moderate or difficult	[optional]
nodeId	String	One or multiple ids (comma list). Filter acccepts "null" for all objects with no nodes assigned or "!null" for any assigned node	[optional]
assetStatusId	String	One or multiple ids (comma list). Expected id format is integer. This retrieves all Instrumentations where at least one of its assets has one of the given statuses.	[optional]
orderBy	String	Order result by attribute value, accepts `id`, `tag`, `created_at` or `updated_at`, add `-` as a prefix for descending order. Default value is `id`	[optional]

Return type

InstrumentationsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

getSpecificationsOfEvent

SpecificationsResponse getSpecificationsOfEvent(eventId, opts)

Get specifications of an event

Returns the specification of an object in your accessible scope. If no specifications are defined, this is just an empty object. Specification must have the form below.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var opts = { 
  'key': "key_example" // String | Filter accepts '*' as wildcard
};
apiInstance.getSpecificationsOfEvent(eventId, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
key	String	Filter accepts '*' as wildcard	[optional]

Return type

SpecificationsResponse

Authorization

API-Key, Authentication

HTTP request headers

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

removeAssetsFromEvent

removeAssetsFromEvent(eventId, body)

Remove assets from an event

Remove one or more assets from an event. If the event has no more related assets or instrumentations, the event will be deleted

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the event where the asset will be removed

var body = new NetilionApiDocumentation.AssetIDs(); // AssetIDs | Resources that shall be removed.

apiInstance.removeAssetsFromEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the event where the asset will be removed
body	AssetIDs	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removeDocumentsFromEvent

removeDocumentsFromEvent(eventId, body)

Remove documents from an event

Remove one or more documents from an event.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the event from which the documents will be removed

var body = new NetilionApiDocumentation.DocumentIDs(); // DocumentIDs | Resources that shall be removed.

apiInstance.removeDocumentsFromEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the event from which the documents will be removed
body	DocumentIDs	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removeEventFromAsset

removeEventFromAsset(assetId, body)

Remove events from an asset

Remove one or more events from an asset in your accessible scope. If the event has no more related assets, the event will be deleted

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var assetId = 789; // Number | Id of the asset from which the events will removed.

var body = new NetilionApiDocumentation.Events(); // Events | Resources that shall be removed.

apiInstance.removeEventFromAsset(assetId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
assetId	Number	Id of the asset from which the events will removed.
body	Events	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removeEventFromInstrumentation

removeEventFromInstrumentation(instrumentationId, body)

Remove events from an instrumentation

Remove one or more events from an instrumentation in your accessible scope. If the event has no more related instrumentations, the event will be deleted

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var instrumentationId = 789; // Number | Id of the instrumentation from which the events will removed.

var body = new NetilionApiDocumentation.Events1(); // Events1 | Resources that shall be removed.

apiInstance.removeEventFromInstrumentation(instrumentationId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
instrumentationId	Number	Id of the instrumentation from which the events will removed.
body	Events1	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removeInstrumentationsFromEvent

removeInstrumentationsFromEvent(eventId, body)

Remove instrumentations from an event

Remove one or more instrumentations from an event. If the event has no more related instrumentations or assets, the event will be deleted

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the event where the instrumentation will be removed

var body = new NetilionApiDocumentation.InstrumentationIDs(); // InstrumentationIDs | Resources that shall be removed.

apiInstance.removeInstrumentationsFromEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the event where the instrumentation will be removed
body	InstrumentationIDs	Resources that shall be removed.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

removeSpecificationsFromEvent

removeSpecificationsFromEvent(eventId, body)

Delete specifications of an event

The specification keys in the body will be removed of the object in your accessible scope. Multiple specification keys can be sent in the same request. If a key does not exist it will be ignored.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var body = new NetilionApiDocumentation.SpecificationsDelete(); // SpecificationsDelete | Array of keys to delete from specifications

apiInstance.removeSpecificationsFromEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
body	SpecificationsDelete	Array of keys to delete from specifications

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

renameSpecificationsOfEvent

renameSpecificationsOfEvent(eventId, body)

Rename a specification key

Rename one specification key of an event in your accessible scope. The key name allows [a-z A-Z 0-9 . - _ ] all uppercase letters will be converted to lower-case.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified node

var body = new NetilionApiDocumentation.SpecificationsRename(); // SpecificationsRename | The specifications object to patch.

apiInstance.renameSpecificationsOfEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified node
body	SpecificationsRename	The specifications object to patch.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

replaceDocumentsOfEvent

replaceDocumentsOfEvent(eventId, body)

Replace the documents of an event

Replaces all documents belonging to an event. You can send a list of resources that will replace all previous values.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the event of which the documents will be replaced

var body = new NetilionApiDocumentation.DocumentIDs(); // DocumentIDs | Resources that shall be replaced

apiInstance.replaceDocumentsOfEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the event of which the documents will be replaced
body	DocumentIDs	Resources that shall be replaced

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

updateEvent

updateEvent(id, body)

Update an event

Update accessible parameters of the requested resource.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var id = 789; // Number | Id of the event to update

var body = new NetilionApiDocumentation.EventRequest(); // EventRequest | Parameters that shall be updated.

apiInstance.updateEvent(id, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	Number	Id of the event to update
body	EventRequest	Parameters that shall be updated.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

updateSpecificationsOfEvent

updateSpecificationsOfEvent(eventId, body)

Update specifications of an event

Update the specification object of an event in your accessible scope. To add specifications, just add the key and set the value object with value, unit and source_timestamp. To mark an existing specification to be unknown, the value could be set to null. To delete keys, use the delete method. Multiple specification objects can be sent in the same request. Keys inside a specification are unique and can only be added once. Keys can only consist of a-z A-Z 0-9 . - _ all uppercase A-Z are converted to lower-case a-z. For a key that is send mutliple times in the request body, only the last key-value is saved.

Example

var NetilionApiDocumentation = require('netilion_api_documentation');
var defaultClient = NetilionApiDocumentation.ApiClient.instance;

// Configure API key authorization: API-Key
var API-Key = defaultClient.authentications['API-Key'];
API-Key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API-Key.apiKeyPrefix = 'Token';

// Configure HTTP basic authorization: Authentication
var Authentication = defaultClient.authentications['Authentication'];
Authentication.username = 'YOUR USERNAME';
Authentication.password = 'YOUR PASSWORD';

var apiInstance = new NetilionApiDocumentation.EventApi();

var eventId = 789; // Number | Id of the specified event

var body = new NetilionApiDocumentation.SpecificationsRequest(); // SpecificationsRequest | The specifications objects to patch.

apiInstance.updateSpecificationsOfEvent(eventId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
eventId	Number	Id of the specified event
body	SpecificationsRequest	The specifications objects to patch.

Return type

null (empty response body)

Authorization

API-Key, Authentication

HTTP request headers

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

Collapse file tree

Files

EventApi.md

Latest commit

History

EventApi.md

File metadata and controls

NetilionApiDocumentation.EventApi

addDocumentsToEvent

Example

Parameters

Return type

Authorization

HTTP request headers

createEvent

Example

Parameters

Return type

Authorization

HTTP request headers

createEventForAsset

Example

Parameters

Return type

Authorization

HTTP request headers

createEventForInstrumentation

Example

Parameters

Return type

Authorization

HTTP request headers

deleteEvent

Example

Parameters

Return type

Authorization

HTTP request headers

getAssetsOfEvent

Example

Parameters

Return type

Authorization

HTTP request headers

getDocumentsOfEvent

Example

Parameters

Return type

Authorization

HTTP request headers

getEventById

Example

Parameters

Return type

Authorization

HTTP request headers

getEventIdStatus

Example

Parameters

Return type

Authorization

HTTP request headers

getEventIdType

Example

Parameters

Return type

Authorization

HTTP request headers

getEventStatusesOptions

Example

Parameters

Return type

Authorization

HTTP request headers

getEventTypeesOptions

Example

Parameters

Return type

Authorization

HTTP request headers