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": "349c091c-70c8-46f5-8061-88e3ac9ba697", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f4d92f08-cebf-4732-85d0-7c0fc7a00fe9", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "63070a2c-7c2c-486c-aade-b46bfb9e337b", "CreateDate": "2024-11-22T21:35:31.5151391-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-11-22T21:35:31.5151391-08:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-11-22T21:35:31.5151391-08:00", "Fields": [ { "FormTypeFieldId": "6b563fe2-45cf-48cf-adda-3059329b315d", "Section": { "FormTypeSectionId": "e044344e-21be-4ff0-b4bd-8e472d957a66", "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": "aaca6de9-bccc-42ae-80a8-38014e6e3d6b", "Name": "sample string 1" }, "Unit": { "UnitId": "39b48f5f-b9b3-4527-a8ce-ad8f2871e21c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6593a815-b8f1-43a7-89b9-1d7751d1b23f", "CreateDate": "2024-11-22T21:35:31.5151391-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-11-22T21:35:31.5151391-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ca868831-52ce-4d50-9a4b-e13e091be8f1", "FieldId": "185c3082-c8ee-4647-a1b2-2a7b127550b1", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ca868831-52ce-4d50-9a4b-e13e091be8f1", "FieldId": "185c3082-c8ee-4647-a1b2-2a7b127550b1", "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": "6b563fe2-45cf-48cf-adda-3059329b315d", "Section": { "FormTypeSectionId": "e044344e-21be-4ff0-b4bd-8e472d957a66", "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": "aaca6de9-bccc-42ae-80a8-38014e6e3d6b", "Name": "sample string 1" }, "Unit": { "UnitId": "39b48f5f-b9b3-4527-a8ce-ad8f2871e21c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6593a815-b8f1-43a7-89b9-1d7751d1b23f", "CreateDate": "2024-11-22T21:35:31.5151391-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-11-22T21:35:31.5151391-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ca868831-52ce-4d50-9a4b-e13e091be8f1", "FieldId": "185c3082-c8ee-4647-a1b2-2a7b127550b1", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ca868831-52ce-4d50-9a4b-e13e091be8f1", "FieldId": "185c3082-c8ee-4647-a1b2-2a7b127550b1", "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": "85bc39bc-439e-4a13-9189-2fbe8e5c16b4", "CreateDate": "2024-11-22T21:35:31.5151391-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-11-22T21:35:31.5151391-08:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }