HTTP - Management

Project

Created by Contensis product team, last modified by s.horan on 14 Jan 2022

A project resource can be retrieved from the Management API to understand the languages that the project supports and which language is the primary language.

Remarks

Changes to the deliverySysExclusions may take up to an hour to be reflected in the delivery API. This is by design, the change propagates as the cache expires on entries rather than forcing an entire site cache purge.

Properties

Name	Data type	Data format	Description	Example
id	string		The project identifier, e.g. "movieDb". Found in the project overview screen of the management console
name	string		The friendly name given to the project
description	string		The description text given to a project
supportedLanguages	string[...]	language code	An array of all the languages supported by the project
primaryLanguage	string	language code	The primary language for the project
deliverySysExclusions	string[...]		Allows fields in the sys object to be excluded from the delivery entry response, simplifying the data returned and reducing the payload. The following fields cannot be excluded sys.versionStatus, sys.id, sys.ur, sys.language, sys.dataFormat and sys.contentTypeId	sys.owner, sys.version.*

Example

{
    "id": "movieDb",
    "name": "Movie Database",
    "description": "...",
    "supportedLanguage": [
        "en-GB",
        "en-US",
        "fr"
    ],
    "primaryLanguage": "en-GB",
    "deliverySysExclusions": [
         "sys.owner"
    ]
}