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": "89149511-1971-44fa-a454-7fbaa461cef6",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "092f09ae-49d1-4004-9d18-cf552cbc1f22",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fee0b177-06d1-44a2-a0c2-dd76d8702c64",
"CreateDate": "2026-09-01T20:52:09.7251794-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-01T20:52:09.7251794-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-01T20:52:09.7251794-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "f2eafc86-8cca-461f-ab59-ed8432679148",
"Section": {
"FormTypeSectionId": "bbc9c2b4-d477-415f-a519-bc00e7b6d5cc",
"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": "cb3bb195-5db6-4ac8-a2ea-20fd405a2dd0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a9dca739-bd6a-4469-afd9-18c831922fc9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b929e4a-565a-415b-b06b-1aa08cde2e50",
"CreateDate": "2026-09-01T20:52:09.7251794-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-01T20:52:09.7251794-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7a6482f0-3c0d-4230-aaa3-89b2af594344",
"FieldId": "121aa0a4-c052-4d2f-80ff-081478834020",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7a6482f0-3c0d-4230-aaa3-89b2af594344",
"FieldId": "121aa0a4-c052-4d2f-80ff-081478834020",
"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": "f2eafc86-8cca-461f-ab59-ed8432679148",
"Section": {
"FormTypeSectionId": "bbc9c2b4-d477-415f-a519-bc00e7b6d5cc",
"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": "cb3bb195-5db6-4ac8-a2ea-20fd405a2dd0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "a9dca739-bd6a-4469-afd9-18c831922fc9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9b929e4a-565a-415b-b06b-1aa08cde2e50",
"CreateDate": "2026-09-01T20:52:09.7251794-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-01T20:52:09.7251794-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "7a6482f0-3c0d-4230-aaa3-89b2af594344",
"FieldId": "121aa0a4-c052-4d2f-80ff-081478834020",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "7a6482f0-3c0d-4230-aaa3-89b2af594344",
"FieldId": "121aa0a4-c052-4d2f-80ff-081478834020",
"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": "ba303ebf-261e-4220-9d35-7694530b8354",
"CreateDate": "2026-09-01T20:52:09.7251794-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-01T20:52:09.7251794-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"
}