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": "bb7d52c5-b421-42bd-b1a7-02bc1ab28fdc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ce6d1032-6c71-46f5-8df3-5e86f4a01fd3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1946e9bd-a286-403e-bff8-bee2088738de", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T03:22:52.577812-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "15b43306-b027-417c-a0f5-d3e0415b4740", "Section": { "FormTypeSectionId": "85494e0c-0877-4ddf-9edc-b65477f12691", "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": "934effa0-dd3d-40e5-a79c-e4c9fdc8bfab", "Name": "sample string 1" }, "Unit": { "UnitId": "6d770634-baef-4087-a06d-dac38329a1de", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b178a8a9-0f7f-480c-8b44-5bedddbdfdd4", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "8e690aaf-e3ae-4a66-99ac-ebd62f7ef493", "FieldId": "72101213-cfab-4293-86ab-d0569d3937fb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "8e690aaf-e3ae-4a66-99ac-ebd62f7ef493", "FieldId": "72101213-cfab-4293-86ab-d0569d3937fb", "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": "15b43306-b027-417c-a0f5-d3e0415b4740", "Section": { "FormTypeSectionId": "85494e0c-0877-4ddf-9edc-b65477f12691", "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": "934effa0-dd3d-40e5-a79c-e4c9fdc8bfab", "Name": "sample string 1" }, "Unit": { "UnitId": "6d770634-baef-4087-a06d-dac38329a1de", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b178a8a9-0f7f-480c-8b44-5bedddbdfdd4", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "8e690aaf-e3ae-4a66-99ac-ebd62f7ef493", "FieldId": "72101213-cfab-4293-86ab-d0569d3937fb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "8e690aaf-e3ae-4a66-99ac-ebd62f7ef493", "FieldId": "72101213-cfab-4293-86ab-d0569d3937fb", "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": "964c4870-80e2-4b7d-9579-693290923868", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T03:22:52.577812-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": "2ceba9d9-1940-4769-b22b-9654380a6df7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "fe728907-ff10-4293-9007-a9b175d80e85", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1919c5cf-bb9b-465a-8277-e72d41230ec0", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T03:22:52.577812-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "e79961aa-6cd6-4fb4-905e-7dc029fe65ba", "Section": { "FormTypeSectionId": "c49127c2-4163-4358-b5c8-37e2dffdde46", "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": "af01a74d-9668-4c81-9c91-3a0c1d9ee0ee", "Name": "sample string 1" }, "Unit": { "UnitId": "20c69669-3281-445c-8104-3294af4e0ea0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a4bfb16a-5a0a-4216-ba5f-5b740bf96026", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "0a3ef746-f46a-4dd1-bb77-43bab7b8bf0a", "FieldId": "6cb416d0-5e5f-4355-92a0-bb605ae5c9cb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "0a3ef746-f46a-4dd1-bb77-43bab7b8bf0a", "FieldId": "6cb416d0-5e5f-4355-92a0-bb605ae5c9cb", "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": "e79961aa-6cd6-4fb4-905e-7dc029fe65ba", "Section": { "FormTypeSectionId": "c49127c2-4163-4358-b5c8-37e2dffdde46", "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": "af01a74d-9668-4c81-9c91-3a0c1d9ee0ee", "Name": "sample string 1" }, "Unit": { "UnitId": "20c69669-3281-445c-8104-3294af4e0ea0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a4bfb16a-5a0a-4216-ba5f-5b740bf96026", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "0a3ef746-f46a-4dd1-bb77-43bab7b8bf0a", "FieldId": "6cb416d0-5e5f-4355-92a0-bb605ae5c9cb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "0a3ef746-f46a-4dd1-bb77-43bab7b8bf0a", "FieldId": "6cb416d0-5e5f-4355-92a0-bb605ae5c9cb", "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": "bdc12292-d454-41fc-b962-4b220d53adbe", "CreateDate": "2025-07-31T03:22:52.577812-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T03:22:52.577812-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }