Foundry API

GenerateMachineApiKeyRequest

The following routes are available for this service:
POST	/machines/{Id}/generate-api-key

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 ApiKey implements IIdentifiableResource, IConvertible
{
    String? userId;
    String? description;
    DateTime? expiresUtc;
    String? key;
    String? id;

    ApiKey({this.userId,this.description,this.expiresUtc,this.key,this.id});
    ApiKey.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        description = json['description'];
        expiresUtc = JsonConverters.fromJson(json['expiresUtc'],'DateTime',context!);
        key = json['key'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId,
        'description': description,
        'expiresUtc': JsonConverters.toJson(expiresUtc,'DateTime',context!),
        'key': key,
        'id': id
    };

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

class GenerateMachineApiKeyResponse implements IConvertible
{
    ApiKey? apiKey;
    ResponseStatus? responseStatus;

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

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

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

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

class GenerateMachineApiKeyRequest extends PostOperationTenanted<GenerateMachineApiKeyResponse> implements IConvertible
{
    String? id;

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

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

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

    getTypeName() => "GenerateMachineApiKeyRequest";
    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),
    'ApiKey': TypeInfo(TypeOf.Class, create:() => ApiKey()),
    'GenerateMachineApiKeyResponse': TypeInfo(TypeOf.Class, create:() => GenerateMachineApiKeyResponse()),
    'GenerateMachineApiKeyRequest': TypeInfo(TypeOf.Class, create:() => GenerateMachineApiKeyRequest()),
});

Dart GenerateMachineApiKeyRequest 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/{Id}/generate-api-key HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":"String","organisationId":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"apiKey":{"userId":"String","description":"String","expiresUtc":null,"key":"String","id":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}