POST FormTypes
Creates a new form type.
Request Information
URI Parameters
None.
Body Parameters
The form type to create. FormTypeId should not be filled in.
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. |
|
| 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": "555c0b1b-cce5-43e4-9306-aa130cf0e004",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c88547d5-73a0-4f3b-a06f-26cacfbaceb2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fdd934b3-e870-42c3-ab9d-69562e1c4d71",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T15:32:20.8893037-08:00",
"Fields": [
{
"FormTypeFieldId": "8a6dc865-2ca7-457b-ae05-3603f4ea095a",
"Section": {
"FormTypeSectionId": "06a6387f-a04e-4e40-92a6-a159f9bfa260",
"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": "abb238c1-0b9a-4c2e-a3d4-ffdbef593413",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4f11b480-b9e6-418a-99b7-86c9a32a66e3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7a6ee4a4-8f02-4401-80e9-5d6b4eebca9c",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "8a6dc865-2ca7-457b-ae05-3603f4ea095a",
"Section": {
"FormTypeSectionId": "06a6387f-a04e-4e40-92a6-a159f9bfa260",
"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": "abb238c1-0b9a-4c2e-a3d4-ffdbef593413",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4f11b480-b9e6-418a-99b7-86c9a32a66e3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7a6ee4a4-8f02-4401-80e9-5d6b4eebca9c",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "7021fb82-e7b8-4e5c-9318-fdd55281c02e",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 6"
}
Response Information
Resource Description
On success, the created form type.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | FormType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormTypeId": "ec41c63c-29ff-41e9-9530-c42f7a4d644b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "b10acc25-8b34-4c59-8f48-e7cb2acbda65",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "015869a0-b143-4749-ab94-69ec86b86961",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T15:32:20.8893037-08:00",
"Fields": [
{
"FormTypeFieldId": "39b059c4-b3ec-4cf8-883a-ccc5dea8b489",
"Section": {
"FormTypeSectionId": "5f789f69-d17f-454e-b4fa-dff978dcc5d2",
"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": "378c9af6-d578-4376-80b8-c483cab100e8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "01c4ab62-78ca-4148-9eff-9c99781b2cb2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5ee022f4-3134-4a09-9c0b-17285aa08f3f",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "39b059c4-b3ec-4cf8-883a-ccc5dea8b489",
"Section": {
"FormTypeSectionId": "5f789f69-d17f-454e-b4fa-dff978dcc5d2",
"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": "378c9af6-d578-4376-80b8-c483cab100e8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "01c4ab62-78ca-4148-9eff-9c99781b2cb2",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5ee022f4-3134-4a09-9c0b-17285aa08f3f",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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 3",
"CompanyId": "5f7d53d6-3505-4027-93c8-8d2999236219",
"CreateDate": "2026-11-21T15:32:20.8893037-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T15:32:20.8893037-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}