Foundry API

<back to all web services

UpdateMachineRequest

Requires Authentication
The following routes are available for this service:
PUT,PATCH/machines/{Id}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class UpdateMachineRequest : PutPatchOperationTenanted<UpdateMachineResponse>()
{
    var id:String? = null
    var name:String? = null
    @SerializedName("type") var Type:String? = null
    var manufacturedOn:Date? = null
    var location:String? = null
    var configuration:String? = null
}

open class PutPatchOperationTenanted<TResponse> : PutPatchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class PutPatchOperationUnTenanted<TResponse> : IPatch, IPut
{
}

open class UpdateMachineResponse
{
    var responseStatus:ResponseStatus? = null
    var machine:Machine? = null
}

open class Machine : IIdentifiableResource
{
    var name:String? = null
    @SerializedName("type") var Type:String? = null
    var manufacturedOn:Date? = null
    var location:String? = null
    var configuration:String? = null
    var id:String? = null
}

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

PUT /machines/{Id} HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
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: 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"}}