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": "3b2524a2-1207-407b-96e7-abd26a83abf6", "Asset": { "AssetId": "ba19828f-43ac-4822-80e2-10928f36176f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "01194885-1d9f-4983-a009-722ce3c8acfd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "79d7e923-a29b-46b2-9cab-03a30102f16c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "fcd33c70-bd2f-4754-9678-5afc26e7e22d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "MeasurementValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "SourceSystemId": "sample string 3", "CompanyId": "cb58e53e-a9c4-4614-b2fc-736192a3cca7", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "7fd4426e-99f6-4ecc-8917-de294fdb1974", "EffectiveDate": "2025-04-25T15:20:57.4487549-07:00", "StateType": { "StateTypeId": "2057369a-625e-4a32-9520-46414da7e274", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "01194885-1d9f-4983-a009-722ce3c8acfd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "79d7e923-a29b-46b2-9cab-03a30102f16c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "aef3c9ed-7e85-431d-9fc9-110c2662f7f1", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5ba7397d-8ca6-4112-b9e3-319dcb0eaccf", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "19dcdc36-b902-43ca-b102-7244ad09aaa7", "EffectiveDate": "2025-04-25T15:20:57.4487549-07:00", "StatusType": { "StatusTypeId": "f252516e-5ba2-4110-b5e8-fc8c6f37a3b4", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "01194885-1d9f-4983-a009-722ce3c8acfd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "79d7e923-a29b-46b2-9cab-03a30102f16c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "7c5f02c2-8b04-4dae-9f0b-c4c27341c7ce", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f1941799-ec43-47b2-95e8-8955be8c7b3c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "0b2b5905-7cb9-4702-be18-829f22aecab2", "EffectiveDate": "2025-04-25T15:20:57.4487549-07:00", "WellPurposeType": { "WellPurposeTypeId": "23546ac0-984a-49b2-92ee-9dbd02a6d352", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "3138fea6-6fca-4e57-96a3-24170794235c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "8f547776-a6ac-4fd8-9835-acf5e3488d16", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "MeasurementValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d3c27253-b5bf-45b3-8a3d-9c28871cb73b", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "8c91922b-28bd-4cac-aa4d-b59976f54a6f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "01194885-1d9f-4983-a009-722ce3c8acfd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "79d7e923-a29b-46b2-9cab-03a30102f16c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "Fields": [ { "FormTypeFieldId": "7d4b56c8-b1e0-4017-be0a-fa91e17d6af8", "Section": { "FormTypeSectionId": "38098bc4-e911-47cc-afe6-0c77ed27b758", "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": "910e8948-4047-4782-b7e7-082b9f4285c6", "Name": "sample string 1" }, "Unit": { "UnitId": "66fffb38-c5fa-4898-bd96-33171862a32d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31b20822-4776-4aa4-81e7-c602d2fd896f", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "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": "7d4b56c8-b1e0-4017-be0a-fa91e17d6af8", "Section": { "FormTypeSectionId": "38098bc4-e911-47cc-afe6-0c77ed27b758", "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": "910e8948-4047-4782-b7e7-082b9f4285c6", "Name": "sample string 1" }, "Unit": { "UnitId": "66fffb38-c5fa-4898-bd96-33171862a32d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31b20822-4776-4aa4-81e7-c602d2fd896f", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "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": "4fb9b3e0-909a-4539-9450-7295b7eeb7b5", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-04-25T15:20:57.4487549-07:00", "Location": "sample string 1", "TaskId": "cb95b567-090e-47b1-8368-d1b134090490", "Values": [ { "FormFieldValueId": "b5c6a728-9a95-4a26-81d6-19e0cb32d292", "FormId": "99ba4ecd-caba-4c6a-90db-fb0b0e88a235", "FormTypeField": { "FormTypeFieldId": "7d4b56c8-b1e0-4017-be0a-fa91e17d6af8", "FormType": { "FormTypeId": "8c91922b-28bd-4cac-aa4d-b59976f54a6f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "01194885-1d9f-4983-a009-722ce3c8acfd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "79d7e923-a29b-46b2-9cab-03a30102f16c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "4fb9b3e0-909a-4539-9450-7295b7eeb7b5", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "38098bc4-e911-47cc-afe6-0c77ed27b758", "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": "910e8948-4047-4782-b7e7-082b9f4285c6", "Name": "sample string 1" }, "Unit": { "UnitId": "66fffb38-c5fa-4898-bd96-33171862a32d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31b20822-4776-4aa4-81e7-c602d2fd896f", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "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": "b5c6a728-9a95-4a26-81d6-19e0cb32d292", "FormId": "99ba4ecd-caba-4c6a-90db-fb0b0e88a235", "FormTypeField": { "FormTypeFieldId": "7d4b56c8-b1e0-4017-be0a-fa91e17d6af8", "FormType": { "FormTypeId": "8c91922b-28bd-4cac-aa4d-b59976f54a6f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "01194885-1d9f-4983-a009-722ce3c8acfd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "79d7e923-a29b-46b2-9cab-03a30102f16c", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T15:20:57.4487549-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "4fb9b3e0-909a-4539-9450-7295b7eeb7b5", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "38098bc4-e911-47cc-afe6-0c77ed27b758", "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": "910e8948-4047-4782-b7e7-082b9f4285c6", "Name": "sample string 1" }, "Unit": { "UnitId": "66fffb38-c5fa-4898-bd96-33171862a32d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31b20822-4776-4aa4-81e7-c602d2fd896f", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "1f07a1bb-240a-4dd3-9e30-0ba127a8bd55", "FieldId": "2bfd924d-3e63-4269-a7ec-a8db0d1020d6", "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": "94fa90e1-66a5-425a-8ff4-b3bce4e3d72e", "CreateDate": "2025-04-25T15:20:57.4487549-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-04-25T15:20:57.4487549-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }