Package com.symphony.api.agent

Interface SystemApi

@Path("/")
public interface SystemApi

Agent API

This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content. - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have sent no message to any stream even if a request to aome subset of the requested streams would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X. - MessageML is a markup language for messages. See reference here: https://rest-api.symphony.com/docs/messagemlv2

Method Summary

Modifier and Type	Method	Description
V1HealthCheckResponse	v1HealthCheckGet()	Checks the health of the Agent.
V2HealthCheckResponse	v2HealthCheckGet(Boolean showFirehoseErrors, String sessionToken, String keyManagerToken)	Checks the health of the Agent.

Method Detail

v1HealthCheckGet

@GET
@Path("/v1/HealthCheck")
@Produces("application/json")
V1HealthCheckResponse v1HealthCheckGet()

Checks the health of the Agent. Used to validate the configuration of the agent. Makes a request to the HealthCheck on the Symphony cloud. Makes a request to the HealthCheck on the Key Manager service.

v2HealthCheckGet

@GET
@Path("/v2/HealthCheck")
@Produces("application/json")
V2HealthCheckResponse v2HealthCheckGet(@QueryParam("showFirehoseErrors")
                                       Boolean showFirehoseErrors,
                                       @HeaderParam("sessionToken")
                                       String sessionToken,
                                       @HeaderParam("keyManagerToken")
                                       String keyManagerToken)

Checks the health of the Agent. Used to validate the configuration of the agent. Makes a request to the HealthCheck on the Symphony cloud. Makes a request to the HealthCheck on the Key Manager service. Encryts and decrypts a message inside either agent or user SbeSession with wall thread id.