Contributors:
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
}
]