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": "61d5d8e2-e23c-411e-a77c-ca43b990eb24",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6b1ea4a2-113c-4d07-b13f-0aa9df6bd033",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "bc3f7b67-065c-4569-9485-d96bd52de199",
"CreateDate": "2026-08-23T21:20:57.6673804-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T21:20:57.6673804-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-23T21:20:57.6673804-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "eddd0084-1b8b-415a-bcaa-ca2a5bbcc730",
"Section": {
"FormTypeSectionId": "d0f7a232-1f51-42fc-b4fc-04d0c5c472da",
"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": "07fdefe2-be2b-473e-ac38-73d5bc1b0cdf",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "99084eef-5cbd-4c97-8e43-950e881401c5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e3f6d65-001a-4058-a599-d46ebd91e290",
"CreateDate": "2026-08-23T21:20:57.6673804-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T21:20:57.6673804-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9e6e737f-cd96-4136-b5ff-7705b6b65bfc",
"FieldId": "1e410d4e-c723-48d8-8953-37eb0415a0e5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9e6e737f-cd96-4136-b5ff-7705b6b65bfc",
"FieldId": "1e410d4e-c723-48d8-8953-37eb0415a0e5",
"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": "eddd0084-1b8b-415a-bcaa-ca2a5bbcc730",
"Section": {
"FormTypeSectionId": "d0f7a232-1f51-42fc-b4fc-04d0c5c472da",
"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": "07fdefe2-be2b-473e-ac38-73d5bc1b0cdf",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "99084eef-5cbd-4c97-8e43-950e881401c5",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2e3f6d65-001a-4058-a599-d46ebd91e290",
"CreateDate": "2026-08-23T21:20:57.6673804-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-23T21:20:57.6673804-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9e6e737f-cd96-4136-b5ff-7705b6b65bfc",
"FieldId": "1e410d4e-c723-48d8-8953-37eb0415a0e5",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9e6e737f-cd96-4136-b5ff-7705b6b65bfc",
"FieldId": "1e410d4e-c723-48d8-8953-37eb0415a0e5",
"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": "07c08ea2-7622-4764-91a4-84be480ddb27",
"CreateDate": "2026-08-23T21:20:57.6673804-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-23T21:20:57.6673804-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"
}