Skip to main content

Modules specifications

The following specifications instruct on how to develop the endpoint that returns the module definitions for a specific page type.

NOTE: This endpoint relates to the page type through its base URL.

Endpoint Overview​

  • Endpoint Name: Modules
  • Method: GET
  • URL: /cms/api/modules

Authentication​

  • Authentication Type: Shared Secret

  • Pass the Secret in the request header:

    Authorization: CMS key=YOUR_SHARED_SECRET_VALUE

Request​

Headers​

Header NameRequiredDescription
AuthorizationYesCMS key=YOUR_SHARED_SECRET_VALUE
acceptNoapplication/json

Path Parameters​

None.

Query Parameters​

None.

Request body​

None.

Response​

Response Codes​

Array of module definitions.

Successful Response Example​

[
  {
    "id": "91aed8a0-a087-46f5-89a5-82f50075b2d1",
    "key": { "Id": "ExternalAdv", "Namespace": "urn:d3-external" },
    "typeFullName": "Object",
    "label": "External - Adv",
    "properties": [
      {
        "name": "CampaignID",
        "typeName": "String",
        "category": "Misc",
        "description": "Set the campaign id for the advertisement",
        "displayName": "Adv Campaign ID",
        "isBrowsable": true
      },
      {
        "name": "EventID",
        "typeName": "String",
        "category": "Misc",
        "description": "Set the event id for the advertisement",
        "displayName": "Event ID",
        "isBrowsable": true
      },
      {
        "name": "DisableGrid",
        "typeName": "Boolean",
        "category": "Misc",
        "description": "Disable grid when embedded into grid-based layout",
        "displayName": "DisableGrid",
        "isBrowsable": true
      }
    ]
  }
]

Common Errors and Troubleshooting​

In case of failure, check the Forge logs for error details. For transient errors retry again the operation.

  • ...