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": "7199a906-cfb5-428d-8a86-751140f7e4d1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cf72ac82-01e2-4ce4-9447-94b0d7ded554",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a9739489-9720-469a-988b-17869c89ea2a",
"CreateDate": "2026-07-09T08:31:46.2525303-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-09T08:31:46.2525303-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-09T08:31:46.2525303-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "08c5049d-503b-414a-b45e-df1e1778b28f",
"Section": {
"FormTypeSectionId": "2a5aa957-b806-4393-b489-4e846b1a0728",
"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": "0b31571a-ea47-415a-b48a-7be565c44b87",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "05dfa0af-e841-4c7f-b372-3108f6903c8a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b2a6e8c-8a75-49ed-9ac5-330ffb6cb504",
"CreateDate": "2026-07-09T08:31:46.2525303-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-09T08:31:46.2525303-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3a8c4314-dddf-43af-8609-b89abc1c274d",
"FieldId": "607c8457-ecba-4ecd-b166-f0281ed30a43",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3a8c4314-dddf-43af-8609-b89abc1c274d",
"FieldId": "607c8457-ecba-4ecd-b166-f0281ed30a43",
"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": "08c5049d-503b-414a-b45e-df1e1778b28f",
"Section": {
"FormTypeSectionId": "2a5aa957-b806-4393-b489-4e846b1a0728",
"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": "0b31571a-ea47-415a-b48a-7be565c44b87",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "05dfa0af-e841-4c7f-b372-3108f6903c8a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5b2a6e8c-8a75-49ed-9ac5-330ffb6cb504",
"CreateDate": "2026-07-09T08:31:46.2525303-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-09T08:31:46.2525303-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3a8c4314-dddf-43af-8609-b89abc1c274d",
"FieldId": "607c8457-ecba-4ecd-b166-f0281ed30a43",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3a8c4314-dddf-43af-8609-b89abc1c274d",
"FieldId": "607c8457-ecba-4ecd-b166-f0281ed30a43",
"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": "5a2cf6e8-dca0-4779-bef5-fce7761a90da",
"CreateDate": "2026-07-09T08:31:46.2525303-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-09T08:31:46.2525303-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"
}