Foundry API

GetHealthCheckRequest

The following routes are available for this service:
GET	/health


export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

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

export class GetHealthCheckResponse
{
    public responseStatus?: ResponseStatus;
    public name?: string;
    public version?: string;
    public status?: string;

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

export class GetHealthCheckRequest extends GetOperationUnTenanted<GetHealthCheckResponse>
{

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

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

GET /health HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv

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

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	name: String,
	version: String,
	status: String
}