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": "5bef1eb8-9f64-4df0-92cd-711165c3e13e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6c737b9d-20e6-4ee8-a466-f8f35e27070e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "44b8db48-ec1e-4a6d-a324-b872ee2e54c5",
"CreateDate": "2026-11-17T00:35:48.351737-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T00:35:48.351737-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-17T00:35:48.351737-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "30a261ef-4af2-42d5-95a7-9d53487f6b5a",
"Section": {
"FormTypeSectionId": "55fc0681-472b-4455-8166-cd196377cdd8",
"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": "2a50e970-2b49-4628-9ded-ec7aed6b196f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "90833faf-c2e1-4813-b513-d72879f62b8e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d2d3f238-4aeb-46c8-9d37-97b45b9221fd",
"CreateDate": "2026-11-17T00:35:48.351737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-17T00:35:48.351737-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d9ddf6a7-d45a-4f0e-b243-9912e9b86aa6",
"FieldId": "b41affe8-be5c-4282-a3e4-3b107ce73f0e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d9ddf6a7-d45a-4f0e-b243-9912e9b86aa6",
"FieldId": "b41affe8-be5c-4282-a3e4-3b107ce73f0e",
"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": "30a261ef-4af2-42d5-95a7-9d53487f6b5a",
"Section": {
"FormTypeSectionId": "55fc0681-472b-4455-8166-cd196377cdd8",
"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": "2a50e970-2b49-4628-9ded-ec7aed6b196f",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "90833faf-c2e1-4813-b513-d72879f62b8e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d2d3f238-4aeb-46c8-9d37-97b45b9221fd",
"CreateDate": "2026-11-17T00:35:48.351737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-17T00:35:48.351737-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d9ddf6a7-d45a-4f0e-b243-9912e9b86aa6",
"FieldId": "b41affe8-be5c-4282-a3e4-3b107ce73f0e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d9ddf6a7-d45a-4f0e-b243-9912e9b86aa6",
"FieldId": "b41affe8-be5c-4282-a3e4-3b107ce73f0e",
"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": "1c490f5d-4a44-446d-880e-38a3dcd4f4b6",
"CreateDate": "2026-11-17T00:35:48.351737-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-17T00:35:48.351737-08: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"
}