Foundry API

<back to all web services

UploadMachineLogRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{MachineId}/log
import 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

abstract class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    String? organisationId;

    PostOperationTenanted({this.organisationId});
    PostOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        organisationId = json['organisationId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'organisationId': organisationId
    });

    getTypeName() => "PostOperationTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class MachineLog implements IConvertible
{
    String? id;
    String? machineId;
    DateTime? uploadedAt;
    int? warnings;
    int? errors;

    MachineLog({this.id,this.machineId,this.uploadedAt,this.warnings,this.errors});
    MachineLog.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        machineId = json['machineId'];
        uploadedAt = JsonConverters.fromJson(json['uploadedAt'],'DateTime',context!);
        warnings = json['warnings'];
        errors = json['errors'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'machineId': machineId,
        'uploadedAt': JsonConverters.toJson(uploadedAt,'DateTime',context!),
        'warnings': warnings,
        'errors': errors
    };

    getTypeName() => "MachineLog";
    TypeContext? context = _ctx;
}

class UploadMachineLogResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    MachineLog? log;

    UploadMachineLogResponse({this.responseStatus,this.log});
    UploadMachineLogResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        log = JsonConverters.fromJson(json['log'],'MachineLog',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'log': JsonConverters.toJson(log,'MachineLog',context!)
    };

    getTypeName() => "UploadMachineLogResponse";
    TypeContext? context = _ctx;
}

class UploadMachineLogRequest extends PostOperationTenanted<UploadMachineLogResponse> implements IConvertible
{
    String? machineId;

    UploadMachineLogRequest({this.machineId});
    UploadMachineLogRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        machineId = json['machineId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'machineId': machineId
    });

    getTypeName() => "UploadMachineLogRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'PostOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'MachineLog': TypeInfo(TypeOf.Class, create:() => MachineLog()),
    'UploadMachineLogResponse': TypeInfo(TypeOf.Class, create:() => UploadMachineLogResponse()),
    'UploadMachineLogRequest': TypeInfo(TypeOf.Class, create:() => UploadMachineLogRequest()),
});

Dart UploadMachineLogRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /machines/{MachineId}/log HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"machineId":"String","organisationId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"log":{"id":"String","machineId":"String","warnings":0,"errors":0}}