Package com.symphony.api.agent

Interface UtilApi

@Path("/")
public interface UtilApi

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
SimpleMessage	v1UtilEchoPost(SimpleMessage body, String sessionToken, String keyManagerToken)	Test endpoint, returns input.
SimpleMessage	v1UtilObsoletePost(SimpleMessage body, String sessionToken, String keyManagerToken)	Example of a deprecated endpoint, returns input.

Method Detail

v1UtilEchoPost

@POST
@Path("/v1/util/echo")
@Consumes("application/json")
@Produces("application/json")
SimpleMessage v1UtilEchoPost(SimpleMessage body,
                             @HeaderParam("sessionToken")
                             String sessionToken,
                             @HeaderParam("keyManagerToken")
                             String keyManagerToken)

Test endpoint, returns input.

v1UtilObsoletePost

@POST
@Path("/v1/util/obsolete")
@Consumes("application/json")
@Produces("application/json")
SimpleMessage v1UtilObsoletePost(SimpleMessage body,
                                 @HeaderParam("sessionToken")
                                 String sessionToken,
                                 @HeaderParam("keyManagerToken")
                                 String keyManagerToken)

Example of a deprecated endpoint, returns input.