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": "d14d71de-8ac4-45aa-b13e-ca18d91a8081", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "28a4c1ad-053b-4412-b35d-5f8c13f94a1f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "17765450-2fa3-48b2-baa7-ee27a746e246", "CreateDate": "2024-04-28T18:40:59.0077767-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:40:59.0077767-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T18:40:59.0077767-07:00", "Fields": [ { "FormTypeFieldId": "4bea2dc5-1fdc-4b25-99a5-7d819766b7e2", "Section": { "FormTypeSectionId": "2435e45b-3c42-4d56-bb46-299168e508a7", "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": "ed2b5f2b-93f6-4a12-ab91-b4b7c174bbea", "Name": "sample string 1" }, "Unit": { "UnitId": "fa7112c0-ffbd-4d84-90da-c756173c5eb2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d4cd0d7c-61e4-4e46-9c33-4bd1e5967d30", "CreateDate": "2024-04-28T18:40:59.0077767-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:40:59.0077767-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "4bea2dc5-1fdc-4b25-99a5-7d819766b7e2", "Section": { "FormTypeSectionId": "2435e45b-3c42-4d56-bb46-299168e508a7", "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": "ed2b5f2b-93f6-4a12-ab91-b4b7c174bbea", "Name": "sample string 1" }, "Unit": { "UnitId": "fa7112c0-ffbd-4d84-90da-c756173c5eb2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d4cd0d7c-61e4-4e46-9c33-4bd1e5967d30", "CreateDate": "2024-04-28T18:40:59.0077767-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:40:59.0077767-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "1c4941c5-6069-40d8-8bfd-a2430f71cf6d", "CreateDate": "2024-04-28T18:40:59.0077767-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:40:59.0077767-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }