RESTApp manifest

A RESTApp's manifest is a json file (manifest.json) stored in the root of the RESTApp. The manifest contains metadata about the RESTApp.

The unique identifier of a RESTApp is made up of id and version. If a RESTApp is uploaded and there is an existing RESTApp with the same id and version, it will be overwritten given that force deploy is used.

The type is mandatory and distinguishes a RESTApp from a WebApp. The name, description, author and helpUrl are used for UI purposes when importing and administering deployed RESTApp in the Sitevision editor.

bundled is required to build RESTApps 2.

name and description can be either a string or an object. For multilingual apps see the second example.

json

// manifest.json
{
   "id": "timelineBackend",
   "version": "0.0.1",
   "type": "RESTApp",
   "name": "Timeline Backend",
   "description": "A backend for timeline search WebApp",
   "author": "Sitevision AB",
   "helpUrl": "https://help.sitevision.se/timelinebackend",
   "bundled": true,			 // Specifies if RESTApp is bundled, i.e. RESTApp 2
   "maxUploadSizeInMB": 16,  // Max app upload size (default is 64)
   "requirePrivileged": true // Declares privileged usage
   "storage": {              // Declares data store usage
      "collectionDataStore": "myCollectionStore",
      "keyValueDataStore": "myStore" // multiple stores ["x", "y"]
   },
   "csrfProtection": true    // Declares CSRF usage (since 9.1)
}	

json

// manifest.json
{
   "id": "timelineBackend",
   "version": "0.0.1",
   "type": "RESTApp",
   "name": { // Multilingual-manifest requires SV 10.1
      "sv": "Backend för tidslinje",
      "en": "Timeline Backend"
   },
   "description": {
      "sv": "En backend för Sökning i Aktivitetsflödet",
      "en": "A backend for Timeline search"
   },
   "author": "Sitevision AB",
   "helpUrl": "https://help.sitevision.se/timelinebackend",
   "bundled": true,			 // Specifies if RESTApp is bundled, i.e. RESTApp 2
   "maxUploadSizeInMB": 16,  // Max app upload size (default is 64)
   "requirePrivileged": true // Declares privileged usage
   "storage": {              // Declares data store usage
      "collectionDataStore": "myCollectionStore",
      "keyValueDataStore": "myStore" // multiple stores ["x", "y"]
   },
   "csrfProtection": true    // Declares CSRF usage (since 9.1)
}	

When writing multilingual apps an English translation is required.

Did you find the content on this page useful?

RESTApp manifest

Developer

Partner

Sitevision