Change log

Module Properties API

Create, Retrieve, Update and Delete Module Properties via the public API endpoint as well as setting their sort order and Retrieving and Updating Property settings.

GET Module Properties List

Retrieves a list of Module Properties as a JSON response based on your provided query parameters.

/api/v2/admin/modules/{id}/properties

Data / Response:

N/A

[
  {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "string",
    "Alias": "string",
    "Mandatory": true,
    "SortOrder": 0,
    "IsMultiple": true,
    "DisplayValue": "string",
    "Notes": "string",
    "DisplayNotesInline": true,
    "DisplayDownloadableCheckbox": true,
    "EnableWysiwyg": true,
    "EnableCodeEditor": true,
    "PreValues": [
      "string"
    ],
    "EditorAlias": "string",
    "Value": "string",
    "Indexer": "string",
    "Unique": true
  }
]

POST Module Property Create

Creates a new Module Property based on the provided data.

/api/v2/admin/modules/{id}/properties

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "Mandatory": true,
  "IsMultiple": true,
  "DisplayNotesInline": true,
  "DisplayDownloadableCheckbox": true,
  "EnableWysiwyg": true,
  "EnableCodeEditor": true,
  "Notes": "string",
  "EditorAlias": "string",
  "PreValues": [
    "string"
  ]
}

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "string",
  "Alias": "string",
  "Mandatory": true,
  "SortOrder": 0,
  "IsMultiple": true,
  "DisplayValue": "string",
  "Notes": "string",
  "EnableWysiwyg": true,
  "PreValues": [
    "string"
  ],
  "EditorAlias": "string",
  "Value": "string"
}

PUT Module Property Update

Updates a single Module Property based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/modules/{id}/properties

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "Mandatory": true,
  "IsMultiple": true,
  "DisplayNotesInline": true,
  "DisplayDownloadableCheckbox": true,
  "EnableWysiwyg": true,
  "EnableCodeEditor": true,
  "Notes": "string",
  "EditorAlias": "string",
  "PreValues": [
    "string"
  ]
}

{
  "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "string",
  "Alias": "string",
  "Mandatory": true,
  "SortOrder": 0,
  "IsMultiple": true,
  "DisplayValue": "string",
  "Notes": "string",
  "EnableWysiwyg": true,
  "PreValues": [
    "string"
  ],
  "EditorAlias": "string",
  "Value": "string"
}

DELETE Module Property Delete

Deletes a single Module Property based on the ID passed in the endpoint URL.

/api/v2/admin/modules/{id}/properties/{alias}

Data / Response:

N/A

Status 204

GET Module Property Settings

Retrieves the Module Property Settings as a JSON response based on the ID passed in the URL endpoint.

/api/v2/admin/modules/{id}/property-settings

Data / Response:

N/A

{
  "CategoriesRootId": "string",
  "DefaultTemplate": "string",
  "DisableItemsForSiteSearch": true,
  "EnableAuthor": true,
  "EnableCategories": true,
  "EnableExpirationDate": true,
  "EnableMultipleDetailLayout": true,
  "EnableReleaseDate": true,
  "EnableTags": true,
  "EnableWeighting": true,
  "ItemExpiry": 0,
  "SeoPriority": 0,
  "ShowNewItemsForSearchEngines": true
}

PUT Module Property Settings Update

Updates the Module Property Settings based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/modules/{id}/property-settings

Data / Response:

{
  "CategoriesRootId": "string",
  "DefaultTemplate": "string",
  "DisableItemsForSiteSearch": true,
  "EnableAuthor": true,
  "EnableCategories": true,
  "EnableExpirationDate": true,
  "EnableMultipleDetailLayout": true,
  "EnableReleaseDate": true,
  "EnableTags": true,
  "EnableWeighting": true,
  "ItemExpiry": 0,
  "SeoPriority": 0,
  "ShowNewItemsForSearchEngines": true
}

{
  "CategoriesRootId": "string",
  "DefaultTemplate": "string",
  "DisableItemsForSiteSearch": true,
  "EnableAuthor": true,
  "EnableCategories": true,
  "EnableExpirationDate": true,
  "EnableMultipleDetailLayout": true,
  "EnableReleaseDate": true,
  "EnableTags": true,
  "EnableWeighting": true,
  "ItemExpiry": 0,
  "SeoPriority": 0,
  "ShowNewItemsForSearchEngines": true
}

POST Module Property Set Sort Order

Sets the sort order of the Module Properties based on the data provided.

/api/v2/admin/modules/{id}/properties-order

Data / Response:

[
   "string"
]

[
  {
    "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "Name": "string",
    "Alias": "string",
    "Mandatory": true,
    "SortOrder": 0,
    "IsMultiple": true,
    "DisplayValue": "string",
    "Notes": "string",
    "DisplayNotesInline": true,
    "DisplayDownloadableCheckbox": true,
    "EnableWysiwyg": true,
    "EnableCodeEditor": true,
    "PreValues": [
      "string"
    ],
    "EditorAlias": "string",
    "Value": "string",
    "Indexer": "string",
    "Unique": true
  }
]

Related Articles

  • Liquid Components
    module (Custom Modules)
    This module component fetches data relating to Custom Modules.
  • OpenAPI (Admin)
    Modules API
    Create, Retrieve, Update and Delete Modules via the public API endpoint using "where" filtering.
  • OpenAPI (Admin)
    Module Items API
    Create, Retrieve, Update and Delete Module Items via the public API endpoint using "where" filtering as well as Retrieve and Update Module Item's SEO data.
  • Content Modules
    Custom Modules
    Custom Modules can be used to construct simple or complex data structures as a way to dynamically manage the content on your site or web application.
  • OpenAPI (Admin)
    Module Items Attributes API
    Create, Retrieve, Update and Delete Module Items Attributes via the public API endpoint via "where" filtering as well as update the attribute sort order.
  • OpenAPI (Admin)
    Module Items Attribute Options API
    Create, Update and Delete Module Items Attribute Options via the public API endpoint.
  • OpenAPI (Admin)
    Module Item Draft API
    Update and Delete Module Item Drafts via the public API endpoint including the publishing of drafts.
  • OpenAPI (Admin)
    Module Item Prices API
    Create, Retrieve, Update and Delete a Module Item's Prices via the public API endpoint.
  • OpenAPI (Admin)
    Module Item Inventory API
    Retrieve, Update and Delete Module Item Inventory via the public API endpoint as well as generating inventory variations.
  • OpenAPI (Admin)
    Module Item Related Items API
    Retrieve and Update a Module Item's Related Items via the public API endpoint.
  • OpenAPI (Admin)
    Module Item Grouped Items API
    Create, Retrieve, Update and Delete a Module Item's Grouped Items via the public API endpoint.
  • OpenAPI (Admin)
    Module Item Parent Items API
    Retrieve and Update a Module Item's Parent Items via the public API endpoint.
  • Extensions
    Import/Export of Modules
    Quickly and easily replicate (or back-up) a complete Custom Module configuration via import/export, including; Settings, Properties, Layouts and Table setup.
  • OpenAPI (Admin)
    Module Layouts API
    Create, Retrieve, Update or Delete Module Layouts via the public API endpoint using "where" filtering.

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.

Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.