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": "6c28a49e-d469-49b8-bdd7-51b0810fcae2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "54735658-146e-4db9-8c45-3218b766a92f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dcdf73c2-f5b2-405b-bedb-c333dba78000", "CreateDate": "2025-08-24T09:59:14.924878-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T09:59:14.924878-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T09:59:14.924878-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "e33b12c5-0ee1-4bb0-a45d-7bdecc3f105e", "Section": { "FormTypeSectionId": "c2c30b8a-5374-4786-86fe-1b8766927fe9", "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": "72f7c735-c16a-4702-baf8-272005c623d8", "Name": "sample string 1" }, "Unit": { "UnitId": "fd7ad559-fc24-4cf8-852c-3e4466061419", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6843ba2a-4b87-4fec-b4f0-6d53cea15014", "CreateDate": "2025-08-24T09:59:14.924878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T09:59:14.924878-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "de3d9b26-a47f-47ca-ae55-79a0d32774e6", "FieldId": "7662465d-7795-4b5e-a30f-902691074cf8", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "de3d9b26-a47f-47ca-ae55-79a0d32774e6", "FieldId": "7662465d-7795-4b5e-a30f-902691074cf8", "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": "e33b12c5-0ee1-4bb0-a45d-7bdecc3f105e", "Section": { "FormTypeSectionId": "c2c30b8a-5374-4786-86fe-1b8766927fe9", "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": "72f7c735-c16a-4702-baf8-272005c623d8", "Name": "sample string 1" }, "Unit": { "UnitId": "fd7ad559-fc24-4cf8-852c-3e4466061419", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6843ba2a-4b87-4fec-b4f0-6d53cea15014", "CreateDate": "2025-08-24T09:59:14.924878-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T09:59:14.924878-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "de3d9b26-a47f-47ca-ae55-79a0d32774e6", "FieldId": "7662465d-7795-4b5e-a30f-902691074cf8", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "de3d9b26-a47f-47ca-ae55-79a0d32774e6", "FieldId": "7662465d-7795-4b5e-a30f-902691074cf8", "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": "81462820-a2d8-4cd4-aab8-3585c8902c31", "CreateDate": "2025-08-24T09:59:14.924878-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T09:59:14.924878-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": "fe8035e8-80c8-408d-9559-b72c3fb5a820", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "59c42b05-87e0-477d-8c94-3d608b1d2713", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7bd374fd-ddb3-4510-9cbb-1b6fdb5ab153", "CreateDate": "2025-08-24T09:59:14.9717336-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T09:59:14.9717336-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-24T09:59:14.9717336-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "6bb660a8-301a-4305-9667-69d9dc85eb06", "Section": { "FormTypeSectionId": "c6435c47-19c0-44bf-a57a-2f6cc7f87547", "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": "60ec25d4-2b9f-422a-848c-0e56ee33835c", "Name": "sample string 1" }, "Unit": { "UnitId": "50faa2ef-4b4d-4304-8f68-034c10bfd655", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0bf622c3-254d-4e04-a0d1-0ffafba62185", "CreateDate": "2025-08-24T09:59:14.9717336-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T09:59:14.9717336-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ba465b7a-c09b-4956-874c-f1ab0e68ac70", "FieldId": "ff98c8ba-9546-4692-99ed-7ac59fff0114", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ba465b7a-c09b-4956-874c-f1ab0e68ac70", "FieldId": "ff98c8ba-9546-4692-99ed-7ac59fff0114", "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": "6bb660a8-301a-4305-9667-69d9dc85eb06", "Section": { "FormTypeSectionId": "c6435c47-19c0-44bf-a57a-2f6cc7f87547", "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": "60ec25d4-2b9f-422a-848c-0e56ee33835c", "Name": "sample string 1" }, "Unit": { "UnitId": "50faa2ef-4b4d-4304-8f68-034c10bfd655", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0bf622c3-254d-4e04-a0d1-0ffafba62185", "CreateDate": "2025-08-24T09:59:14.9717336-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-24T09:59:14.9717336-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ba465b7a-c09b-4956-874c-f1ab0e68ac70", "FieldId": "ff98c8ba-9546-4692-99ed-7ac59fff0114", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ba465b7a-c09b-4956-874c-f1ab0e68ac70", "FieldId": "ff98c8ba-9546-4692-99ed-7ac59fff0114", "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": "19b7563f-9ba4-407f-8ec5-e7bcd1a50e18", "CreateDate": "2025-08-24T09:59:14.9717336-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-24T09:59:14.9717336-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }