DELETE FormTypes
Deletes the given form type, including all forms of that type.
Request Information
URI Parameters
None.
Body Parameters
Form type to delete
FormType| Name | Description | Type | Additional information |
|---|---|---|---|
| FormTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| AssetType | AssetType |
None. |
|
| FrequencyNeeded | integer |
None. |
|
| ValueNeededDate | date |
None. |
|
| Active | boolean |
None. |
|
| Fields | Collection of FormTypeField |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FormTypeId": "3478f518-421b-4636-8398-2cae57511999",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "7e00271c-ff71-4478-896e-aadbc04a7a5a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a73d85a3-91d7-49f5-869c-564c68090274",
"CreateDate": "2026-07-06T08:37:07.5900053-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-06T08:37:07.5900053-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-06T08:37:07.5900053-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "843836c2-f146-4531-a8b2-7948f9963f2b",
"Section": {
"FormTypeSectionId": "4eec651e-c5d2-461b-9145-d063141d2d53",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "1c5403c8-8eb5-4d73-ad79-3d9ff456bfcb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34b2e0d5-b784-47d3-8665-11b1cd7cd8e2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8f3b66cb-ba8b-44bc-872d-c8fa4920554b",
"CreateDate": "2026-07-06T08:37:07.5900053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-06T08:37:07.5900053-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c69d5fa0-ae39-4fc1-9e38-7e8a348e0160",
"FieldId": "138c40a3-d38f-4c40-8d3b-7d49238e31ab",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c69d5fa0-ae39-4fc1-9e38-7e8a348e0160",
"FieldId": "138c40a3-d38f-4c40-8d3b-7d49238e31ab",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
},
{
"FormTypeFieldId": "843836c2-f146-4531-a8b2-7948f9963f2b",
"Section": {
"FormTypeSectionId": "4eec651e-c5d2-461b-9145-d063141d2d53",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"SourceSystemId": "sample string 5"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "1c5403c8-8eb5-4d73-ad79-3d9ff456bfcb",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "34b2e0d5-b784-47d3-8665-11b1cd7cd8e2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8f3b66cb-ba8b-44bc-872d-c8fa4920554b",
"CreateDate": "2026-07-06T08:37:07.5900053-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-06T08:37:07.5900053-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c69d5fa0-ae39-4fc1-9e38-7e8a348e0160",
"FieldId": "138c40a3-d38f-4c40-8d3b-7d49238e31ab",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c69d5fa0-ae39-4fc1-9e38-7e8a348e0160",
"FieldId": "138c40a3-d38f-4c40-8d3b-7d49238e31ab",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
}
],
"ValueExpression": "sample string 5",
"RequiredExpression": "sample string 6",
"IsAttachment": true,
"DefaultValueExpression": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"IsRepeatable": true,
"VisibleExpression": "sample string 12",
"SourceSystemId": "sample string 13"
}
],
"SourceSystemId": "sample string 4",
"CompanyId": "419a497e-941c-4f26-b40a-133c3470cb0c",
"CreateDate": "2026-07-06T08:37:07.5900053-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-06T08:37:07.5900053-07:00",
"LastModifiedUser": "sample string 7"
}
Response Information
Resource Description
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Object |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {},
"Total": 1,
"Message": "sample string 2"
}