GET Forms?formId={formId}
Retrieves a form by its Id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formId |
Id of the form |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Form |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "FormId": "19b3d9bc-159d-484a-81aa-9c00ec76fb56", "Asset": { "AssetId": "19cc9dfb-c459-48b9-a322-36edd9b43b82", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "16eed624-2a5e-4514-8448-05939167cbce", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "628f9ae8-884f-4128-9205-f36825eeb071", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "bdc657ef-c4e9-4cc9-a529-23d286116ae8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "MeasurementValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "SourceSystemId": "sample string 3", "CompanyId": "990ab307-9548-4beb-abe7-2c5f17daeaa2", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "28719181-3129-4f5b-8c2c-bea162f872d0", "EffectiveDate": "2025-08-29T17:11:27.2882474-07:00", "StateType": { "StateTypeId": "4d0b37a5-9d32-42e6-90b9-8442117adb2e", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "16eed624-2a5e-4514-8448-05939167cbce", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "628f9ae8-884f-4128-9205-f36825eeb071", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "ce28bfdb-c981-4bd3-b276-1f4c92908a5f", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "feb0e531-ed8a-4405-9cbe-0366d2387ce1", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "e0ec7c47-f8ef-4ba8-b93c-dcee7bfddb4a", "EffectiveDate": "2025-08-29T17:11:27.2882474-07:00", "StatusType": { "StatusTypeId": "c4d1df17-f5e1-4c3b-9c02-bbd0f3939303", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "16eed624-2a5e-4514-8448-05939167cbce", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "628f9ae8-884f-4128-9205-f36825eeb071", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "6b66b0dd-8ad1-45ee-8fe4-f90ff3ea3757", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "607cff27-2134-452e-8c5e-4fbab1997fb1", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "29b00ded-a84c-4760-b6e6-8e45622159e9", "EffectiveDate": "2025-08-29T17:11:27.2882474-07:00", "WellPurposeType": { "WellPurposeTypeId": "aad81cd3-ae05-4e66-b3fd-2b1f62add137", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "4e17e595-23a4-4478-976c-f5947440c0e3", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "49cafc5f-2f96-4062-9155-8a16440a3a63", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "MeasurementValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "13fe0deb-23ff-465d-af2f-13b8d1d15b6e", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6efaf87c-41e6-49fc-8996-73c87f1c6320", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "16eed624-2a5e-4514-8448-05939167cbce", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "628f9ae8-884f-4128-9205-f36825eeb071", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "Fields": [ { "FormTypeFieldId": "3c31a8a7-9cb6-4c0c-9386-94b2d4ede872", "Section": { "FormTypeSectionId": "1c0754db-74e5-4b26-a9f1-dfe2376cc767", "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": "3880ca72-23bc-40dc-a433-15ab76a13c8d", "Name": "sample string 1" }, "Unit": { "UnitId": "d845f554-f70e-4ab2-a6d8-2e69f1b64cc0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d7b2e63c-5865-4c54-abfb-97af1977736b", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "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": "3c31a8a7-9cb6-4c0c-9386-94b2d4ede872", "Section": { "FormTypeSectionId": "1c0754db-74e5-4b26-a9f1-dfe2376cc767", "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": "3880ca72-23bc-40dc-a433-15ab76a13c8d", "Name": "sample string 1" }, "Unit": { "UnitId": "d845f554-f70e-4ab2-a6d8-2e69f1b64cc0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d7b2e63c-5865-4c54-abfb-97af1977736b", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "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": "d16478d6-49cc-4751-a8af-258543e058de", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-08-29T17:11:27.2882474-07:00", "Location": "sample string 1", "TaskId": "9c80a047-f20c-4c5c-9ac6-5a1620e48da9", "Values": [ { "FormFieldValueId": "96a840d5-a0fe-460f-8742-56b5493f3cf0", "FormId": "fd32f596-f015-4d41-ae1a-5182519d89d2", "FormTypeField": { "FormTypeFieldId": "3c31a8a7-9cb6-4c0c-9386-94b2d4ede872", "FormType": { "FormTypeId": "6efaf87c-41e6-49fc-8996-73c87f1c6320", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "16eed624-2a5e-4514-8448-05939167cbce", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "628f9ae8-884f-4128-9205-f36825eeb071", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "d16478d6-49cc-4751-a8af-258543e058de", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "1c0754db-74e5-4b26-a9f1-dfe2376cc767", "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": "3880ca72-23bc-40dc-a433-15ab76a13c8d", "Name": "sample string 1" }, "Unit": { "UnitId": "d845f554-f70e-4ab2-a6d8-2e69f1b64cc0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d7b2e63c-5865-4c54-abfb-97af1977736b", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "96a840d5-a0fe-460f-8742-56b5493f3cf0", "FormId": "fd32f596-f015-4d41-ae1a-5182519d89d2", "FormTypeField": { "FormTypeFieldId": "3c31a8a7-9cb6-4c0c-9386-94b2d4ede872", "FormType": { "FormTypeId": "6efaf87c-41e6-49fc-8996-73c87f1c6320", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "16eed624-2a5e-4514-8448-05939167cbce", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "628f9ae8-884f-4128-9205-f36825eeb071", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-29T17:11:27.2882474-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "d16478d6-49cc-4751-a8af-258543e058de", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "1c0754db-74e5-4b26-a9f1-dfe2376cc767", "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": "3880ca72-23bc-40dc-a433-15ab76a13c8d", "Name": "sample string 1" }, "Unit": { "UnitId": "d845f554-f70e-4ab2-a6d8-2e69f1b64cc0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d7b2e63c-5865-4c54-abfb-97af1977736b", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f863b1f9-1252-4da0-ad5e-e785b8c02ffa", "FieldId": "2a98f84d-bcd4-49e3-98ba-746f5e954ebb", "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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "504e32ab-5840-4f31-9154-7b5a3339330a", "CreateDate": "2025-08-29T17:11:27.2882474-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-29T17:11:27.2882474-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }