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": "b63702a5-906c-4218-a69f-f56a73092925",
"Asset": {
"AssetId": "95029735-28d7-4faa-9083-d7a6ac71643e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2e452995-ff0e-4046-afbe-3aaaf47ba939",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "536409d1-84ae-46eb-8fef-2ee4b9d0ffaa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "98cb2ee6-d7f2-4641-b7f0-4df2d46874ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"MeasurementValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "509e0ebf-3e27-4f16-9306-05eb2514f04e",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b267f5a8-e3df-4a01-ba86-db1ba10ca400",
"EffectiveDate": "2026-04-06T21:24:00.4361033-07:00",
"StateType": {
"StateTypeId": "d5f5e34f-cec0-4858-b7b3-29ec24a9f326",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2e452995-ff0e-4046-afbe-3aaaf47ba939",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "536409d1-84ae-46eb-8fef-2ee4b9d0ffaa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4645439e-764f-43f1-aafa-363b647a4af3",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dd4ba030-5d0d-4416-b2ca-ad7f786a6e97",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ccaf5c97-08e3-4c13-a965-213febaad221",
"EffectiveDate": "2026-04-06T21:24:00.4361033-07:00",
"StatusType": {
"StatusTypeId": "86c842de-ad3c-4fe5-b1a2-0062b2389ed5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2e452995-ff0e-4046-afbe-3aaaf47ba939",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "536409d1-84ae-46eb-8fef-2ee4b9d0ffaa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ff417347-e51d-4e63-b4d1-5d0f8fb900fa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c87848e5-7ef9-42ff-82c0-6ecee89e4922",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1670ae6f-921a-48d4-bfec-edb09543e5dd",
"EffectiveDate": "2026-04-06T21:24:00.4361033-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "00692400-606b-4123-922f-d16a7d5ba676",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a3e3b4f5-f4c8-447e-83d2-7a198674cbf4",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3a12b29d-4b62-498b-a5a4-52ed9b9e90fb",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"MeasurementValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5c5171fa-651d-4dc4-98f6-1c2fe0ac9a18",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c0c744f7-79d0-4755-ad67-c9dd9903457b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2e452995-ff0e-4046-afbe-3aaaf47ba939",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "536409d1-84ae-46eb-8fef-2ee4b9d0ffaa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"Fields": [
{
"FormTypeFieldId": "b341d548-261c-4bbc-89e4-a07321d7a924",
"Section": {
"FormTypeSectionId": "f8ffe7ca-eb8e-4026-9982-f73ca871c5e6",
"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": "68a2264d-fbeb-40bf-817c-80fbab09cf3e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1fa215a9-102a-4160-b318-44cfe9f00655",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb55f738-9499-4f36-b45e-e19b05be69eb",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"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": "b341d548-261c-4bbc-89e4-a07321d7a924",
"Section": {
"FormTypeSectionId": "f8ffe7ca-eb8e-4026-9982-f73ca871c5e6",
"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": "68a2264d-fbeb-40bf-817c-80fbab09cf3e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1fa215a9-102a-4160-b318-44cfe9f00655",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb55f738-9499-4f36-b45e-e19b05be69eb",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"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": "7a4d9ea6-1e90-45a0-9e37-e378e953c907",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-06T21:24:00.4361033-07:00",
"Location": "sample string 1",
"TaskId": "a0105a7d-6735-4b46-97fe-d0e284166424",
"Values": [
{
"FormFieldValueId": "40d17614-00d3-4609-a577-f242e9c033e9",
"FormId": "31cd3b54-a4c2-4bb7-9f27-9e46ef62a733",
"FormTypeField": {
"FormTypeFieldId": "b341d548-261c-4bbc-89e4-a07321d7a924",
"FormType": {
"FormTypeId": "c0c744f7-79d0-4755-ad67-c9dd9903457b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2e452995-ff0e-4046-afbe-3aaaf47ba939",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "536409d1-84ae-46eb-8fef-2ee4b9d0ffaa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "7a4d9ea6-1e90-45a0-9e37-e378e953c907",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "f8ffe7ca-eb8e-4026-9982-f73ca871c5e6",
"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": "68a2264d-fbeb-40bf-817c-80fbab09cf3e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1fa215a9-102a-4160-b318-44cfe9f00655",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb55f738-9499-4f36-b45e-e19b05be69eb",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"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": "40d17614-00d3-4609-a577-f242e9c033e9",
"FormId": "31cd3b54-a4c2-4bb7-9f27-9e46ef62a733",
"FormTypeField": {
"FormTypeFieldId": "b341d548-261c-4bbc-89e4-a07321d7a924",
"FormType": {
"FormTypeId": "c0c744f7-79d0-4755-ad67-c9dd9903457b",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2e452995-ff0e-4046-afbe-3aaaf47ba939",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "536409d1-84ae-46eb-8fef-2ee4b9d0ffaa",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-06T21:24:00.4361033-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "7a4d9ea6-1e90-45a0-9e37-e378e953c907",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "f8ffe7ca-eb8e-4026-9982-f73ca871c5e6",
"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": "68a2264d-fbeb-40bf-817c-80fbab09cf3e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "1fa215a9-102a-4160-b318-44cfe9f00655",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb55f738-9499-4f36-b45e-e19b05be69eb",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "9d00ddef-2903-42a1-aac5-4b2bc1dcb62e",
"FieldId": "e8e7da5f-0b5a-4bce-ae60-d3dfe735db8e",
"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": "a687f31a-6deb-4b65-8b4d-e5c6cfbf3d1e",
"CreateDate": "2026-04-06T21:24:00.4361033-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-06T21:24:00.4361033-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}