Quicklauncher Rest API

Authentication

All this documentation is build with ExternalAuthenticationLoginModule. Refer to SDK flow reference for more information.

The content is adapted with the user context.

GET /navigation/workplace/categories

This endpoint add ability to retrieve Workplace’s services categories.

Request


curl "http://server.tld/workplace/navigation/workplace/categories?_AuthenticationKey={{token}}"

Response

[  
   {  
      "id":"uril://vdoc/resource/DefaultOrganization/MoovappsWorkplace/MiddleOffice:4/Category/0001",
      "title":"Animation du site",
      "comparisonValue":"Animation du site"
   },
   {  
      "id":"uril://vdoc/resource/DefaultOrganization/MoovappsWorkplace/MiddleOffice:4/Category/0004",
      "title":"Publication documentaire",
      "comparisonValue":"Publication documentaire"
   }
]

GET /navigation/workplace/apps

This endpoint add ability to retrieve Workplace’s services by category.

Request


curl 'http://server.tld/workplace/navigation/workplace/apps?category={{category_uri}}&_AuthenticationKey={{token}}'

Parameters

Name	Located in	Required	Description	Default	Schema
category_uri	query	yes	the category's URI	-	String

Response

[  
   {  
      "id":"uril://vdoc/resource/DefaultOrganization/MoovappsWorkplace/MiddleOffice:4/Application/application-actualites-0",
      "title":"Actualités",
      "reference":"application-actualites-0",
      "tileColor":"orange",
      "type":"PROCESS",
      "link":"/workplace/easysite/workplace/applications/application-actualites-0/index",
      "icon":"icon_32_news",
      "targetBlank":false,
      "helpLinkJS":"",
      "keywords":"",
      "updateCounterUrl":"/workplace/navigation/processViewCount?applicationUri=uril://vdoc/resource/DefaultOrganization/MoovappsWorkplace/MiddleOffice:4/Application/application-actualites-0",
      "comparisonValue":"Actualités"
   },
   {  
      "id":"uril://vdoc/resource/DefaultOrganization/MoovappsWorkplace/MiddleOffice:4/Application/app-a54f7d6",
      "title":"Configuration",
      "reference":"app-a54f7d6",
      "tileColor":"purple",
      "type":"LINK",
      "link":"http://server.tld/workplace/easysite/workplace/middleoffice/middleoffice-home",
      "icon":"icon_64_settings",
      "targetBlank":false,
      "helpLinkJS":"",
      "keywords":"",
      "updateCounterUrl":"",
      "comparisonValue":"Configuration"
   }
]

GET /navigation/workplace/apps/indicator

This endpoint add ability to retrieve the indicator for an application.

Request


curl 'http://server.tld/workplace/navigation/workplace/apps/indicator?applicationUri={{application_uri}}&_AuthenticationKey={{token}}'

Parameters

Name	Located in	Required	Description	Default	Schema
application_uri	query	yes	the application's URI	-	String

Response

{"type":"COUNTER","count":1}