Foundry API

<back to all web services

AddTelemetryRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/telemetries
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Infrastructure.Api.Interfaces.ServiceOperations.Telemetries;
using Infrastructure.Api.Interfaces.ServiceOperations;
using Application.Interfaces.Resources;

namespace Application.Interfaces.Resources
{
    public partial class Telemetry
        : IIdentifiableResource
    {
        public virtual string Type { get; set; }
        public virtual string Value { get; set; }
        public virtual DateTime ObservedAt { get; set; }
        public virtual string Id { get; set; }
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations
{
    public partial class PutPatchOperationTenanted<TResponse>
        : PutPatchOperationUnTenanted<TResponse>, ITenantedRequest
    {
        public virtual string OrganisationId { get; set; }
    }

    public partial class PutPatchOperationUnTenanted<TResponse>
        : IPatch, IPut
    {
    }

}

namespace Infrastructure.Api.Interfaces.ServiceOperations.Telemetries
{
    public partial class AddTelemetryRequest
        : PutPatchOperationTenanted<AddTelemetryResponse>
    {
        public AddTelemetryRequest()
        {
            Telemetries = new List<Telemetry>{};
        }

        public virtual string MachineId { get; set; }
        public virtual List<Telemetry> Telemetries { get; set; }
    }

    public partial class AddTelemetryResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# AddTelemetryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /machines/{MachineId}/telemetries HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"machineId":"String","telemetries":[{"type":"String","value":"String","id":"String"}],"organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}