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": "7639a2fd-b1c8-4285-b651-da2c42540b4c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "67a88251-2a89-4275-b34f-53f9e4532888", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f5f60ba6-4ee3-4150-b56c-a9e070f405b4", "CreateDate": "2025-07-03T17:27:35.2434995-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-03T17:27:35.2434995-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-03T17:27:35.2434995-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "7e2e31bc-523e-4860-9eaf-db8100940abe", "Section": { "FormTypeSectionId": "77b522a3-b4ba-47fc-ad4b-37b29ea057a3", "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": "5c6ee092-7f88-4d03-90f2-6636b70125ee", "Name": "sample string 1" }, "Unit": { "UnitId": "6423a305-40a8-4aec-b31c-d51d69924d74", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a8daca17-a4b5-45a5-b4d3-d52ba186191e", "CreateDate": "2025-07-03T17:27:35.2434995-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-03T17:27:35.2434995-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3eab39c6-89cc-4afd-ae3c-b9247383c2bc", "FieldId": "cd6e6f96-78ec-4623-9209-ea648b26623f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3eab39c6-89cc-4afd-ae3c-b9247383c2bc", "FieldId": "cd6e6f96-78ec-4623-9209-ea648b26623f", "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": "7e2e31bc-523e-4860-9eaf-db8100940abe", "Section": { "FormTypeSectionId": "77b522a3-b4ba-47fc-ad4b-37b29ea057a3", "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": "5c6ee092-7f88-4d03-90f2-6636b70125ee", "Name": "sample string 1" }, "Unit": { "UnitId": "6423a305-40a8-4aec-b31c-d51d69924d74", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a8daca17-a4b5-45a5-b4d3-d52ba186191e", "CreateDate": "2025-07-03T17:27:35.2434995-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-03T17:27:35.2434995-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3eab39c6-89cc-4afd-ae3c-b9247383c2bc", "FieldId": "cd6e6f96-78ec-4623-9209-ea648b26623f", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3eab39c6-89cc-4afd-ae3c-b9247383c2bc", "FieldId": "cd6e6f96-78ec-4623-9209-ea648b26623f", "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": "47cd0c38-d212-4bc5-965e-a9f31b2a9db8", "CreateDate": "2025-07-03T17:27:35.2434995-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-03T17:27:35.2434995-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }