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": "734f6ece-cf37-44a9-822b-edf80f0b4629", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c1c3041b-6cc4-42c5-ae62-53818d5ffe96", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9052571a-c5e5-42f8-933d-bef3d9ff70d1", "CreateDate": "2025-02-05T05:54:43.8424113-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T05:54:43.8424113-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-02-05T05:54:43.8424113-08:00", "Fields": [ { "FormTypeFieldId": "8965d4b2-e682-473d-b6e8-9d061ff6ed87", "Section": { "FormTypeSectionId": "b3e1621d-e03d-456a-b130-7f017c15ad53", "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": "9264b154-feca-4e54-9627-cc95ee8fc1f6", "Name": "sample string 1" }, "Unit": { "UnitId": "fde3b502-9e4b-4a3a-a0f2-3be0d164d0e0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0a792ebf-8ba9-4118-8905-4b4ca71cc6f8", "CreateDate": "2025-02-05T05:54:43.8424113-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T05:54:43.8424113-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ac5a9026-10e7-4eff-b7b3-61436b5de3b1", "FieldId": "624a3aad-f5ca-49ac-9bac-86180591eda2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ac5a9026-10e7-4eff-b7b3-61436b5de3b1", "FieldId": "624a3aad-f5ca-49ac-9bac-86180591eda2", "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": "8965d4b2-e682-473d-b6e8-9d061ff6ed87", "Section": { "FormTypeSectionId": "b3e1621d-e03d-456a-b130-7f017c15ad53", "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": "9264b154-feca-4e54-9627-cc95ee8fc1f6", "Name": "sample string 1" }, "Unit": { "UnitId": "fde3b502-9e4b-4a3a-a0f2-3be0d164d0e0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0a792ebf-8ba9-4118-8905-4b4ca71cc6f8", "CreateDate": "2025-02-05T05:54:43.8424113-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T05:54:43.8424113-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ac5a9026-10e7-4eff-b7b3-61436b5de3b1", "FieldId": "624a3aad-f5ca-49ac-9bac-86180591eda2", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ac5a9026-10e7-4eff-b7b3-61436b5de3b1", "FieldId": "624a3aad-f5ca-49ac-9bac-86180591eda2", "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 3", "CompanyId": "16321150-4119-4398-9638-38ca9b2d451f", "CreateDate": "2025-02-05T05:54:43.8424113-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T05:54:43.8424113-08:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }