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. |
|
| 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": "238d9847-dc6a-473d-a1fd-69d39140e546",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f2371aec-c508-4c6d-a2c8-870262b7452d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "529e0e72-ba75-4416-b77b-5395e54d2d00",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-19T17:33:25.5510895-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "99e1416a-860d-48b9-85b1-6c5c983fc983",
"Section": {
"FormTypeSectionId": "56e53775-5867-4c6a-bb17-811c15724425",
"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": "989371f8-746b-4836-adab-f722eadee49d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "581387b4-0223-4ca3-980e-9d223451de5f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e3264dd-b38e-4346-899d-847fe86fb4ac",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "29c6fc8b-c67c-4874-9967-baec0506eb2d",
"FieldId": "5eac7908-d815-46db-bff7-90c4ecf9c73a",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "29c6fc8b-c67c-4874-9967-baec0506eb2d",
"FieldId": "5eac7908-d815-46db-bff7-90c4ecf9c73a",
"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": "99e1416a-860d-48b9-85b1-6c5c983fc983",
"Section": {
"FormTypeSectionId": "56e53775-5867-4c6a-bb17-811c15724425",
"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": "989371f8-746b-4836-adab-f722eadee49d",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "581387b4-0223-4ca3-980e-9d223451de5f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6e3264dd-b38e-4346-899d-847fe86fb4ac",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "29c6fc8b-c67c-4874-9967-baec0506eb2d",
"FieldId": "5eac7908-d815-46db-bff7-90c4ecf9c73a",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "29c6fc8b-c67c-4874-9967-baec0506eb2d",
"FieldId": "5eac7908-d815-46db-bff7-90c4ecf9c73a",
"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": "5de8753d-2da4-4309-bc4d-24676c4de15d",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 7"
}
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": "8178cea4-d0b5-4956-91e9-80ff4f611d1f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8670e844-ca44-44c4-9faf-87550f8cc33c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fd987318-f9bf-45a7-8d48-ab2dd2ddace8",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-19T17:33:25.5510895-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ac9cdefc-a8d6-475a-ba16-11614d5f99b2",
"Section": {
"FormTypeSectionId": "6b6c2116-5243-453b-b722-ddded8b93303",
"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": "2e728ca0-bc9f-4212-9835-d1b65a254ed8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "985e3381-0e21-47e3-b240-e5d324afe1fb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d7ddac3f-2035-45e8-9736-c98b5aa25069",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "995dc79b-b6cb-494c-9fce-53f1d6c9fff1",
"FieldId": "a3fec780-35dc-4b04-8507-ec34eac26f15",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "995dc79b-b6cb-494c-9fce-53f1d6c9fff1",
"FieldId": "a3fec780-35dc-4b04-8507-ec34eac26f15",
"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": "ac9cdefc-a8d6-475a-ba16-11614d5f99b2",
"Section": {
"FormTypeSectionId": "6b6c2116-5243-453b-b722-ddded8b93303",
"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": "2e728ca0-bc9f-4212-9835-d1b65a254ed8",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "985e3381-0e21-47e3-b240-e5d324afe1fb",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d7ddac3f-2035-45e8-9736-c98b5aa25069",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "995dc79b-b6cb-494c-9fce-53f1d6c9fff1",
"FieldId": "a3fec780-35dc-4b04-8507-ec34eac26f15",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "995dc79b-b6cb-494c-9fce-53f1d6c9fff1",
"FieldId": "a3fec780-35dc-4b04-8507-ec34eac26f15",
"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": "49f14016-f4b6-4836-9320-9ec4f1eda9a6",
"CreateDate": "2026-05-19T17:33:25.5510895-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-19T17:33:25.5510895-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}