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": "82cb358a-6160-4d6b-9f90-5d24abed2805", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5ea32504-a089-46e3-b2f7-3de0a01c0573", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "820373dc-3cd4-49d0-ba9c-0f54102942d1", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-01T17:07:15.0035478-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "bafe8b02-57a3-4216-8c85-50235b376cdd", "Section": { "FormTypeSectionId": "e8e66ea5-4287-4cd1-8bf7-a918aa5cb130", "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": "6740d169-1f8c-4243-9392-8da29c592097", "Name": "sample string 1" }, "Unit": { "UnitId": "3683bddd-6021-41c5-8952-ee5e2b4ee691", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5d90a071-fa5c-41ac-b3e7-86a3e4591dba", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "142fcc7e-0601-4c62-bb74-80c70cf35007", "FieldId": "b1b6fa9a-637f-4b45-a561-3cbb66d6e74c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "142fcc7e-0601-4c62-bb74-80c70cf35007", "FieldId": "b1b6fa9a-637f-4b45-a561-3cbb66d6e74c", "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": "bafe8b02-57a3-4216-8c85-50235b376cdd", "Section": { "FormTypeSectionId": "e8e66ea5-4287-4cd1-8bf7-a918aa5cb130", "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": "6740d169-1f8c-4243-9392-8da29c592097", "Name": "sample string 1" }, "Unit": { "UnitId": "3683bddd-6021-41c5-8952-ee5e2b4ee691", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5d90a071-fa5c-41ac-b3e7-86a3e4591dba", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "142fcc7e-0601-4c62-bb74-80c70cf35007", "FieldId": "b1b6fa9a-637f-4b45-a561-3cbb66d6e74c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "142fcc7e-0601-4c62-bb74-80c70cf35007", "FieldId": "b1b6fa9a-637f-4b45-a561-3cbb66d6e74c", "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": "a443b58d-aff1-4f77-ae1a-16c9a82774ec", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T17:07:15.0035478-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": "69085c2d-0fa4-4c93-9606-0f0fc75092b2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "454ce39a-b781-43fb-aa86-44fc8615f47e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2c62b1ac-788e-419c-855c-7dff4513cd56", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-01T17:07:15.0035478-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "3b05bf8c-f0ad-44a9-b742-b32f8a5da3f1", "Section": { "FormTypeSectionId": "680650d0-961c-4a55-b18c-ec772ba02f03", "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": "3cdf2dd5-dbe2-450b-82c2-865eb6b0f56c", "Name": "sample string 1" }, "Unit": { "UnitId": "d19e65de-5328-4b01-91ec-bac00ed7d7d8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a39be60c-48e5-4cda-ac9c-cfc3800861d2", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "63875e19-2166-4e5e-9f18-e685c6369ee1", "FieldId": "407e2d0c-3f5b-41ff-8221-80118b16c275", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "63875e19-2166-4e5e-9f18-e685c6369ee1", "FieldId": "407e2d0c-3f5b-41ff-8221-80118b16c275", "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": "3b05bf8c-f0ad-44a9-b742-b32f8a5da3f1", "Section": { "FormTypeSectionId": "680650d0-961c-4a55-b18c-ec772ba02f03", "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": "3cdf2dd5-dbe2-450b-82c2-865eb6b0f56c", "Name": "sample string 1" }, "Unit": { "UnitId": "d19e65de-5328-4b01-91ec-bac00ed7d7d8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a39be60c-48e5-4cda-ac9c-cfc3800861d2", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "63875e19-2166-4e5e-9f18-e685c6369ee1", "FieldId": "407e2d0c-3f5b-41ff-8221-80118b16c275", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "63875e19-2166-4e5e-9f18-e685c6369ee1", "FieldId": "407e2d0c-3f5b-41ff-8221-80118b16c275", "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": "9b483ff2-ed61-4aa7-978a-17585775330e", "CreateDate": "2025-07-01T17:07:15.0035478-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-01T17:07:15.0035478-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }