BlueRain.ID4i.Api.StorageApi

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

Method	HTTP request	Description
CreateDocument	POST /api/v1/documents/{id4n}/{organizationId}	Create an document for an id4n
DeleteDocument	DELETE /api/v1/documents/{id4n}/{organizationId}/{fileName}	Delete a document
GetDocument	GET /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a document (meta-data only, no content)
GetPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}/metadata	Retrieve a public document (meta-data only, no content)
ListAllDocuments	GET /api/v1/documents/{id4n}	List documents
ListAllPublicDocuments	GET /api/v1/public/documents/{id4n}	List public documents
ListDocuments	GET /api/v1/documents/{id4n}/{organizationId}	List organization specific documents
PutDocument	PUT /api/v1/documents/{id4n}/{organizationId}	Put an document for an id4n
ReadDocument	GET /api/v1/documents/{id4n}/{organizationId}/{fileName}	Read document contents
ReadFromMicrostorage	GET /api/v1/microstorage/{id4n}/{organization}	Read data from microstorage
ReadPublicDocument	GET /api/v1/public/documents/{id4n}/{organizationId}/{fileName}	Read public document contents
UpdateDocumentMetadata	PATCH /api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata	Update a document
WriteToMicrostorage	PUT /api/v1/microstorage/{id4n}/{organization}	Write data to microstorage

CreateDocument

Document CreateDocument (string organizationId, string id4n, System.IO.Stream content)

Create an document for an id4n

The documents' mime type is suggested on octet-stream data. Otherwise the specified content mime type is used.

Example

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

namespace Example
{
    public class CreateDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var content = new System.IO.Stream(); // System.IO.Stream | content

            try
            {
                // Create an document for an id4n
                Document result = apiInstance.CreateDocument(organizationId, id4n, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.CreateDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
content	System.IO.Stream	content

Return type

Document

Authorization

HTTP request headers

Content-Type: multipart/form-data
Accept: application/xml, application/json

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

DeleteDocument

void DeleteDocument (string organizationId, string id4n, string fileName)

Delete a document

Example

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

namespace Example
{
    public class DeleteDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Delete a document
                apiInstance.DeleteDocument(organizationId, id4n, fileName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.DeleteDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

void (empty response body)

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]

GetDocument

Document GetDocument (string organizationId, string id4n, string fileName)

Retrieve a document (meta-data only, no content)

Example

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

namespace Example
{
    public class GetDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Retrieve a document (meta-data only, no content)
                Document result = apiInstance.GetDocument(organizationId, id4n, fileName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.GetDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

Document

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]

GetPublicDocument

Document GetPublicDocument (string organizationId, string id4n, string fileName)

Retrieve a public document (meta-data only, no content)

Example

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

namespace Example
{
    public class GetPublicDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Retrieve a public document (meta-data only, no content)
                Document result = apiInstance.GetPublicDocument(organizationId, id4n, fileName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.GetPublicDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

Document

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]

ListAllDocuments

PaginatedResponseOfDocument ListAllDocuments (string id4n, string owner = null, int? offset = null, int? limit = null)

List documents

Listing all documents of an id4n

Example

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

namespace Example
{
    public class ListAllDocumentsExample
    {
        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 StorageApi();
            var id4n = id4n_example;  // string | id4n
            var owner = owner_example;  // string | Filter by owner organization (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 documents
                PaginatedResponseOfDocument result = apiInstance.ListAllDocuments(id4n, owner, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.ListAllDocuments: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id4n	string	id4n
owner	string	Filter by owner organization	[optional]
offset	int?	Start with the n-th element	[optional]
limit	int?	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfDocument

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]

ListAllPublicDocuments

PaginatedResponseOfDocument ListAllPublicDocuments (string id4n, string organizationId = null, string owner = null, int? offset = null, int? limit = null)

List public documents

Listing all public documents of an id4n

Example

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

namespace Example
{
    public class ListAllPublicDocumentsExample
    {
        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 StorageApi();
            var id4n = id4n_example;  // string | id4n
            var organizationId = organizationId_example;  // string | organizationId (optional) 
            var owner = owner_example;  // string | Filter by owner organization (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 public documents
                PaginatedResponseOfDocument result = apiInstance.ListAllPublicDocuments(id4n, organizationId, owner, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.ListAllPublicDocuments: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
id4n	string	id4n
organizationId	string	organizationId	[optional]
owner	string	Filter by owner organization	[optional]
offset	int?	Start with the n-th element	[optional]
limit	int?	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfDocument

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]

ListDocuments

PaginatedResponseOfDocument ListDocuments (string organizationId, string id4n, string owner = null, int? offset = null, int? limit = null)

List organization specific documents

Listing documents of an id4n seen by a specified organization

Example

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

namespace Example
{
    public class ListDocumentsExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var owner = owner_example;  // string | Filter by owner organization (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 organization specific documents
                PaginatedResponseOfDocument result = apiInstance.ListDocuments(organizationId, id4n, owner, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.ListDocuments: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	organizationId
id4n	string	id4n
owner	string	Filter by owner organization	[optional]
offset	int?	Start with the n-th element	[optional]
limit	int?	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfDocument

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]

PutDocument

Document PutDocument (string organizationId, string id4n, System.IO.Stream content)

Put an document for an id4n

Creating or overwriting an existing document

Example

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

namespace Example
{
    public class PutDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var content = new System.IO.Stream(); // System.IO.Stream | content

            try
            {
                // Put an document for an id4n
                Document result = apiInstance.PutDocument(organizationId, id4n, content);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.PutDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
content	System.IO.Stream	content

Return type

Document

Authorization

HTTP request headers

Content-Type: multipart/form-data
Accept: application/xml, application/json

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

ReadDocument

byte[] ReadDocument (string organizationId, string id4n, string fileName)

Read document contents

Example

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

namespace Example
{
    public class ReadDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Read document contents
                byte[] result = apiInstance.ReadDocument(organizationId, id4n, fileName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.ReadDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

byte[]

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]

ReadFromMicrostorage

byte[] ReadFromMicrostorage (string organization, string id4n)

Read data from microstorage

Example

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

namespace Example
{
    public class ReadFromMicrostorageExample
    {
        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 StorageApi();
            var organization = organization_example;  // string | organization
            var id4n = id4n_example;  // string | id4n

            try
            {
                // Read data from microstorage
                byte[] result = apiInstance.ReadFromMicrostorage(organization, id4n);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.ReadFromMicrostorage: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organization	string	organization
id4n	string	id4n

Return type

byte[]

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]

ReadPublicDocument

byte[] ReadPublicDocument (string organizationId, string id4n, string fileName)

Read public document contents

Example

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

namespace Example
{
    public class ReadPublicDocumentExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName

            try
            {
                // Read public document contents
                byte[] result = apiInstance.ReadPublicDocument(organizationId, id4n, fileName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.ReadPublicDocument: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName

Return type

byte[]

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]

UpdateDocumentMetadata

Document UpdateDocumentMetadata (string organizationId, string id4n, string fileName, DocumentUpdate document)

Update a document

Example

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

namespace Example
{
    public class UpdateDocumentMetadataExample
    {
        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 StorageApi();
            var organizationId = organizationId_example;  // string | organizationId
            var id4n = id4n_example;  // string | id4n
            var fileName = fileName_example;  // string | fileName
            var document = new DocumentUpdate(); // DocumentUpdate | document

            try
            {
                // Update a document
                Document result = apiInstance.UpdateDocumentMetadata(organizationId, id4n, fileName, document);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.UpdateDocumentMetadata: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
organizationId	string	organizationId
id4n	string	id4n
fileName	string	fileName
document	DocumentUpdate	document

Return type

Document

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]

WriteToMicrostorage

Object WriteToMicrostorage (string organization, string id4n, string contentType = null, long? contentLength = null, byte[] body = null)

Write data to microstorage

Example

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

namespace Example
{
    public class WriteToMicrostorageExample
    {
        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 StorageApi();
            var organization = organization_example;  // string | organization
            var id4n = id4n_example;  // string | id4n
            var contentType = contentType_example;  // string | Content-Type (optional) 
            var contentLength = 789;  // long? | Content-Length (optional) 
            var body = BINARY_DATA_HERE;  // byte[] | body (optional) 

            try
            {
                // Write data to microstorage
                Object result = apiInstance.WriteToMicrostorage(organization, id4n, contentType, contentLength, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StorageApi.WriteToMicrostorage: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organization	string	organization
id4n	string	id4n
contentType	string	Content-Type	[optional]
contentLength	long?	Content-Length	[optional]
body	byte[]	body	[optional]

Return type

Object

Authorization

HTTP request headers

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

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

FilesExpand file tree

StorageApi.md

Latest commit

History

StorageApi.md

File metadata and controls

BlueRain.ID4i.Api.StorageApi

CreateDocument

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteDocument

Example

Parameters

Return type

Authorization

HTTP request headers

GetDocument

Example

Parameters

Return type

Authorization

HTTP request headers

GetPublicDocument

Example

Parameters

Return type

Authorization

HTTP request headers

ListAllDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

ListAllPublicDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

ListDocuments

Example

Parameters

Return type

Authorization

HTTP request headers

PutDocument

Example

Parameters

Return type

Authorization

HTTP request headers

ReadDocument

Example

Parameters

Return type

Authorization

HTTP request headers

ReadFromMicrostorage

Example

Parameters

Return type

Authorization

HTTP request headers

ReadPublicDocument

Example

Parameters

Return type

Authorization

HTTP request headers

UpdateDocumentMetadata

Example

Parameters

Return type

Authorization

HTTP request headers

WriteToMicrostorage