| 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: 'staging_api.foundrylab.com', 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 .xml suffix or ?format=xml
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: staging-api.foundrylab.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GenerateMachineApiKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
<OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
<Id>String</Id>
</GenerateMachineApiKeyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GenerateMachineApiKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
<ApiKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:Description>String</d2p1:Description>
<d2p1:ExpiresUtc>0001-01-01T00:00:00</d2p1:ExpiresUtc>
<d2p1:Id>String</d2p1:Id>
<d2p1:Key>String</d2p1:Key>
<d2p1:UserId>String</d2p1:UserId>
</ApiKey>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GenerateMachineApiKeyResponse>