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": "3317273e-c790-4abf-9af6-51a3a6eeae97", "Asset": { "AssetId": "537d1fba-2bf8-4a76-aa6f-ce18dcaf4819", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "cb6d3f36-b8f1-4a23-81c7-c2d3c168d99b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2b8cb625-180f-4837-86fc-63caaee5a285", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "72212011-51f8-4718-9ef1-90d3d7aace1a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "MeasurementValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "SourceSystemId": "sample string 3", "CompanyId": "01303d64-7bf8-467d-a8b6-3ce5c594a627", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "ea71fb43-a613-4f4b-8788-e431fb308abd", "EffectiveDate": "2025-05-09T00:28:56.3887039-07:00", "StateType": { "StateTypeId": "53ac70c7-b622-42d3-a823-f361ecce093d", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "cb6d3f36-b8f1-4a23-81c7-c2d3c168d99b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2b8cb625-180f-4837-86fc-63caaee5a285", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "36fb4adf-edcd-4816-8545-25be047696f2", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "e9fec174-5a98-4532-94d1-cdfe2275fb5e", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "62593c21-f545-4bc7-8558-be5c62e77df0", "EffectiveDate": "2025-05-09T00:28:56.3887039-07:00", "StatusType": { "StatusTypeId": "d82b147e-cb53-4ac3-8fc5-4d1bec261541", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "cb6d3f36-b8f1-4a23-81c7-c2d3c168d99b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2b8cb625-180f-4837-86fc-63caaee5a285", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "e2380d9a-e6b2-4370-b33f-0673a4251d2b", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ee45a83f-b619-4d4a-8e83-d109b51d82de", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "9d2689e9-086f-42b6-b3eb-e55c4b333d7a", "EffectiveDate": "2025-05-09T00:28:56.3887039-07:00", "WellPurposeType": { "WellPurposeTypeId": "b9d2b21b-3f86-4c2b-a5ec-04acff358b1d", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a3c58dd1-5069-45e0-bb70-d0b3f3f061ac", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0b401fa5-5270-4dee-8d7c-aaa8c56cf1af", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "MeasurementValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e4d22f8b-5df7-4a2c-bf7f-f506e94e4e92", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "ed7ec8af-60cb-45c5-8952-11855bbdb525", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cb6d3f36-b8f1-4a23-81c7-c2d3c168d99b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2b8cb625-180f-4837-86fc-63caaee5a285", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "Fields": [ { "FormTypeFieldId": "0fd29b46-ec41-4889-b74a-689b92bcd321", "Section": { "FormTypeSectionId": "7ffc52e5-5d76-4085-8fc0-cb752cf0137f", "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": "2f1fc3a5-52db-498e-bfe4-3bfa2e756382", "Name": "sample string 1" }, "Unit": { "UnitId": "71c79663-0db0-4546-9574-ba9059aac8cd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eb2569c3-fa49-42f6-9ac0-cace7e401362", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "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": "0fd29b46-ec41-4889-b74a-689b92bcd321", "Section": { "FormTypeSectionId": "7ffc52e5-5d76-4085-8fc0-cb752cf0137f", "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": "2f1fc3a5-52db-498e-bfe4-3bfa2e756382", "Name": "sample string 1" }, "Unit": { "UnitId": "71c79663-0db0-4546-9574-ba9059aac8cd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eb2569c3-fa49-42f6-9ac0-cace7e401362", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "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": "f83e9d26-7218-4326-8f34-b333ba2cb34d", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-09T00:28:56.3887039-07:00", "Location": "sample string 1", "TaskId": "0c4c5210-85ce-4330-aad3-5909d7c6040b", "Values": [ { "FormFieldValueId": "0f3883c3-9854-4433-8490-84d28283ee84", "FormId": "537d1ec9-ad75-47ad-9a60-38c6d12a1429", "FormTypeField": { "FormTypeFieldId": "0fd29b46-ec41-4889-b74a-689b92bcd321", "FormType": { "FormTypeId": "ed7ec8af-60cb-45c5-8952-11855bbdb525", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cb6d3f36-b8f1-4a23-81c7-c2d3c168d99b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2b8cb625-180f-4837-86fc-63caaee5a285", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "f83e9d26-7218-4326-8f34-b333ba2cb34d", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "7ffc52e5-5d76-4085-8fc0-cb752cf0137f", "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": "2f1fc3a5-52db-498e-bfe4-3bfa2e756382", "Name": "sample string 1" }, "Unit": { "UnitId": "71c79663-0db0-4546-9574-ba9059aac8cd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eb2569c3-fa49-42f6-9ac0-cace7e401362", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "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": "0f3883c3-9854-4433-8490-84d28283ee84", "FormId": "537d1ec9-ad75-47ad-9a60-38c6d12a1429", "FormTypeField": { "FormTypeFieldId": "0fd29b46-ec41-4889-b74a-689b92bcd321", "FormType": { "FormTypeId": "ed7ec8af-60cb-45c5-8952-11855bbdb525", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cb6d3f36-b8f1-4a23-81c7-c2d3c168d99b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2b8cb625-180f-4837-86fc-63caaee5a285", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:28:56.3887039-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "f83e9d26-7218-4326-8f34-b333ba2cb34d", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "7ffc52e5-5d76-4085-8fc0-cb752cf0137f", "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": "2f1fc3a5-52db-498e-bfe4-3bfa2e756382", "Name": "sample string 1" }, "Unit": { "UnitId": "71c79663-0db0-4546-9574-ba9059aac8cd", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eb2569c3-fa49-42f6-9ac0-cace7e401362", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "057747f6-360e-4e30-b9ea-fe16b388a385", "FieldId": "cb22432c-4bb2-44a2-9d80-48e49aab1366", "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": "acddc54f-ecf8-4976-8017-09955d19cd72", "CreateDate": "2025-05-09T00:28:56.3887039-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T00:28:56.3887039-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }