Skip to content

HistoryApi.md

Latest commit

 

History

History
382 lines (269 loc) · 12.3 KB

HistoryApi.md

File metadata and controls

382 lines (269 loc) · 12.3 KB

Id4iApi.HistoryApi

All URIs are relative to https://backend.id4i.de

Method HTTP request Description
addItem POST /api/v1/history/{id4n} Add history item
filteredList GET /api/v1/history/{id4n} List history
list GET /api/v1/history/{id4n}/{organizationId} DEPRECATED - List history
retrieveItem GET /api/v1/history/{id4n}/{organizationId}/{sequenceId} Get history item
updateItem PATCH /api/v1/history/{id4n}/{organizationId}/{sequenceId} Update history item
updateItemVisibility PUT /api/v1/history/{id4n}/{organizationId}/{sequenceId}/visibility Set history item visibility

addItem

addItem(id4n, historyItem)

Add history item

Add a new history item

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.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 Id4iApi.HistoryApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var historyItem = new Id4iApi.HistoryItem(); // HistoryItem | The history item to publish


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addItem(id4n, historyItem, callback);

Parameters

Name Type Description Notes
id4n String GUID to retrieve the history for
historyItem HistoryItem The history item to publish

Return type

null (empty response body)

Authorization

Authorization

HTTP request headers

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

filteredList

PaginatedResponseOfHistoryItem filteredList(id4n, opts)

List history

Lists the history of a GUID

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.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 Id4iApi.HistoryApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var opts = { 
  'includePrivate': true, // Boolean | Also return private history entries
  'organization': "organization_example", // String | Show only entries created by one of the given organizations. This parameter can be used multiple times.
  'type': ["type_example"], // [String] | Show only entries matching one of the given history item types. This parameter can be used multiple times.
  'qualifier': ["qualifier_example"], // [String] | Show only entries matching one of the given history item qualifiers (additional property de.id4i.history.item.qualifier). This parameter can be used multiple times.
  'fromDate': new Date("2013-10-20T19:20:30+01:00"), // Date | From date time as UTC Date-Time format
  'toDate': new Date("2013-10-20T19:20:30+01:00"), // Date | To date time as UTC Date-Time format
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name Type Description Notes
id4n String GUID to retrieve the history for
includePrivate Boolean Also return private history entries [optional] [default to true]
organization String Show only entries created by one of the given organizations. This parameter can be used multiple times. [optional]
type [String] Show only entries matching one of the given history item types. This parameter can be used multiple times. [optional]
qualifier [String] Show only entries matching one of the given history item qualifiers (additional property de.id4i.history.item.qualifier). This parameter can be used multiple times. [optional]
fromDate Date From date time as UTC Date-Time format [optional]
toDate Date To date time as UTC Date-Time format [optional]
offset Number Start with the n-th element [optional]
limit Number The maximum count of returned elements [optional]

Return type

PaginatedResponseOfHistoryItem

Authorization

Authorization

HTTP request headers

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

list

PaginatedResponseOfHistoryItem list(id4n, organizationId, opts)

DEPRECATED - List history

DEPRECATED - please use filteredList with organization parameter to achieve the same functionality

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.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 Id4iApi.HistoryApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var organizationId = "organizationId_example"; // String | organizationId

var opts = { 
  'includePrivate': true, // Boolean | Also return private history entries
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name Type Description Notes
id4n String GUID to retrieve the history for
organizationId String organizationId
includePrivate Boolean Also return private history entries [optional] [default to true]
offset Number Start with the n-th element [optional]
limit Number The maximum count of returned elements [optional]

Return type

PaginatedResponseOfHistoryItem

Authorization

Authorization

HTTP request headers

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

retrieveItem

HistoryItem retrieveItem(id4n, organizationId, sequenceId)

Get history item

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.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 Id4iApi.HistoryApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var organizationId = "organizationId_example"; // String | organizationId

var sequenceId = 56; // Number | sequenceId


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.retrieveItem(id4n, organizationId, sequenceId, callback);

Parameters

Name Type Description Notes
id4n String GUID to retrieve the history for
organizationId String organizationId
sequenceId Number sequenceId

Return type

HistoryItem

Authorization

Authorization

HTTP request headers

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

updateItem

HistoryItem updateItem(id4n, organizationId, sequenceId, update)

Update history item

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.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 Id4iApi.HistoryApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var organizationId = "organizationId_example"; // String | organizationId

var sequenceId = 56; // Number | sequenceId

var update = new Id4iApi.HistoryItemUpdate(); // HistoryItemUpdate | update


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateItem(id4n, organizationId, sequenceId, update, callback);

Parameters

Name Type Description Notes
id4n String GUID to retrieve the history for
organizationId String organizationId
sequenceId Number sequenceId
update HistoryItemUpdate update

Return type

HistoryItem

Authorization

Authorization

HTTP request headers

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

updateItemVisibility

HistoryItem updateItemVisibility(id4n, organizationId, sequenceId, visibility)

Set history item visibility

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.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 Id4iApi.HistoryApi();

var id4n = "id4n_example"; // String | GUID to retrieve the history for

var organizationId = "organizationId_example"; // String | organizationId

var sequenceId = 56; // Number | sequenceId

var visibility = new Id4iApi.Visibility(); // Visibility | History item visibility restrictions


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateItemVisibility(id4n, organizationId, sequenceId, visibility, callback);

Parameters

Name Type Description Notes
id4n String GUID to retrieve the history for
organizationId String organizationId
sequenceId Number sequenceId
visibility Visibility History item visibility restrictions

Return type

HistoryItem

Authorization

Authorization

HTTP request headers

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