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": "f7f6beb4-3ae6-45e7-906e-0393d130b8f2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6d0b3155-4ec6-4041-beda-1d1dd0f23ff4", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0ba06dc9-5425-47c9-a492-701ece0a8437", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:11:42.3525648-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "de927a70-a599-4457-8ff5-da3f414aaabd", "Section": { "FormTypeSectionId": "5de115ad-d8c1-44af-83a4-e3c5c8ffee31", "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": "6b875e52-80af-4467-a055-afd8e52e7299", "Name": "sample string 1" }, "Unit": { "UnitId": "75abc9ad-2239-4d6f-a031-e4a222fbaead", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "63cc8b9e-68ee-4b23-85cb-299c1088e1fb", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a55d13ea-2978-4798-8c7e-257c86d54211", "FieldId": "7c749c40-12e1-4429-baa1-aa29971a0ec2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a55d13ea-2978-4798-8c7e-257c86d54211", "FieldId": "7c749c40-12e1-4429-baa1-aa29971a0ec2", "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": "de927a70-a599-4457-8ff5-da3f414aaabd", "Section": { "FormTypeSectionId": "5de115ad-d8c1-44af-83a4-e3c5c8ffee31", "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": "6b875e52-80af-4467-a055-afd8e52e7299", "Name": "sample string 1" }, "Unit": { "UnitId": "75abc9ad-2239-4d6f-a031-e4a222fbaead", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "63cc8b9e-68ee-4b23-85cb-299c1088e1fb", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a55d13ea-2978-4798-8c7e-257c86d54211", "FieldId": "7c749c40-12e1-4429-baa1-aa29971a0ec2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a55d13ea-2978-4798-8c7e-257c86d54211", "FieldId": "7c749c40-12e1-4429-baa1-aa29971a0ec2", "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": "7f498179-7e65-47f7-9293-46929cac631a", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:11:42.3525648-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": "80c447a4-b7b0-4a9e-aa55-53fd479c0979", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f45e9795-0d1a-4661-b95f-2f95c68b7590", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "24012645-d105-4932-a96e-36c512f4da8d", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:11:42.3525648-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "0f16b1db-518c-40b9-883e-3376dc566a4c", "Section": { "FormTypeSectionId": "c72b46ff-6f53-445f-ad31-865f57a4e974", "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": "a43014ee-01ea-4a66-a3f6-aa3665db141f", "Name": "sample string 1" }, "Unit": { "UnitId": "be00b284-8891-4edd-a61a-78ad9664c735", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28fa536b-52f8-4e54-b463-e84300fe13ca", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "22f08560-98c4-4675-9456-c023e1cbfb34", "FieldId": "c74b83c7-e4d2-4352-affc-a52a081fa1b5", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "22f08560-98c4-4675-9456-c023e1cbfb34", "FieldId": "c74b83c7-e4d2-4352-affc-a52a081fa1b5", "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": "0f16b1db-518c-40b9-883e-3376dc566a4c", "Section": { "FormTypeSectionId": "c72b46ff-6f53-445f-ad31-865f57a4e974", "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": "a43014ee-01ea-4a66-a3f6-aa3665db141f", "Name": "sample string 1" }, "Unit": { "UnitId": "be00b284-8891-4edd-a61a-78ad9664c735", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28fa536b-52f8-4e54-b463-e84300fe13ca", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "22f08560-98c4-4675-9456-c023e1cbfb34", "FieldId": "c74b83c7-e4d2-4352-affc-a52a081fa1b5", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "22f08560-98c4-4675-9456-c023e1cbfb34", "FieldId": "c74b83c7-e4d2-4352-affc-a52a081fa1b5", "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": "ae9d5bd1-c2cd-49eb-971d-ee1b4a201e10", "CreateDate": "2025-09-13T21:11:42.3525648-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:11:42.3525648-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }