Foundry API

ReportMachineStatusRequest

The following routes are available for this service:
All Verbs	/machines/{Id}/statuses

import java.math.*
import java.util.*
import net.servicestack.client.*


open class ReportMachineStatusRequest : PostOperationTenanted<ReportMachineStatusResponse>()
{
    var id:String? = null
    var component:String? = null
    var observedAt:Date? = null
    var code:String? = null
    var errorCode:String? = null
    var errorDetails:String? = null
}

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

open class PostOperationUnTenanted<TResponse> : IPost
{
}

open class ReportMachineStatusResponse
{
    var status:MachineStatus? = null
    var responseStatus:ResponseStatus? = null
}

open class MachineStatus
{
    var component:String? = null
    var observedAt:Date? = null
    var code:String? = null
    var errorCode:String? = null
    var errorDetails:String? = null
}

Kotlin ReportMachineStatusRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /machines/{Id}/statuses HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	component: String,
	code: String,
	errorCode: String,
	errorDetails: String,
	organisationId: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: 
	{
		component: String,
		code: String,
		errorCode: String,
		errorDetails: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}