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": "9e5aa5a5-3bcd-4de9-b710-3ca38d07aaec", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0d0fea0b-5dc2-434a-804b-d737b127f09a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4882cae0-0035-4a44-b6d6-f6b8ba614265", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:50:53.8174858-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "d9be3ec0-767a-4afa-95dd-4878f8879b37", "Section": { "FormTypeSectionId": "d9da6788-6a92-4111-b513-fb76191bfa06", "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": "50806782-ebc7-458c-aa02-b50330774229", "Name": "sample string 1" }, "Unit": { "UnitId": "89e6b561-477f-44cc-abda-3c6e72eaea7c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ac8be6cb-faa8-4995-838b-17cb5b7a684c", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "df4fe9ed-d537-4384-ab17-ee2776429b15", "FieldId": "93f0637b-2753-4452-b006-33499779a8d4", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "df4fe9ed-d537-4384-ab17-ee2776429b15", "FieldId": "93f0637b-2753-4452-b006-33499779a8d4", "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": "d9be3ec0-767a-4afa-95dd-4878f8879b37", "Section": { "FormTypeSectionId": "d9da6788-6a92-4111-b513-fb76191bfa06", "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": "50806782-ebc7-458c-aa02-b50330774229", "Name": "sample string 1" }, "Unit": { "UnitId": "89e6b561-477f-44cc-abda-3c6e72eaea7c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ac8be6cb-faa8-4995-838b-17cb5b7a684c", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "df4fe9ed-d537-4384-ab17-ee2776429b15", "FieldId": "93f0637b-2753-4452-b006-33499779a8d4", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "df4fe9ed-d537-4384-ab17-ee2776429b15", "FieldId": "93f0637b-2753-4452-b006-33499779a8d4", "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": "61e4f89d-b634-40ea-93fc-f0dbcddbd671", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:50:53.8174858-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": "23d9be97-3b72-4a1f-9108-2fc8dc2e7966", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "16a760ba-e9f1-4a63-a9be-26c5fa0fcf5c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fcd93491-833d-49b5-9576-63debbb7103f", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:50:53.8174858-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "59e8fa8b-77a5-4069-8d37-6e16d64ec163", "Section": { "FormTypeSectionId": "96c9dd43-113f-4090-a1ea-fe66367f9693", "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": "8e242e93-36c3-46a9-bec6-89ec58fdce8c", "Name": "sample string 1" }, "Unit": { "UnitId": "98ad858f-cadc-43bd-8b33-2fe1d0d47e91", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "775f7dbb-2324-497b-98c8-9c67d02e55c8", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "18b19bfa-380a-4260-a4da-111c68840391", "FieldId": "967d3093-85eb-4df8-9259-1b55f9e2955c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "18b19bfa-380a-4260-a4da-111c68840391", "FieldId": "967d3093-85eb-4df8-9259-1b55f9e2955c", "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": "59e8fa8b-77a5-4069-8d37-6e16d64ec163", "Section": { "FormTypeSectionId": "96c9dd43-113f-4090-a1ea-fe66367f9693", "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": "8e242e93-36c3-46a9-bec6-89ec58fdce8c", "Name": "sample string 1" }, "Unit": { "UnitId": "98ad858f-cadc-43bd-8b33-2fe1d0d47e91", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "775f7dbb-2324-497b-98c8-9c67d02e55c8", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "18b19bfa-380a-4260-a4da-111c68840391", "FieldId": "967d3093-85eb-4df8-9259-1b55f9e2955c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "18b19bfa-380a-4260-a4da-111c68840391", "FieldId": "967d3093-85eb-4df8-9259-1b55f9e2955c", "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": "3044544b-6199-46cb-8b15-b4d2cff1eb6a", "CreateDate": "2025-10-10T14:50:53.8174858-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:50:53.8174858-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }