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": "d39f172b-88da-4d65-bef3-7050bb913d59", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9298678d-610d-4e41-a2cd-0aefced64c0f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c11c41ba-77e2-4658-897c-ac8235644983", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:57:55.5761181-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T07:57:55.5761181-07:00", "Fields": [ { "FormTypeFieldId": "7e11351e-3ac7-4731-9cfb-b1ddd7551a26", "Section": { "FormTypeSectionId": "4d92db7e-4d8c-4ea4-b786-b4bfc3987c27", "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": "7c65202c-1f9a-4858-b796-e3d1d9b4070c", "Name": "sample string 1" }, "Unit": { "UnitId": "345e5386-cc37-4de7-8ead-fb444dc230aa", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "afd6302f-a2d8-41d6-a165-414a552c8f80", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:57:55.5761181-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": "7e11351e-3ac7-4731-9cfb-b1ddd7551a26", "Section": { "FormTypeSectionId": "4d92db7e-4d8c-4ea4-b786-b4bfc3987c27", "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": "7c65202c-1f9a-4858-b796-e3d1d9b4070c", "Name": "sample string 1" }, "Unit": { "UnitId": "345e5386-cc37-4de7-8ead-fb444dc230aa", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "afd6302f-a2d8-41d6-a165-414a552c8f80", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:57:55.5761181-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": "c48ffaf0-643d-433c-99a8-d99a4296b3fa", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:57:55.5761181-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": "131a031c-fb0c-40b9-b18e-955f81021708", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7f51bab6-5c38-4537-9547-0a6b606475ae", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "90e5de1f-b7a6-4a97-baee-14688f33e8e4", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:57:55.5761181-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T07:57:55.5761181-07:00", "Fields": [ { "FormTypeFieldId": "702df8e3-a118-4e1a-9cbf-465f5c697341", "Section": { "FormTypeSectionId": "6589259d-3649-4a80-83a6-ed9ebd26fbee", "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": "6a73bd37-73ba-42b7-8c99-517090579df5", "Name": "sample string 1" }, "Unit": { "UnitId": "866abb4c-72b0-4d85-a77d-3900701cf3f6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "072b2d1a-61b0-49cd-9544-583504521949", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:57:55.5761181-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": "702df8e3-a118-4e1a-9cbf-465f5c697341", "Section": { "FormTypeSectionId": "6589259d-3649-4a80-83a6-ed9ebd26fbee", "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": "6a73bd37-73ba-42b7-8c99-517090579df5", "Name": "sample string 1" }, "Unit": { "UnitId": "866abb4c-72b0-4d85-a77d-3900701cf3f6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "072b2d1a-61b0-49cd-9544-583504521949", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:57:55.5761181-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": "9be8cf97-861a-4481-a44a-671c5fd9e375", "CreateDate": "2025-06-02T07:57:55.5761181-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:57:55.5761181-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }