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": "b7d19b9a-5b39-4b3b-aee4-72efe722ba1f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "07dd6406-90ee-4b98-8a8e-6dda11f03de5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0c44bd1d-d5e0-4ba9-bf70-c27f5fafec06", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-20T20:46:39.9323515-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f88e084b-1f94-44b6-ace9-5cfec9af0a40", "Section": { "FormTypeSectionId": "e3ede785-ad47-41d5-9706-e5a1e1f910bf", "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": "3fe129a5-9d7a-4257-934e-1533066ab664", "Name": "sample string 1" }, "Unit": { "UnitId": "1b82b06a-6465-4199-8a6e-2280f04fe105", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f08aa36b-91ae-41c2-b831-37b6d58bd938", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e498f78b-69a3-4268-ad0e-03e416984f0f", "FieldId": "8d1547ea-7462-4c95-af8e-2aa3b3c568a9", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e498f78b-69a3-4268-ad0e-03e416984f0f", "FieldId": "8d1547ea-7462-4c95-af8e-2aa3b3c568a9", "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": "f88e084b-1f94-44b6-ace9-5cfec9af0a40", "Section": { "FormTypeSectionId": "e3ede785-ad47-41d5-9706-e5a1e1f910bf", "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": "3fe129a5-9d7a-4257-934e-1533066ab664", "Name": "sample string 1" }, "Unit": { "UnitId": "1b82b06a-6465-4199-8a6e-2280f04fe105", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f08aa36b-91ae-41c2-b831-37b6d58bd938", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "e498f78b-69a3-4268-ad0e-03e416984f0f", "FieldId": "8d1547ea-7462-4c95-af8e-2aa3b3c568a9", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "e498f78b-69a3-4268-ad0e-03e416984f0f", "FieldId": "8d1547ea-7462-4c95-af8e-2aa3b3c568a9", "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": "a01318bb-1187-4465-b5b8-a36edd960f7e", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-20T20:46:39.9323515-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": "81bc8754-60b7-42f8-9408-ed7356d440fb", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "39d9cdde-da96-4387-81c7-71507f0263ed", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "cd2c6f4a-9533-4883-a697-515a3b70fd48", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-20T20:46:39.9323515-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "9f35a1dc-b4f2-4331-b91a-dd61e5d63477", "Section": { "FormTypeSectionId": "8e479e13-52d2-4792-b89b-3b4e080b95c8", "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": "7dfc470e-1518-4588-a5ec-b7c7cd5d4801", "Name": "sample string 1" }, "Unit": { "UnitId": "bdd5b3d2-833b-4dcd-8f3b-2bd50d13b208", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a50c81b0-defa-46f5-ae24-43dcf87ad334", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7dc40dcb-73bb-4f80-8dec-8de4df0b4d34", "FieldId": "30e64686-4448-4ad3-9e33-fa2d277685db", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7dc40dcb-73bb-4f80-8dec-8de4df0b4d34", "FieldId": "30e64686-4448-4ad3-9e33-fa2d277685db", "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": "9f35a1dc-b4f2-4331-b91a-dd61e5d63477", "Section": { "FormTypeSectionId": "8e479e13-52d2-4792-b89b-3b4e080b95c8", "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": "7dfc470e-1518-4588-a5ec-b7c7cd5d4801", "Name": "sample string 1" }, "Unit": { "UnitId": "bdd5b3d2-833b-4dcd-8f3b-2bd50d13b208", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a50c81b0-defa-46f5-ae24-43dcf87ad334", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7dc40dcb-73bb-4f80-8dec-8de4df0b4d34", "FieldId": "30e64686-4448-4ad3-9e33-fa2d277685db", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7dc40dcb-73bb-4f80-8dec-8de4df0b4d34", "FieldId": "30e64686-4448-4ad3-9e33-fa2d277685db", "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": "996fe7e7-116a-4555-865c-91a8695728b4", "CreateDate": "2025-10-20T20:46:39.9323515-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-20T20:46:39.9323515-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }