kern.services.CumulocityClient.Api.AttachmentsApi

All URIs are relative to https://<TENANT_DOMAIN>

Method	HTTP request	Description
DeleteEventBinaryResource	DELETE /event/events/{id}/binaries	Remove the attached file from a specific event
GetEventBinaryResource	GET /event/events/{id}/binaries	Retrieve the attached file of a specific event
PostEventBinaryResource	POST /event/events/{id}/binaries	Attach a file to a specific event
PutEventBinaryResource	PUT /event/events/{id}/binaries	Replace the attached file of a specific event

DeleteEventBinaryResource

void DeleteEventBinaryResource (string id)

Remove the attached file from a specific event

Remove the attached file (binary) from a specific event by a given ID.

Required roles

ROLE_EVENT_ADMIN OR owner of the source OR EVENT_ADMIN permission on the source

Example

using System.Collections.Generic;
using System.Diagnostics;
using kern.services.CumulocityClient.Api;
using kern.services.CumulocityClient.Client;
using kern.services.CumulocityClient.Model;

namespace Example
{
    public class DeleteEventBinaryResourceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://<TENANT_DOMAIN>";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure Bearer token for authorization: OAI-Secure
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure OAuth2 access token for authorization: SSO
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AttachmentsApi(config);
            var id = 20200301;  // string | Unique identifier of the event.

            try
            {
                // Remove the attached file from a specific event
                apiInstance.DeleteEventBinaryResource(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AttachmentsApi.DeleteEventBinaryResource: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the DeleteEventBinaryResourceWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Remove the attached file from a specific event
    apiInstance.DeleteEventBinaryResourceWithHttpInfo(id);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AttachmentsApi.DeleteEventBinaryResourceWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Unique identifier of the event.

Return type

void (empty response body)

Authorization

Basic, OAI-Secure, SSO

HTTP request headers

Content-Type: Not defined
Accept: application/vnd.com.nsn.cumulocity.error+json

HTTP response details

Status code	Description	Response headers
204	A file was removed.	-
401	Authentication information is missing or invalid.	-
404	Event not found.	-

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

GetEventBinaryResource

System.IO.Stream GetEventBinaryResource (string id)

Retrieve the attached file of a specific event

Retrieve the attached file (binary) of a specific event by a given ID.

Required roles

ROLE_EVENT_READ OR EVENT_READ permission on the source

Example

using System.Collections.Generic;
using System.Diagnostics;
using kern.services.CumulocityClient.Api;
using kern.services.CumulocityClient.Client;
using kern.services.CumulocityClient.Model;

namespace Example
{
    public class GetEventBinaryResourceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://<TENANT_DOMAIN>";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure Bearer token for authorization: OAI-Secure
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure OAuth2 access token for authorization: SSO
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AttachmentsApi(config);
            var id = 20200301;  // string | Unique identifier of the event.

            try
            {
                // Retrieve the attached file of a specific event
                System.IO.Stream result = apiInstance.GetEventBinaryResource(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AttachmentsApi.GetEventBinaryResource: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the GetEventBinaryResourceWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Retrieve the attached file of a specific event
    ApiResponse<System.IO.Stream> response = apiInstance.GetEventBinaryResourceWithHttpInfo(id);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AttachmentsApi.GetEventBinaryResourceWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Unique identifier of the event.

Return type

System.IO.Stream

Authorization

Basic, OAI-Secure, SSO

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/vnd.com.nsn.cumulocity.error+json

HTTP response details

Status code	Description	Response headers
200	The request has succeeded and the file is sent in the response.	-
401	Authentication information is missing or invalid.	-
404	Attachment not found.	-

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

PostEventBinaryResource

EventBinary PostEventBinaryResource (string id, System.IO.Stream body)

Attach a file to a specific event

Upload a file (binary) as an attachment of a specific event by a given ID. The size of the attachment is configurable, and the default size is 50 MiB. The default chunk size is 5MiB. > ⓘ Info: If there is a binary already attached to the event, the POST request results in a 409 error. When the file has been uploaded, the corresponding event contains the fragment c8y_IsBinary similar to: json \"c8y_IsBinary\": { \"name\": \"hello.txt\", \"length\": 365, \"type\": \"text/plain\" } There are two request body schemas you can use for your POST requests. text/plain is preselected (see below). If you set it to multipart/form-data each value is sent as a block of data (body part), with a user agent-defined delimiter (boundary) separating each part. The keys are given in the Content-Disposition header of each part. http POST /event/events/{id}/binaries Host: https://<TENANT_DOMAIN> Authorization: <AUTHORIZATION> Accept: application/json Content-Type: multipart/form-data;boundary=\"boundary\" - -boundary Content-Disposition: form-data; name=\"object\" { \"name\": \"hello.txt\", \"type\": \"text/plain\" } - -boundary Content-Disposition: form-data; name=\"file\"; filename=\"hello.txt\" Content-Type: text/plain <FILE_CONTENTS> - -boundary- -

Required roles

ROLE_EVENT_ADMIN OR owner of the source OR EVENT_ADMIN permission on the source

Example

using System.Collections.Generic;
using System.Diagnostics;
using kern.services.CumulocityClient.Api;
using kern.services.CumulocityClient.Client;
using kern.services.CumulocityClient.Model;

namespace Example
{
    public class PostEventBinaryResourceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://<TENANT_DOMAIN>";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure Bearer token for authorization: OAI-Secure
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure OAuth2 access token for authorization: SSO
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AttachmentsApi(config);
            var id = 20200301;  // string | Unique identifier of the event.
            var body = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt"));  // System.IO.Stream | 

            try
            {
                // Attach a file to a specific event
                EventBinary result = apiInstance.PostEventBinaryResource(id, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AttachmentsApi.PostEventBinaryResource: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PostEventBinaryResourceWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Attach a file to a specific event
    ApiResponse<EventBinary> response = apiInstance.PostEventBinaryResourceWithHttpInfo(id, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AttachmentsApi.PostEventBinaryResourceWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Unique identifier of the event.
body	System.IO.StreamSystem.IO.Stream

Return type

EventBinary

Authorization

Basic, OAI-Secure, SSO

HTTP request headers

Content-Type: text/plain, multipart/form-data
Accept: application/json, application/vnd.com.nsn.cumulocity.error+json

HTTP response details

Status code	Description	Response headers
201	A file was uploaded.	-
401	Authentication information is missing or invalid.	-
404	Event not found.	-
409	An attachment exists already.	-

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

PutEventBinaryResource

EventBinary PutEventBinaryResource (string id, System.IO.Stream? body = null)

Replace the attached file of a specific event

Upload and replace the attached file (binary) of a specific event by a given ID.
The size of the attachment is configurable, and the default size is 50 MiB. The default chunk size is 5MiB.

Required roles

ROLE_EVENT_ADMIN OR owner of the source OR EVENT_ADMIN permission on the source

Example

using System.Collections.Generic;
using System.Diagnostics;
using kern.services.CumulocityClient.Api;
using kern.services.CumulocityClient.Client;
using kern.services.CumulocityClient.Model;

namespace Example
{
    public class PutEventBinaryResourceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://<TENANT_DOMAIN>";
            // Configure HTTP basic authorization: Basic
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";
            // Configure Bearer token for authorization: OAI-Secure
            config.AccessToken = "YOUR_BEARER_TOKEN";
            // Configure OAuth2 access token for authorization: SSO
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AttachmentsApi(config);
            var id = 20200301;  // string | Unique identifier of the event.
            var body = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt"));  // System.IO.Stream? |  (optional) 

            try
            {
                // Replace the attached file of a specific event
                EventBinary result = apiInstance.PutEventBinaryResource(id, body);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AttachmentsApi.PutEventBinaryResource: " + e.Message);
                Debug.Print("Status Code: " + e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Using the PutEventBinaryResourceWithHttpInfo variant

This returns an ApiResponse object which contains the response data, status code and headers.

try
{
    // Replace the attached file of a specific event
    ApiResponse<EventBinary> response = apiInstance.PutEventBinaryResourceWithHttpInfo(id, body);
    Debug.Write("Status Code: " + response.StatusCode);
    Debug.Write("Response Headers: " + response.Headers);
    Debug.Write("Response Body: " + response.Data);
}
catch (ApiException e)
{
    Debug.Print("Exception when calling AttachmentsApi.PutEventBinaryResourceWithHttpInfo: " + e.Message);
    Debug.Print("Status Code: " + e.ErrorCode);
    Debug.Print(e.StackTrace);
}

Parameters

Name	Type	Description	Notes
id	string	Unique identifier of the event.
body	System.IO.Stream?System.IO.Stream?		[optional]

Return type

EventBinary

Authorization

Basic, OAI-Secure, SSO

HTTP request headers

Content-Type: text/plain
Accept: application/json, application/vnd.com.nsn.cumulocity.error+json

HTTP response details

Status code	Description	Response headers
201	A file was uploaded.	-
401	Authentication information is missing or invalid.	-
404	Event not found.	-

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

Files

AttachmentsApi.md

Latest commit

History

AttachmentsApi.md

File metadata and controls

kern.services.CumulocityClient.Api.AttachmentsApi

DeleteEventBinaryResource

Required roles

Example

Using the DeleteEventBinaryResourceWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetEventBinaryResource

Required roles

Example

Using the GetEventBinaryResourceWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PostEventBinaryResource

Required roles

Example

Using the PostEventBinaryResourceWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

PutEventBinaryResource

Required roles

Example

Using the PutEventBinaryResourceWithHttpInfo variant

Parameters

Return type

Authorization

HTTP request headers

HTTP response details