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. |
|
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": "e18f46eb-fedb-4a4d-a35a-a516ce2a18ee", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5b27cc05-e5f4-4950-be1a-d1bc9703b554", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4fbdf123-7243-449e-90b2-5ba2287e6a6d", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:15:15.4096106-07:00", "Fields": [ { "FormTypeFieldId": "ebc6bd40-380e-4494-8da7-d140f23ca7a7", "Section": { "FormTypeSectionId": "57072869-73fe-472b-9200-a0ef56de09da", "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": "b616eb69-099b-4849-ab00-41f0f57da567", "Name": "sample string 1" }, "Unit": { "UnitId": "2bf7286f-77f3-475e-bc6b-77248f6715de", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "14ee92aa-f5f0-45cd-91e0-0e99d6453339", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "ebc6bd40-380e-4494-8da7-d140f23ca7a7", "Section": { "FormTypeSectionId": "57072869-73fe-472b-9200-a0ef56de09da", "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": "b616eb69-099b-4849-ab00-41f0f57da567", "Name": "sample string 1" }, "Unit": { "UnitId": "2bf7286f-77f3-475e-bc6b-77248f6715de", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "14ee92aa-f5f0-45cd-91e0-0e99d6453339", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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 3", "CompanyId": "148592a0-1eb3-40d1-9a9c-b8f2cf5579e9", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 6" }
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": "2ac6f5bb-e4cc-48e4-b7ba-aa20e5bd989b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7d87b00c-a1b6-4de3-9770-f7c422f99612", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e1f55935-3fe9-4d7c-b816-a7d3268f813e", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:15:15.4096106-07:00", "Fields": [ { "FormTypeFieldId": "1669433b-75a1-4e2a-84e0-a5060723bce8", "Section": { "FormTypeSectionId": "6c7572a4-ac1c-453f-94d4-f4ca3392d3f0", "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": "8012ac3b-b9ed-4dee-a642-1fdb17aa8432", "Name": "sample string 1" }, "Unit": { "UnitId": "ca69c15f-4c9b-430a-840e-26dae2684852", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f3360d0e-6719-4a2b-9a1e-9710140db12c", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "1669433b-75a1-4e2a-84e0-a5060723bce8", "Section": { "FormTypeSectionId": "6c7572a4-ac1c-453f-94d4-f4ca3392d3f0", "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": "8012ac3b-b9ed-4dee-a642-1fdb17aa8432", "Name": "sample string 1" }, "Unit": { "UnitId": "ca69c15f-4c9b-430a-840e-26dae2684852", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f3360d0e-6719-4a2b-9a1e-9710140db12c", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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 3", "CompanyId": "8bcb62e9-68a4-42ce-bee2-7168c434864e", "CreateDate": "2025-05-09T00:15:15.4096106-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:15:15.4096106-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }