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": "4bf124a5-6b6b-4599-a351-2caa6b34e95c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "07caaaa8-8ede-4661-b1ca-084e62f10852",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "61958017-9014-478b-80bd-60179c21d83c",
"CreateDate": "2026-08-08T16:52:58.0039428-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-08T16:52:58.0039428-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-08T16:52:58.0039428-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "5a363463-23e9-4a48-87b1-2d508fced77f",
"Section": {
"FormTypeSectionId": "5e219f8e-d86d-40d5-9bf0-af595448cdde",
"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": "b5869d0d-f4f2-4ea5-8411-6d241dcf194a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cac8ccf6-ed58-4730-9b57-1857eab1768b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f00db6d-69c3-44b7-947a-86d4fb45844b",
"CreateDate": "2026-08-08T16:52:58.0039428-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T16:52:58.0039428-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2300ba22-59cb-4bd5-bac8-8c14995c96bd",
"FieldId": "c33b6b89-8a07-4367-b40c-a72b25591467",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2300ba22-59cb-4bd5-bac8-8c14995c96bd",
"FieldId": "c33b6b89-8a07-4367-b40c-a72b25591467",
"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": "5a363463-23e9-4a48-87b1-2d508fced77f",
"Section": {
"FormTypeSectionId": "5e219f8e-d86d-40d5-9bf0-af595448cdde",
"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": "b5869d0d-f4f2-4ea5-8411-6d241dcf194a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cac8ccf6-ed58-4730-9b57-1857eab1768b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9f00db6d-69c3-44b7-947a-86d4fb45844b",
"CreateDate": "2026-08-08T16:52:58.0039428-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-08T16:52:58.0039428-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "2300ba22-59cb-4bd5-bac8-8c14995c96bd",
"FieldId": "c33b6b89-8a07-4367-b40c-a72b25591467",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "2300ba22-59cb-4bd5-bac8-8c14995c96bd",
"FieldId": "c33b6b89-8a07-4367-b40c-a72b25591467",
"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": "f97936da-32b8-4ed8-a981-dbe0f4d2fb2e",
"CreateDate": "2026-08-08T16:52:58.0039428-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-08T16:52:58.0039428-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"
}