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": "dee351b1-d125-494e-86fe-2060490da1ae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "37a15783-30ba-4111-914a-76b2e41c6e9c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "a923cdbc-5dda-4d54-a5f6-88c29cb8abbc", "CreateDate": "2025-04-25T15:40:32.4949282-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:40:32.4949282-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T15:40:32.4949282-07:00", "Fields": [ { "FormTypeFieldId": "7ffdda36-1839-4c87-8f4f-5b9422ea8bc1", "Section": { "FormTypeSectionId": "3e64c453-d744-4d93-9486-1951ec4adf7b", "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": "9acf5b50-0d7d-4adc-b236-2040a61b8ee7", "Name": "sample string 1" }, "Unit": { "UnitId": "c8e2caca-7808-4949-8045-9ca1862e0f42", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8d3feee0-b2f0-4646-b59b-a28e9087463e", "CreateDate": "2025-04-25T15:40:32.4949282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:40:32.4949282-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "788d2bbc-2a33-4f68-b513-a5570e071169", "FieldId": "0a9e11b7-2aed-4634-8269-aea9f8623c47", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "788d2bbc-2a33-4f68-b513-a5570e071169", "FieldId": "0a9e11b7-2aed-4634-8269-aea9f8623c47", "FieldName": "sample string 1", "FieldLable": "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": "7ffdda36-1839-4c87-8f4f-5b9422ea8bc1", "Section": { "FormTypeSectionId": "3e64c453-d744-4d93-9486-1951ec4adf7b", "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": "9acf5b50-0d7d-4adc-b236-2040a61b8ee7", "Name": "sample string 1" }, "Unit": { "UnitId": "c8e2caca-7808-4949-8045-9ca1862e0f42", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8d3feee0-b2f0-4646-b59b-a28e9087463e", "CreateDate": "2025-04-25T15:40:32.4949282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:40:32.4949282-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "788d2bbc-2a33-4f68-b513-a5570e071169", "FieldId": "0a9e11b7-2aed-4634-8269-aea9f8623c47", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "788d2bbc-2a33-4f68-b513-a5570e071169", "FieldId": "0a9e11b7-2aed-4634-8269-aea9f8623c47", "FieldName": "sample string 1", "FieldLable": "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": "9d1cad8c-b2e0-4fc5-bf05-52011a9a748c", "CreateDate": "2025-04-25T15:40:32.4949282-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:40:32.4949282-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }