GET FormTypes?formTypeId={formTypeId}
Retrieves a form type by its Id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formTypeId |
Id of the form type |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the 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": "a8630edf-9999-403e-891d-e27329a2d05e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1863a054-985a-4797-9727-f6cbb86c2b48", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dbd7614a-86a9-435e-b05f-91333b0d7f87", "CreateDate": "2025-10-10T14:52:23.0811914-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:52:23.0811914-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:52:23.0811914-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "30279845-8573-4d71-ae3c-faa0d3272642", "Section": { "FormTypeSectionId": "ef2f8d9a-338f-4d61-a8fc-bfd587a3b9aa", "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": "2f7ca1b6-3795-4703-9913-dae3aad8aa0f", "Name": "sample string 1" }, "Unit": { "UnitId": "c88bbd43-d605-4506-8e3f-fb0415d50047", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d2ea9600-c63c-429f-a024-18bf629d7672", "CreateDate": "2025-10-10T14:52:23.0811914-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:52:23.0811914-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6f9b13f9-0572-488c-a295-81829159922e", "FieldId": "19024dce-9c64-413c-9d98-e39f2ec49b83", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6f9b13f9-0572-488c-a295-81829159922e", "FieldId": "19024dce-9c64-413c-9d98-e39f2ec49b83", "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": "30279845-8573-4d71-ae3c-faa0d3272642", "Section": { "FormTypeSectionId": "ef2f8d9a-338f-4d61-a8fc-bfd587a3b9aa", "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": "2f7ca1b6-3795-4703-9913-dae3aad8aa0f", "Name": "sample string 1" }, "Unit": { "UnitId": "c88bbd43-d605-4506-8e3f-fb0415d50047", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d2ea9600-c63c-429f-a024-18bf629d7672", "CreateDate": "2025-10-10T14:52:23.0811914-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:52:23.0811914-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6f9b13f9-0572-488c-a295-81829159922e", "FieldId": "19024dce-9c64-413c-9d98-e39f2ec49b83", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6f9b13f9-0572-488c-a295-81829159922e", "FieldId": "19024dce-9c64-413c-9d98-e39f2ec49b83", "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": "33e46eed-f4ee-4247-83c8-98e55beac8a5", "CreateDate": "2025-10-10T14:52:23.0811914-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:52:23.0811914-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }