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": "3544094f-7a85-41ea-a9fe-c3bbac76c2ba", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "50fd5953-128f-4e16-84f5-dd68fd8f378c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "97b59c9c-b508-4c78-81ab-d3eb17d48a05", "CreateDate": "2025-09-18T04:37:04.6417008-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-18T04:37:04.6417008-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-18T04:37:04.6417008-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "c8557b66-e7eb-4fee-b773-7818e185bbf6", "Section": { "FormTypeSectionId": "d88beed8-1d42-443a-b501-ccc6152357b5", "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": "226abee0-a74f-4445-a852-2dbf959d6c60", "Name": "sample string 1" }, "Unit": { "UnitId": "e1159a53-1f09-4364-9943-46b112f687aa", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f6d37e9c-192f-43e7-8636-0899d4d1150c", "CreateDate": "2025-09-18T04:37:04.6572819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T04:37:04.6572819-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f7cdd124-d129-4fbb-80ca-d2dd097ebe26", "FieldId": "9fe7612b-e47b-4db8-9620-724d49dd7cf8", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f7cdd124-d129-4fbb-80ca-d2dd097ebe26", "FieldId": "9fe7612b-e47b-4db8-9620-724d49dd7cf8", "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": "c8557b66-e7eb-4fee-b773-7818e185bbf6", "Section": { "FormTypeSectionId": "d88beed8-1d42-443a-b501-ccc6152357b5", "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": "226abee0-a74f-4445-a852-2dbf959d6c60", "Name": "sample string 1" }, "Unit": { "UnitId": "e1159a53-1f09-4364-9943-46b112f687aa", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f6d37e9c-192f-43e7-8636-0899d4d1150c", "CreateDate": "2025-09-18T04:37:04.6572819-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T04:37:04.6572819-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f7cdd124-d129-4fbb-80ca-d2dd097ebe26", "FieldId": "9fe7612b-e47b-4db8-9620-724d49dd7cf8", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f7cdd124-d129-4fbb-80ca-d2dd097ebe26", "FieldId": "9fe7612b-e47b-4db8-9620-724d49dd7cf8", "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": "788f0c9b-cd02-4a76-98ba-e8c7ced4523e", "CreateDate": "2025-09-18T04:37:04.6572819-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-18T04:37:04.6572819-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }