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": "4ab9db86-e5a1-438b-a936-1da55e987489",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "166c2506-ac93-488b-a9a7-fa636cf93cd4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6af2a75e-7329-4df1-a149-9cfea224f511",
"CreateDate": "2026-08-20T20:31:28.505688-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-20T20:31:28.505688-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-20T20:31:28.505688-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "4484cbb2-29d1-4cf7-8c1e-55d149109580",
"Section": {
"FormTypeSectionId": "7d583805-1535-421f-8010-876004423e00",
"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": "d2b331d1-b5e1-4b08-8421-07a0bd51c396",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7ba3ac31-5dae-4006-8be7-4377263a688e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c3f3ddb-0de7-4d94-ba60-6afcaf987a73",
"CreateDate": "2026-08-20T20:31:28.505688-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-20T20:31:28.505688-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6eedbf01-303b-4d0c-949e-be9b42993e70",
"FieldId": "c371e9d5-9636-4a42-85d7-ae3da71c141e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6eedbf01-303b-4d0c-949e-be9b42993e70",
"FieldId": "c371e9d5-9636-4a42-85d7-ae3da71c141e",
"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": "4484cbb2-29d1-4cf7-8c1e-55d149109580",
"Section": {
"FormTypeSectionId": "7d583805-1535-421f-8010-876004423e00",
"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": "d2b331d1-b5e1-4b08-8421-07a0bd51c396",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7ba3ac31-5dae-4006-8be7-4377263a688e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c3f3ddb-0de7-4d94-ba60-6afcaf987a73",
"CreateDate": "2026-08-20T20:31:28.505688-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-20T20:31:28.505688-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "6eedbf01-303b-4d0c-949e-be9b42993e70",
"FieldId": "c371e9d5-9636-4a42-85d7-ae3da71c141e",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "6eedbf01-303b-4d0c-949e-be9b42993e70",
"FieldId": "c371e9d5-9636-4a42-85d7-ae3da71c141e",
"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": "fe30fdfe-73af-4f51-99c6-1cee0f0e1b6f",
"CreateDate": "2026-08-20T20:31:28.505688-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-20T20:31:28.505688-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"
}