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": "2b028659-2354-4fdb-bd3f-0eab6fcd7809",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "56597ede-b2c1-4a40-b3c3-4cd191dd6b9f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0b1602a4-8c91-4c6d-9593-e59562a5dae6",
"CreateDate": "2025-09-15T18:42:08.0906083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-15T18:42:08.0906083-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-09-15T18:42:08.0906083-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "b6e4f9bb-d5b6-4598-8709-bf73f28fac9c",
"Section": {
"FormTypeSectionId": "4439b62f-9a60-4848-83ee-33fc6bd877d2",
"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": "c7c91513-6cdc-4b90-aebf-23b39dca1fd9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "55b38982-f95a-449e-9894-5a1eedb273d3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a7ae21d-d88d-459c-9189-6202a829b3d1",
"CreateDate": "2025-09-15T18:42:08.0906083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-15T18:42:08.0906083-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a510b730-ea5f-4316-be3a-f9350fc225c0",
"FieldId": "7b42b606-c2eb-443c-818d-b5e1a086f8c3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a510b730-ea5f-4316-be3a-f9350fc225c0",
"FieldId": "7b42b606-c2eb-443c-818d-b5e1a086f8c3",
"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": "b6e4f9bb-d5b6-4598-8709-bf73f28fac9c",
"Section": {
"FormTypeSectionId": "4439b62f-9a60-4848-83ee-33fc6bd877d2",
"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": "c7c91513-6cdc-4b90-aebf-23b39dca1fd9",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "55b38982-f95a-449e-9894-5a1eedb273d3",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6a7ae21d-d88d-459c-9189-6202a829b3d1",
"CreateDate": "2025-09-15T18:42:08.0906083-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-15T18:42:08.0906083-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "a510b730-ea5f-4316-be3a-f9350fc225c0",
"FieldId": "7b42b606-c2eb-443c-818d-b5e1a086f8c3",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "a510b730-ea5f-4316-be3a-f9350fc225c0",
"FieldId": "7b42b606-c2eb-443c-818d-b5e1a086f8c3",
"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": "31cd6fb1-9a8f-4576-ab5f-22c91c242eff",
"CreateDate": "2025-09-15T18:42:08.0906083-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-15T18:42:08.0906083-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": "b6e666fc-2a4c-4c49-94d4-f1434800735a",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f27ea974-23b0-487a-bb22-780256da99e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1a64f317-5d31-45b6-ba99-541a0d0ac2e9",
"CreateDate": "2025-09-15T18:42:08.418735-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-15T18:42:08.418735-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-09-15T18:42:08.418735-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "74776263-7bfc-4fda-926c-302231192f47",
"Section": {
"FormTypeSectionId": "068e5a26-1198-47ae-b6be-14f927fada0b",
"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": "050ef3c6-ca7c-4007-bcff-bc3faec0cbd3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b25cdedb-719d-40ba-bdfc-a1198fcb40a1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "91b8737a-978d-436c-bd34-782f751587ca",
"CreateDate": "2025-09-15T18:42:08.418735-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-15T18:42:08.418735-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8c5f0ef7-ac07-4094-8319-6219cdc9c3ee",
"FieldId": "cd1e7c7e-8988-4d42-b222-7465e42a3246",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8c5f0ef7-ac07-4094-8319-6219cdc9c3ee",
"FieldId": "cd1e7c7e-8988-4d42-b222-7465e42a3246",
"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": "74776263-7bfc-4fda-926c-302231192f47",
"Section": {
"FormTypeSectionId": "068e5a26-1198-47ae-b6be-14f927fada0b",
"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": "050ef3c6-ca7c-4007-bcff-bc3faec0cbd3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b25cdedb-719d-40ba-bdfc-a1198fcb40a1",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "91b8737a-978d-436c-bd34-782f751587ca",
"CreateDate": "2025-09-15T18:42:08.418735-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-15T18:42:08.418735-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8c5f0ef7-ac07-4094-8319-6219cdc9c3ee",
"FieldId": "cd1e7c7e-8988-4d42-b222-7465e42a3246",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8c5f0ef7-ac07-4094-8319-6219cdc9c3ee",
"FieldId": "cd1e7c7e-8988-4d42-b222-7465e42a3246",
"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": "cdc95ebd-ccde-440f-816b-dbed03b3f4ca",
"CreateDate": "2025-09-15T18:42:08.418735-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-15T18:42:08.418735-07:00",
"LastModifiedUser": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}