Foundry API

CreateMachineRequest

The following routes are available for this service:
POST	/machines


export class PostOperationUnTenanted<TResponse> implements IPost
{

    public constructor(init?: Partial<PostOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<PostOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class Machine implements IIdentifiableResource
{
    public name?: string;
    public type?: string;
    public manufacturedOn: string;
    public location?: string;
    public configuration?: string;
    public id?: string;

    public constructor(init?: Partial<Machine>) { (Object as any).assign(this, init); }
}

export class CreateMachineResponse
{
    public responseStatus?: ResponseStatus;
    public machine?: Machine;
    public apiKey?: string;

    public constructor(init?: Partial<CreateMachineResponse>) { (Object as any).assign(this, init); }
}

export class CreateMachineRequest extends PostOperationTenanted<CreateMachineResponse>
{
    public name?: string;
    public type?: string;
    public manufacturedOn: string;
    public location?: string;
    public timezone?: string;

    public constructor(init?: Partial<CreateMachineRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript CreateMachineRequest 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 HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","timezone":"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"}},"machine":{"name":"String","type":"String","manufacturedOn":"0001-01-01","location":"String","configuration":"String","id":"String"},"apiKey":"String"}