Skip to content

HistoryApi.md

Latest commit

 

History

History
445 lines (348 loc) · 16 KB

HistoryApi.md

File metadata and controls

445 lines (348 loc) · 16 KB

BlueRain.ID4i.Api.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

void AddItem (string id4n, HistoryItem historyItem)

Add history item

Add a new history item

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class AddItemExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new HistoryApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var historyItem = new HistoryItem(); // HistoryItem | The history item to publish

            try
            {
                // Add history item
                apiInstance.AddItem(id4n, historyItem);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.AddItem: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilteredList

PaginatedResponseOfHistoryItem FilteredList (string id4n, bool? includePrivate = null, string organization = null, List type = null, List qualifier = null, DateTime? fromDate = null, DateTime? toDate = null, int? offset = null, int? limit = null)

List history

Lists the history of a GUID

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class FilteredListExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new HistoryApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var includePrivate = true;  // bool? | Also return private history entries (optional)  (default to true)
            var organization = organization_example;  // string | Show only entries created by one of the given organizations. This parameter can be used multiple times. (optional) 
            var type = type_example;  // List<string> | Show only entries matching one of the given history item types. This parameter can be used multiple times. (optional) 
            var qualifier = new List<string>(); // List<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) 
            var fromDate = 2013-10-20T19:20:30+01:00;  // DateTime? | From date time as UTC Date-Time format (optional) 
            var toDate = 2013-10-20T19:20:30+01:00;  // DateTime? | To date time as UTC Date-Time format (optional) 
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // List history
                PaginatedResponseOfHistoryItem result = apiInstance.FilteredList(id4n, includePrivate, organization, type, qualifier, fromDate, toDate, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.FilteredList: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string GUID to retrieve the history for
includePrivate bool? 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 List<string> Show only entries matching one of the given history item types. This parameter can be used multiple times. [optional]
qualifier List<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 DateTime? From date time as UTC Date-Time format [optional]
toDate DateTime? To date time as UTC Date-Time format [optional]
offset int? Start with the n-th element [optional]
limit int? 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

List

PaginatedResponseOfHistoryItem List (string id4n, string organizationId, bool? includePrivate = null, int? offset = null, int? limit = null)

DEPRECATED - List history

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

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class ListExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new HistoryApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var organizationId = organizationId_example;  // string | organizationId
            var includePrivate = true;  // bool? | Also return private history entries (optional)  (default to true)
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // DEPRECATED - List history
                PaginatedResponseOfHistoryItem result = apiInstance.List(id4n, organizationId, includePrivate, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.List: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string GUID to retrieve the history for
organizationId string organizationId
includePrivate bool? Also return private history entries [optional] [default to true]
offset int? Start with the n-th element [optional]
limit int? 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetrieveItem

HistoryItem RetrieveItem (string id4n, string organizationId, int? sequenceId)

Get history item

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class RetrieveItemExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new HistoryApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var organizationId = organizationId_example;  // string | organizationId
            var sequenceId = 56;  // int? | sequenceId

            try
            {
                // Get history item
                HistoryItem result = apiInstance.RetrieveItem(id4n, organizationId, sequenceId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.RetrieveItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string GUID to retrieve the history for
organizationId string organizationId
sequenceId int? sequenceId

Return type

HistoryItem

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateItem

HistoryItem UpdateItem (string id4n, string organizationId, int? sequenceId, HistoryItemUpdate update)

Update history item

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class UpdateItemExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new HistoryApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var organizationId = organizationId_example;  // string | organizationId
            var sequenceId = 56;  // int? | sequenceId
            var update = new HistoryItemUpdate(); // HistoryItemUpdate | update

            try
            {
                // Update history item
                HistoryItem result = apiInstance.UpdateItem(id4n, organizationId, sequenceId, update);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.UpdateItem: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string GUID to retrieve the history for
organizationId string organizationId
sequenceId int? sequenceId
update HistoryItemUpdate update

Return type

HistoryItem

Authorization

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateItemVisibility

HistoryItem UpdateItemVisibility (string id4n, string organizationId, int? sequenceId, Visibility visibility)

Set history item visibility

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class UpdateItemVisibilityExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new HistoryApi();
            var id4n = id4n_example;  // string | GUID to retrieve the history for
            var organizationId = organizationId_example;  // string | organizationId
            var sequenceId = 56;  // int? | sequenceId
            var visibility = new Visibility(); // Visibility | History item visibility restrictions

            try
            {
                // Set history item visibility
                HistoryItem result = apiInstance.UpdateItemVisibility(id4n, organizationId, sequenceId, visibility);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HistoryApi.UpdateItemVisibility: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
id4n string GUID to retrieve the history for
organizationId string organizationId
sequenceId int? 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

[Back to top] [Back to API list] [Back to Model list] [Back to README]