Contributors:
Modules API
Create, Retrieve, Update and Delete Modules via the public API endpoint using "where" filtering.
GET Modules List
Retrieves a list of Modules as a JSON response based on your provided query parameters.
/api/v2/admin/modules
Data / Response:
{
"Where" : {},
"Order_By" : "Id",
"Offset" : 0,
"Limit" : 100,
}
{
"Items": [
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Title": "string",
"Notes": "string",
"MediaFolder": "string",
"NewItemButtonValue": "string",
"UrlSlug": "string",
"Icon": "string",
"LastUpdatedDate": "2024-05-22T16:57:15.059Z",
"IsDefault": true,
"SecureZones": [
0
],
"ExtraSettings": {
"EnableRollback": true
},
"SiteUserPermissions": {
"SpecifyExpiryDate": true,
"RequiresApproval": true,
"FrontendApiRestrictionSettings": [
{
"NotificationSettings": {
"CustomWorkflowIds": [
0
],
"EmailNotification": {
"EmailContent": "string",
"EmailFromAddress": "string",
"EmailSubject": "string",
"FromName": "string",
"TemplateId": 0
}
},
"Id": 0,
"Enable": true,
"FrontendApiRestrictionType": "AddItems",
"HasOwnership": true,
"OwnershipRestriction": "OnlyOwnerAllowed",
"UserTypeApiRestriction": "LoggedInUser",
"SecureZones": [
0
],
"Title": "string"
}
]
},
"AdvancedOptions": {
"ChildModuleId": 0,
"AllowItemsTreeView": true,
"AllowItemsSimplifiedTreeView": true,
"AllowItemsListView": true,
"AllowMultipleParentItems": true,
"EnableSubscription": true,
"EnableRelatedModuleItems": true,
"DefaultItemsView": "string",
"RootTreeLevelViewAllowAddItemsOfParentType": true,
"RootTreeLevelViewAllowAddItemsOfChildType": true,
"InnerTreeLevelViewAllowAddItemsOfParentType": true,
"InnerTreeLevelViewAllowAddItemsOfChildType": true,
"AllowCreatingForeignItems": true
}
}
],
"TotalItemsCount": 0
}
POST Module Create
Creates a new Module based on the provided data.
/api/v2/admin/modules
Data / Response:
{
"Name": "string",
"Alias": "string",
"Title": "string",
"Notes": "string",
"MediaFolder": "string",
"NewItemButtonValue": "string",
"UrlSlug": "string",
"Icon": "string",
"LastUpdatedDate": "2024-05-22T16:57:26.954Z",
"IsDefault": true,
"SecureZones": [
0
],
"DisableDetailLayout": true,
"MediaFilesUploadFolder": "string",
"ExtraSettings": {
"EnableRollback": true
},
"SiteUserPermissions": {
"SpecifyExpiryDate": true,
"RequiresApproval": true,
"FrontendApiRestrictionSettings": [
{
"NotificationSettings": {
"CustomWorkflowIds": [
0
],
"EmailNotification": {
"EmailContent": "string",
"EmailFromAddress": "string",
"EmailSubject": "string",
"FromName": "string",
"TemplateId": 0
}
},
"Id": 0,
"Enable": true,
"FrontendApiRestrictionType": "AddItems",
"HasOwnership": true,
"OwnershipRestriction": "OnlyOwnerAllowed",
"UserTypeApiRestriction": "LoggedInUser",
"SecureZones": [
0
]
}
]
},
"AdvancedOptions": {
"ChildModuleId": 0,
"AllowItemsTreeView": true,
"AllowItemsSimplifiedTreeView": true,
"AllowItemsListView": true,
"AllowMultipleParentItems": true,
"EnableSubscription": true,
"EnableRelatedModuleItems": true,
"DefaultItemsView": "string",
"RootTreeLevelViewAllowAddItemsOfParentType": true,
"RootTreeLevelViewAllowAddItemsOfChildType": true,
"InnerTreeLevelViewAllowAddItemsOfParentType": true,
"InnerTreeLevelViewAllowAddItemsOfChildType": true,
"AllowCreatingForeignItems": true
}
}
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Title": "string",
"Notes": "string",
"MediaFolder": "string",
"NewItemButtonValue": "string",
"UrlSlug": "string",
"Icon": "string",
"LastUpdatedDate": "2024-05-22T16:57:26.956Z",
"IsDefault": true,
"SecureZones": [
0
],
"ExtraSettings": {
"EnableRollback": true
},
"SiteUserPermissions": {
"SpecifyExpiryDate": true,
"RequiresApproval": true,
"FrontendApiRestrictionSettings": [
{
"NotificationSettings": {
"CustomWorkflowIds": [
0
],
"EmailNotification": {
"EmailContent": "string",
"EmailFromAddress": "string",
"EmailSubject": "string",
"FromName": "string",
"TemplateId": 0
}
},
"Id": 0,
"Enable": true,
"FrontendApiRestrictionType": "AddItems",
"HasOwnership": true,
"OwnershipRestriction": "OnlyOwnerAllowed",
"UserTypeApiRestriction": "LoggedInUser",
"SecureZones": [
0
],
"Title": "string"
}
]
},
"AdvancedOptions": {
"ChildModuleId": 0,
"AllowItemsTreeView": true,
"AllowItemsSimplifiedTreeView": true,
"AllowItemsListView": true,
"AllowMultipleParentItems": true,
"EnableSubscription": true,
"EnableRelatedModuleItems": true,
"DefaultItemsView": "string",
"RootTreeLevelViewAllowAddItemsOfParentType": true,
"RootTreeLevelViewAllowAddItemsOfChildType": true,
"InnerTreeLevelViewAllowAddItemsOfParentType": true,
"InnerTreeLevelViewAllowAddItemsOfChildType": true,
"AllowCreatingForeignItems": true
}
}
GET Module Item
Retrieves a single Module based on the ID passed in the endpoint URL.
/api/v2/admin/modules/{id}
Data / Response:
N/A
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Title": "string",
"Notes": "string",
"MediaFolder": "string",
"NewItemButtonValue": "string",
"UrlSlug": "string",
"Icon": "string",
"LastUpdatedDate": "2024-05-22T16:57:26.956Z",
"IsDefault": true,
"SecureZones": [
0
],
"ExtraSettings": {
"EnableRollback": true
},
"SiteUserPermissions": {
"SpecifyExpiryDate": true,
"RequiresApproval": true,
"FrontendApiRestrictionSettings": [
{
"NotificationSettings": {
"CustomWorkflowIds": [
0
],
"EmailNotification": {
"EmailContent": "string",
"EmailFromAddress": "string",
"EmailSubject": "string",
"FromName": "string",
"TemplateId": 0
}
},
"Id": 0,
"Enable": true,
"FrontendApiRestrictionType": "AddItems",
"HasOwnership": true,
"OwnershipRestriction": "OnlyOwnerAllowed",
"UserTypeApiRestriction": "LoggedInUser",
"SecureZones": [
0
],
"Title": "string"
}
]
},
"AdvancedOptions": {
"ChildModuleId": 0,
"AllowItemsTreeView": true,
"AllowItemsSimplifiedTreeView": true,
"AllowItemsListView": true,
"AllowMultipleParentItems": true,
"EnableSubscription": true,
"EnableRelatedModuleItems": true,
"DefaultItemsView": "string",
"RootTreeLevelViewAllowAddItemsOfParentType": true,
"RootTreeLevelViewAllowAddItemsOfChildType": true,
"InnerTreeLevelViewAllowAddItemsOfParentType": true,
"InnerTreeLevelViewAllowAddItemsOfChildType": true,
"AllowCreatingForeignItems": true
}
}
PUT Module Update
Updates a single Module based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/modules/{id}
Data / Response:
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Title": "string",
"Notes": "string",
"MediaFolder": "string",
"NewItemButtonValue": "string",
"UrlSlug": "string",
"Icon": "string",
"LastUpdatedDate": "2024-05-22T16:57:53.588Z",
"IsDefault": true,
"SecureZones": [
0
],
"DisableDetailLayout": true,
"MediaFilesUploadFolder": "string",
"ExtraSettings": {
"EnableRollback": true
},
"SiteUserPermissions": {
"SpecifyExpiryDate": true,
"RequiresApproval": true,
"FrontendApiRestrictionSettings": [
{
"NotificationSettings": {
"CustomWorkflowIds": [
0
],
"EmailNotification": {
"EmailContent": "string",
"EmailFromAddress": "string",
"EmailSubject": "string",
"FromName": "string",
"TemplateId": 0
}
},
"Id": 0,
"Enable": true,
"FrontendApiRestrictionType": "AddItems",
"HasOwnership": true,
"OwnershipRestriction": "OnlyOwnerAllowed",
"UserTypeApiRestriction": "LoggedInUser",
"SecureZones": [
0
]
}
]
},
"AdvancedOptions": {
"ChildModuleId": 0,
"AllowItemsTreeView": true,
"AllowItemsSimplifiedTreeView": true,
"AllowItemsListView": true,
"AllowMultipleParentItems": true,
"EnableSubscription": true,
"EnableRelatedModuleItems": true,
"DefaultItemsView": "string",
"RootTreeLevelViewAllowAddItemsOfParentType": true,
"RootTreeLevelViewAllowAddItemsOfChildType": true,
"InnerTreeLevelViewAllowAddItemsOfParentType": true,
"InnerTreeLevelViewAllowAddItemsOfChildType": true,
"AllowCreatingForeignItems": true
}
}
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Title": "string",
"Notes": "string",
"MediaFolder": "string",
"NewItemButtonValue": "string",
"UrlSlug": "string",
"Icon": "string",
"LastUpdatedDate": "2024-05-22T16:57:26.956Z",
"IsDefault": true,
"SecureZones": [
0
],
"ExtraSettings": {
"EnableRollback": true
},
"SiteUserPermissions": {
"SpecifyExpiryDate": true,
"RequiresApproval": true,
"FrontendApiRestrictionSettings": [
{
"NotificationSettings": {
"CustomWorkflowIds": [
0
],
"EmailNotification": {
"EmailContent": "string",
"EmailFromAddress": "string",
"EmailSubject": "string",
"FromName": "string",
"TemplateId": 0
}
},
"Id": 0,
"Enable": true,
"FrontendApiRestrictionType": "AddItems",
"HasOwnership": true,
"OwnershipRestriction": "OnlyOwnerAllowed",
"UserTypeApiRestriction": "LoggedInUser",
"SecureZones": [
0
],
"Title": "string"
}
]
},
"AdvancedOptions": {
"ChildModuleId": 0,
"AllowItemsTreeView": true,
"AllowItemsSimplifiedTreeView": true,
"AllowItemsListView": true,
"AllowMultipleParentItems": true,
"EnableSubscription": true,
"EnableRelatedModuleItems": true,
"DefaultItemsView": "string",
"RootTreeLevelViewAllowAddItemsOfParentType": true,
"RootTreeLevelViewAllowAddItemsOfChildType": true,
"InnerTreeLevelViewAllowAddItemsOfParentType": true,
"InnerTreeLevelViewAllowAddItemsOfChildType": true,
"AllowCreatingForeignItems": true
}
}
DELETE Module Delete
Deletes a single Module based on the ID passed in the endpoint URL.
/api/v2/admin/modules/{id}
Data / Response:
N/A
Status 204