Foundry API

UpdateMachineRequest

The following routes are available for this service:
PUT,PATCH	/machines/{Id}


export class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{

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

export class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<PutPatchOperationTenanted<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 UpdateMachineResponse
{
    public responseStatus?: ResponseStatus;
    public machine?: Machine;

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

export class UpdateMachineRequest extends PutPatchOperationTenanted<UpdateMachineResponse>
{
    public id?: string;
    public name?: string;
    public type?: string;
    public manufacturedOn?: string;
    public location?: string;
    public configuration?: string;

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

TypeScript UpdateMachineRequest 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.

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

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