Foundry API

<back to all web services

CreateMachineRequest

Requires Authentication
The following routes are available for this service:
POST/machines
namespace Application.Interfaces.Resources

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Machine() = 
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val ManufacturedOn:DateOnly = new DateOnly() with get,set
        member val Location:String = null with get,set
        member val Configuration:String = null with get,set
        member val Id:String = null with get,set

    [<AllowNullLiteral>]
    type CreateMachineResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Machine:Machine = null with get,set
        member val ApiKey:String = null with get,set

    [<AllowNullLiteral>]
    type CreateMachineRequest() = 
        inherit PostOperationTenanted<CreateMachineResponse>()
        member val Name:String = null with get,set
        member val Type:String = null with get,set
        member val ManufacturedOn:DateOnly = new DateOnly() with get,set
        member val Location:String = null with get,set
        member val Timezone:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationTenanted<'TResponse>() = 
        inherit PostOperationUnTenanted<TResponse>()
        member val OrganisationId:String = null with get,set

    [<AllowNullLiteral>]
    type PostOperationUnTenanted<'TResponse>() = 
        interface IPost

F# CreateMachineRequest 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.

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

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