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": "6af4d7de-6a92-4c65-aea2-d2dedaafb229", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9ec5d994-e0a3-4db7-a681-485a37184bbe", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8263cebb-b3c3-4e95-a125-b26f9c94fc62", "CreateDate": "2025-03-09T08:20:04.3997994-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-03-09T08:20:04.3997994-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-03-09T08:20:04.3997994-07:00", "Fields": [ { "FormTypeFieldId": "707bf85b-aca6-4df9-bddc-328cbaf87a87", "Section": { "FormTypeSectionId": "08214053-e71c-48ef-8c0a-fbda83bb740b", "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": "3e8b1762-0bf6-4d26-a8c7-55b0720463eb", "Name": "sample string 1" }, "Unit": { "UnitId": "25e70ad0-2cde-49e9-8bf0-970d133eff64", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0c2e3418-aa00-4786-949a-9d90effb931d", "CreateDate": "2025-03-09T08:20:04.3997994-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:20:04.3997994-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "07165b9c-18ba-44b3-9bd8-c91c89bc1d85", "FieldId": "d84dba5b-d579-422a-b3bc-c7b92606f8d2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "07165b9c-18ba-44b3-9bd8-c91c89bc1d85", "FieldId": "d84dba5b-d579-422a-b3bc-c7b92606f8d2", "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": "707bf85b-aca6-4df9-bddc-328cbaf87a87", "Section": { "FormTypeSectionId": "08214053-e71c-48ef-8c0a-fbda83bb740b", "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": "3e8b1762-0bf6-4d26-a8c7-55b0720463eb", "Name": "sample string 1" }, "Unit": { "UnitId": "25e70ad0-2cde-49e9-8bf0-970d133eff64", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0c2e3418-aa00-4786-949a-9d90effb931d", "CreateDate": "2025-03-09T08:20:04.3997994-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:20:04.3997994-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "07165b9c-18ba-44b3-9bd8-c91c89bc1d85", "FieldId": "d84dba5b-d579-422a-b3bc-c7b92606f8d2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "07165b9c-18ba-44b3-9bd8-c91c89bc1d85", "FieldId": "d84dba5b-d579-422a-b3bc-c7b92606f8d2", "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": "43cb4d5e-7dfb-447e-8f9f-8849813a604e", "CreateDate": "2025-03-09T08:20:04.3997994-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-03-09T08:20:04.3997994-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }