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": "777b6d0c-396b-435c-8e8d-ff34d1c4e27f",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e3e1af08-2d1b-41af-aa05-45ff3977bb55",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1938ba7c-0ef4-49aa-99cf-f47e947a5b26",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-15T17:33:13.374032-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "8828222a-2341-4d12-9900-669037ad2e93",
"Section": {
"FormTypeSectionId": "76b70409-c3c8-4bc3-8c73-af346c4647a7",
"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": "7217c748-7588-4514-93f2-2b27a626b037",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c8559aea-64ed-491e-9dba-afc813e5a798",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a3db4ef2-e41d-4601-905b-2452cb5ae0a7",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b0ca8e7-7cd4-47f4-a664-1a8d1afcf9f4",
"FieldId": "237e5455-cec4-4159-8296-d048838c73a6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b0ca8e7-7cd4-47f4-a664-1a8d1afcf9f4",
"FieldId": "237e5455-cec4-4159-8296-d048838c73a6",
"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": "8828222a-2341-4d12-9900-669037ad2e93",
"Section": {
"FormTypeSectionId": "76b70409-c3c8-4bc3-8c73-af346c4647a7",
"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": "7217c748-7588-4514-93f2-2b27a626b037",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "c8559aea-64ed-491e-9dba-afc813e5a798",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a3db4ef2-e41d-4601-905b-2452cb5ae0a7",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4b0ca8e7-7cd4-47f4-a664-1a8d1afcf9f4",
"FieldId": "237e5455-cec4-4159-8296-d048838c73a6",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4b0ca8e7-7cd4-47f4-a664-1a8d1afcf9f4",
"FieldId": "237e5455-cec4-4159-8296-d048838c73a6",
"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": "374100a8-3af9-416e-976d-fa99d040f0eb",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08: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": "507351c9-1298-45f7-b7c4-7acec06ea5da",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "9b0021a0-f1af-4499-a75e-cda0aef3b098",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "49709b73-dcd1-4620-9674-7a5c15b8408a",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-15T17:33:13.374032-08:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "ed01c0f0-32dd-4d8b-8b13-68ba7c780bef",
"Section": {
"FormTypeSectionId": "87d6fe8d-d19b-4e6a-9ac1-2faf0622d709",
"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": "e112273a-779d-45e1-ad95-84c189143f16",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7a68100a-f2ed-419a-8cb8-5d34f7a2dc5b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0455c0e9-fc22-453e-b1f0-f43307a2b012",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4740d296-a83a-451b-bc42-3cca8b168462",
"FieldId": "e0e73db9-4907-4620-b67c-e99846fb8bc9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4740d296-a83a-451b-bc42-3cca8b168462",
"FieldId": "e0e73db9-4907-4620-b67c-e99846fb8bc9",
"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": "ed01c0f0-32dd-4d8b-8b13-68ba7c780bef",
"Section": {
"FormTypeSectionId": "87d6fe8d-d19b-4e6a-9ac1-2faf0622d709",
"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": "e112273a-779d-45e1-ad95-84c189143f16",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "7a68100a-f2ed-419a-8cb8-5d34f7a2dc5b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0455c0e9-fc22-453e-b1f0-f43307a2b012",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "4740d296-a83a-451b-bc42-3cca8b168462",
"FieldId": "e0e73db9-4907-4620-b67c-e99846fb8bc9",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "4740d296-a83a-451b-bc42-3cca8b168462",
"FieldId": "e0e73db9-4907-4620-b67c-e99846fb8bc9",
"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": "ca1875f3-a62d-427b-a770-183dd7af47d6",
"CreateDate": "2026-11-15T17:33:13.374032-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-15T17:33:13.374032-08:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}