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": "6b4b505a-6bb4-4c3f-b68d-1b657e4a9343",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "004779d0-7e85-4c64-85bc-38113e1f752c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "370ed9b3-9c14-4683-b663-971f98321b22",
"CreateDate": "2026-05-30T23:45:45.4750289-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-30T23:45:45.4750289-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-30T23:45:45.4750289-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "5ce42b58-e693-4376-9606-55b53f3da2ab",
"Section": {
"FormTypeSectionId": "66bfd4b6-137b-4884-98ca-fcfcd557db64",
"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": "ded81d25-f8d2-49d5-b6e2-a490bf09b741",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "912c982d-7bba-4c39-8e89-eb8bc749c323",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a60f242a-43a4-4f37-beb9-5377205750ed",
"CreateDate": "2026-05-30T23:45:45.4750289-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T23:45:45.4750289-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "30f7b034-49af-46f3-9532-c93e91c77401",
"FieldId": "001e9a1c-0aef-4fd9-a01a-c69deaad8fda",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "30f7b034-49af-46f3-9532-c93e91c77401",
"FieldId": "001e9a1c-0aef-4fd9-a01a-c69deaad8fda",
"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": "5ce42b58-e693-4376-9606-55b53f3da2ab",
"Section": {
"FormTypeSectionId": "66bfd4b6-137b-4884-98ca-fcfcd557db64",
"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": "ded81d25-f8d2-49d5-b6e2-a490bf09b741",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "912c982d-7bba-4c39-8e89-eb8bc749c323",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a60f242a-43a4-4f37-beb9-5377205750ed",
"CreateDate": "2026-05-30T23:45:45.4750289-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-30T23:45:45.4750289-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "30f7b034-49af-46f3-9532-c93e91c77401",
"FieldId": "001e9a1c-0aef-4fd9-a01a-c69deaad8fda",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "30f7b034-49af-46f3-9532-c93e91c77401",
"FieldId": "001e9a1c-0aef-4fd9-a01a-c69deaad8fda",
"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": "466f76e0-6706-4b8f-8137-0571e6316d7d",
"CreateDate": "2026-05-30T23:45:45.4750289-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-30T23:45:45.4750289-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"
}