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.
FormTypeName | 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": "ff1659be-0900-41ac-a13b-416d0f4deb89", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "bf230741-d475-4e36-b17b-4ea060766ea3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3c82faac-ae2a-4dd6-bd2a-40835ef41b0b", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T22:19:35.7006317-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "7acd5b0e-9b48-4eff-b3a5-c6233ae8d2bf", "Section": { "FormTypeSectionId": "407b22d3-6e3f-4079-809f-a98f7a8d2d45", "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": "4195a0cb-0242-4785-a6f0-dd1070162dd0", "Name": "sample string 1" }, "Unit": { "UnitId": "26654fcc-172e-4f1c-a3f7-47c84d0fde98", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7cbbd41a-e986-4109-ab75-2b5d27db950a", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e9947527-1ca9-4c64-b9a0-67d5aaa5c1b5", "FieldId": "665babc5-407d-406c-80af-d69aefd1f501", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e9947527-1ca9-4c64-b9a0-67d5aaa5c1b5", "FieldId": "665babc5-407d-406c-80af-d69aefd1f501", "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": "7acd5b0e-9b48-4eff-b3a5-c6233ae8d2bf", "Section": { "FormTypeSectionId": "407b22d3-6e3f-4079-809f-a98f7a8d2d45", "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": "4195a0cb-0242-4785-a6f0-dd1070162dd0", "Name": "sample string 1" }, "Unit": { "UnitId": "26654fcc-172e-4f1c-a3f7-47c84d0fde98", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7cbbd41a-e986-4109-ab75-2b5d27db950a", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e9947527-1ca9-4c64-b9a0-67d5aaa5c1b5", "FieldId": "665babc5-407d-406c-80af-d69aefd1f501", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e9947527-1ca9-4c64-b9a0-67d5aaa5c1b5", "FieldId": "665babc5-407d-406c-80af-d69aefd1f501", "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": "fe5872fa-3f08-49b4-a375-be0080cb8124", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T22:19:35.7006317-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": "fb034ab3-6bf7-44f3-89ac-87c299437a0c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a4d650e5-5bc1-4853-a855-cdd5b19eacfb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "32a92196-2f97-49c5-b452-97176683858f", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T22:19:35.7006317-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f2209637-c58c-4924-b948-d359dd326874", "Section": { "FormTypeSectionId": "bcc0e739-6c12-4ef4-a9bc-33ce06807e17", "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": "dae2ff77-bc48-4217-81ea-8120dedcb46a", "Name": "sample string 1" }, "Unit": { "UnitId": "9374875f-22de-4754-bc5a-d972adaca4c3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "68b7b500-4daa-4426-998a-3828cbef0af0", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "aed814bd-a3d5-46e1-8bd7-485a13c5d616", "FieldId": "836ac6cf-0cb2-4736-a84b-8327af45638c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "aed814bd-a3d5-46e1-8bd7-485a13c5d616", "FieldId": "836ac6cf-0cb2-4736-a84b-8327af45638c", "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": "f2209637-c58c-4924-b948-d359dd326874", "Section": { "FormTypeSectionId": "bcc0e739-6c12-4ef4-a9bc-33ce06807e17", "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": "dae2ff77-bc48-4217-81ea-8120dedcb46a", "Name": "sample string 1" }, "Unit": { "UnitId": "9374875f-22de-4754-bc5a-d972adaca4c3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "68b7b500-4daa-4426-998a-3828cbef0af0", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "aed814bd-a3d5-46e1-8bd7-485a13c5d616", "FieldId": "836ac6cf-0cb2-4736-a84b-8327af45638c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "aed814bd-a3d5-46e1-8bd7-485a13c5d616", "FieldId": "836ac6cf-0cb2-4736-a84b-8327af45638c", "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": "47f5f4fa-868d-4e52-8cbd-fafa3fb3bb41", "CreateDate": "2025-06-30T22:19:35.7006317-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T22:19:35.7006317-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }