Synapcus® REST-API

This document describes the REST-API provided by Synapcus®. The REST-API is addressed to developers who want to integrate Synapcus® modules into other applications and for administrators for creating script interactions with the Synapcus® server. The Synapcus® REST-API provide access to resources via URI paths. To use this REST API, your application will make an HTTP request and parse the response. The response format is JSON. The calling methods are the standard HTTP methods like GET, PUT, POST and DELETE. Because the Synapcus® REST-API is based on open standards, you can use any development language to access this API. Collapse all methods
Adress Book
{host}/xrSdatas.xsp/rest/api?{params}
{host}/xrContacts.xsp/rest/api?[params]
{host}/xrContacts.xsp/rest/api?{params}
{host}/xrOrgs.xsp/rest/api?[params]
{host}/xrOrgs.xsp/rest/api?{params}
{host}/xrOrg.xsp/rest/api?{params}
{host}/xrOrg.xsp/rest/api?{params}{body}
{host}/xrOrg.xsp/rest/api?{body}
{host}/xrOrg.xsp/rest/api?{params}
{host}/xrOrgPers.xsp/rest/api?{params}
{host}/xrPers.xsp/rest/api?[params]
{host}/xrPers.xsp/rest/api?{params}
{host}/xrPer.xsp/rest/api?{params}
{host}/xrPer.xsp/rest/api?[params]
{host}/xrPer.xsp/rest/api?{body}
{host}/xrPer.xsp/rest/api?{params}
{host}/xrMklPers.xsp/rest/api?{params}
{host}/xrPer.xsp/rest/api?{params}
EMail
{host}/xrJavaMailLogin.xsp/rest/api?[params]
{host}/xrJavaMailLogout.xsp/rest/api?[params]
{host}/xrJmessages.xsp/rest/api?[params]
{host}/xrJmessage.xsp/rest/api?[params]
{host}/xrJmessage.xsp/rest/api?[params]
{host}/xrJmessage.xsp/rest/api?[params]
{host}/xrJfolders.xsp/rest/api?[params]
Human Resources
{host}/xrRqa.xsp/rest/api?[params]
{host}/xrRqaSetState.xsp/rest/api?[params]
Marketing
{host}/xrCpgPers.xsp/rest/api?[params]
{host}/xrPerCpgs.xsp/rest/api?[params]
Project Managment
{host}/xrSac.xsp/rest/api?[params]
{host}/xrPerPrjs.xsp/rest/api?[params]
{host}/xrPerPrj.xsp/rest/api?[params]
{host}/xrPrj.xsp/rest/api?[params]
{host}/xrPrj.xsp/rest/api?[params]
{host}/xrPrj.xsp/rest/api?[params]
{host}/xrPrj.xsp/rest/api?[params]
{host}/xrPrj.xsp/rest/api?[params]
Sales Module
{host}/xrPerActivityWall.xsp/rest/api?[params]
{host}/xrSac.xsp/rest/api?[params]
{host}/xrSac.xsp/rest/api?[params]
{host}/xrSac.xsp/rest/api?[params]
{host}/xrSacSetState.xsp/rest/api?[params]
{host}/xrCmt.xsp/rest/api?[params]
{host}/xrCmt.xsp/rest/api?[params]
{host}/xrCmt.xsp/rest/api?[params]
{host}/xrCmt.xsp/rest/api?[params]
{host}/xrPerSops.xsp/rest/api?[params]
{host}/xrLea.xsp/rest/api?[params]
{host}/xrLea.xsp/rest/api?[params]
{host}/xrLea.xsp/rest/api?[params]
{host}/xrLea.xsp/rest/api?[params]
{host}/xrSop.xsp/rest/api?[params]
{host}/xrSop.xsp/rest/api?[params]
{host}/xrSop.xsp/rest/api?[params]
{host}/xrSop.xsp/rest/api?[params]
{host}/xrfpe.xsp/rest/api?[params]
{host}/xrFpe.xsp/rest/api?[params]
{host}/xrFpe.xsp/rest/api?[params]
System
{host}/xrLogin.xsp/rest/api?[params]
{host}/xrConfig.xsp/rest/api?[params]
{host}/xrConfig.xsp/rest/api?[params]