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": "abeeee7f-f95e-487e-8f2e-25e651a477e3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "40cee8ea-6380-47b0-b5db-f5140b55c9ac",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "83e99d38-f1b6-402d-b2ed-103072fd35cb",
"CreateDate": "2026-11-10T21:10:32.4255456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-10T21:10:32.4255456-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-10T21:10:32.4255456-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8cbddbd7-6ea4-4616-8f74-3ba2278b0518",
"Section": {
"FormTypeSectionId": "c611cd80-1511-43a1-b074-8815a0773f43",
"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": "7424dc3a-cb25-4477-b975-ab5897404a93",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8d88bbea-bfac-4315-a1f2-84392d0d1e4e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6d248cac-b012-422b-ab74-52b1736f0f5f",
"CreateDate": "2026-11-10T21:10:32.4255456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-10T21:10:32.4255456-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "666b24fe-029b-4f1b-afa6-b9822b3d76b4",
"FieldId": "54232aa6-6409-4c0d-9e4c-00e1a4c0929c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "666b24fe-029b-4f1b-afa6-b9822b3d76b4",
"FieldId": "54232aa6-6409-4c0d-9e4c-00e1a4c0929c",
"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": "8cbddbd7-6ea4-4616-8f74-3ba2278b0518",
"Section": {
"FormTypeSectionId": "c611cd80-1511-43a1-b074-8815a0773f43",
"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": "7424dc3a-cb25-4477-b975-ab5897404a93",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8d88bbea-bfac-4315-a1f2-84392d0d1e4e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6d248cac-b012-422b-ab74-52b1736f0f5f",
"CreateDate": "2026-11-10T21:10:32.4255456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-10T21:10:32.4255456-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "666b24fe-029b-4f1b-afa6-b9822b3d76b4",
"FieldId": "54232aa6-6409-4c0d-9e4c-00e1a4c0929c",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "666b24fe-029b-4f1b-afa6-b9822b3d76b4",
"FieldId": "54232aa6-6409-4c0d-9e4c-00e1a4c0929c",
"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": "3c9e6ef4-6cb6-4abf-9008-4b1750d13354",
"CreateDate": "2026-11-10T21:10:32.4255456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-10T21:10:32.4255456-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"
}