All Verbs | /machines/{Id}/statuses |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
Component | query | string | No | |
ObservedAt | query | DateTime | No | |
Code | query | string | No | |
ErrorCode | query | string | No | |
ErrorDetails | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | MachineStatus | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Component | form | string | No | |
ObservedAt | form | DateTime | No | |
Code | form | string | No | |
ErrorCode | form | string | No | |
ErrorDetails | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | MachineStatus | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: foundrystage-api-app.azurewebsites.net
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 } } }