POST api/v2/CustomModules
Request
URI Parameters
Body Parameters
CustomModuleNew| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | ||
| Identification | string | ||
| Url | string | ||
| Token | string | ||
| Active | boolean | ||
| SuspendedScreen | boolean | ||
| JavaScript | string | ||
| TypeScript | string | ||
| Width | decimal number | ||
| Height | decimal number | ||
| CustomModuleRoutes | ObjectCascadeOfCustomModuleRouteBasic |
Request Formats
application/json, text/json
Sample:
{
"Id": 1,
"Identification": "sample string 2",
"Url": "sample string 3",
"Token": "sample string 4",
"Active": true,
"SuspendedScreen": true,
"JavaScript": "sample string 7",
"TypeScript": "sample string 8",
"Width": 1.1,
"Height": 1.1,
"CustomModuleRoutes": {
"PostItems": [
{
"Id": 1,
"AccessRoutes": "sample string 2",
"InitialRoute": true,
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"CustomModuleId": 6,
"RenderType": {
"Id": 1,
"Identification": "sample string 2"
}
},
{
"Id": 1,
"AccessRoutes": "sample string 2",
"InitialRoute": true,
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"CustomModuleId": 6,
"RenderType": {
"Id": 1,
"Identification": "sample string 2"
}
}
],
"PutItems": [
{
"Id": 1,
"AccessRoutes": "sample string 2",
"InitialRoute": true,
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"CustomModuleId": 6,
"RenderType": {
"Id": 1,
"Identification": "sample string 2"
}
},
{
"Id": 1,
"AccessRoutes": "sample string 2",
"InitialRoute": true,
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"CustomModuleId": 6,
"RenderType": {
"Id": 1,
"Identification": "sample string 2"
}
}
],
"DeleteItems": [
{
"Id": 1,
"AccessRoutes": "sample string 2",
"InitialRoute": true,
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"CustomModuleId": 6,
"RenderType": {
"Id": 1,
"Identification": "sample string 2"
}
},
{
"Id": 1,
"AccessRoutes": "sample string 2",
"InitialRoute": true,
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"CustomModuleId": 6,
"RenderType": {
"Id": 1,
"Identification": "sample string 2"
}
}
]
}
}
text/html
Sample:
{"Id":1,"Identification":"sample string 2","Url":"sample string 3","Token":"sample string 4","Active":true,"SuspendedScreen":true,"JavaScript":"sample string 7","TypeScript":"sample string 8","Width":1.1,"Height":1.1,"CustomModuleRoutes":{"PostItems":[{"Id":1,"AccessRoutes":"sample string 2","InitialRoute":true,"JavaScript":"sample string 4","TypeScript":"sample string 5","CustomModuleId":6,"RenderType":{"Id":1,"Identification":"sample string 2"}},{"Id":1,"AccessRoutes":"sample string 2","InitialRoute":true,"JavaScript":"sample string 4","TypeScript":"sample string 5","CustomModuleId":6,"RenderType":{"Id":1,"Identification":"sample string 2"}}],"PutItems":[{"Id":1,"AccessRoutes":"sample string 2","InitialRoute":true,"JavaScript":"sample string 4","TypeScript":"sample string 5","CustomModuleId":6,"RenderType":{"Id":1,"Identification":"sample string 2"}},{"Id":1,"AccessRoutes":"sample string 2","InitialRoute":true,"JavaScript":"sample string 4","TypeScript":"sample string 5","CustomModuleId":6,"RenderType":{"Id":1,"Identification":"sample string 2"}}],"DeleteItems":[{"Id":1,"AccessRoutes":"sample string 2","InitialRoute":true,"JavaScript":"sample string 4","TypeScript":"sample string 5","CustomModuleId":6,"RenderType":{"Id":1,"Identification":"sample string 2"}},{"Id":1,"AccessRoutes":"sample string 2","InitialRoute":true,"JavaScript":"sample string 4","TypeScript":"sample string 5","CustomModuleId":6,"RenderType":{"Id":1,"Identification":"sample string 2"}}]}}
Response
DefaultResultOfCustomModuleDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean | ||
| Messages | Collection of string | ||
| Data | CustomModuleDetail |
Response Format
application/json, text/json
Sample:
{
"Success": true,
"Messages": [
"sample string 1",
"sample string 2"
],
"Data": {
"EditionUser": {
"Active": true,
"CultureId": "sample string 2",
"Login": "sample string 3",
"Email": "sample string 4",
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2025-08-04T18:39:50.2618058Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2025-08-04T18:39:50.2618058Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2025-08-04T18:39:50.2618058Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"SignatureCertFileId": 1,
"LicenseGroup": {
"Id": 1,
"Identification": "sample string 2",
"UserReadOnlyAccessCount": 3,
"UserEditableAccessCount": 4
},
"ReadOnlyAccess": true,
"Reserved": true,
"ServiceAreaId": 1,
"ExternalUser": "sample string 5",
"Id": 6,
"Identification": "sample string 7"
},
"EditionDateTime": "2025-08-04T18:39:50.2618058Z",
"EditionView": "sample string 1",
"ActivationView": "sample string 2",
"ActivationUser": {
"Active": true,
"CultureId": "sample string 2",
"Login": "sample string 3",
"Email": "sample string 4",
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2025-08-04T18:39:50.2618058Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2025-08-04T18:39:50.2618058Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2025-08-04T18:39:50.2618058Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"SignatureCertFileId": 1,
"LicenseGroup": {
"Id": 1,
"Identification": "sample string 2",
"UserReadOnlyAccessCount": 3,
"UserEditableAccessCount": 4
},
"ReadOnlyAccess": true,
"Reserved": true,
"ServiceAreaId": 1,
"ExternalUser": "sample string 5",
"Id": 6,
"Identification": "sample string 7"
},
"ActivationDateTime": "2025-08-04T18:39:50.2618058Z",
"Token": "sample string 3",
"JavaScript": "sample string 4",
"TypeScript": "sample string 5",
"Width": 1.1,
"Height": 1.1,
"Url": "sample string 6",
"Active": true,
"SuspendedScreen": true,
"Id": 9,
"Identification": "sample string 10"
}
}
text/html
Sample:
{"Success":true,"Messages":["sample string 1","sample string 2"],"Data":{"EditionUser":{"Active":true,"CultureId":"sample string 2","Login":"sample string 3","Email":"sample string 4","ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2025-08-04T18:39:50.2618058Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2025-08-04T18:39:50.2618058Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2025-08-04T18:39:50.2618058Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"SignatureCertFileId":1,"LicenseGroup":{"Id":1,"Identification":"sample string 2","UserReadOnlyAccessCount":3,"UserEditableAccessCount":4},"ReadOnlyAccess":true,"Reserved":true,"ServiceAreaId":1,"ExternalUser":"sample string 5","Id":6,"Identification":"sample string 7"},"EditionDateTime":"2025-08-04T18:39:50.2618058Z","EditionView":"sample string 1","ActivationView":"sample string 2","ActivationUser":{"Active":true,"CultureId":"sample string 2","Login":"sample string 3","Email":"sample string 4","ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2025-08-04T18:39:50.2618058Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2025-08-04T18:39:50.2618058Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2025-08-04T18:39:50.2618058Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"SignatureCertFileId":1,"LicenseGroup":{"Id":1,"Identification":"sample string 2","UserReadOnlyAccessCount":3,"UserEditableAccessCount":4},"ReadOnlyAccess":true,"Reserved":true,"ServiceAreaId":1,"ExternalUser":"sample string 5","Id":6,"Identification":"sample string 7"},"ActivationDateTime":"2025-08-04T18:39:50.2618058Z","Token":"sample string 3","JavaScript":"sample string 4","TypeScript":"sample string 5","Width":1.1,"Height":1.1,"Url":"sample string 6","Active":true,"SuspendedScreen":true,"Id":9,"Identification":"sample string 10"}}