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": "e084dd88-7b94-474e-94e0-36a83fd6978c",
"Asset": {
"AssetId": "fc04f4dc-5a2f-4344-82c0-4281e48d1b2e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a93c6b79-94b1-4789-a751-cee78564ac37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "87943a37-3edf-4864-b883-66bd7b417693",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7c4cbfa3-a4d3-4ee4-9859-bc9b9ec794d2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"MeasurementValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "30a33671-57b3-4b84-90e3-48edd449eed3",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a76041df-9d89-498e-bf76-a34c2b203c70",
"EffectiveDate": "2026-03-02T01:48:16.306251-08:00",
"StateType": {
"StateTypeId": "c42ea6ba-9b98-438f-a6fb-a4667aee6066",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a93c6b79-94b1-4789-a751-cee78564ac37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "87943a37-3edf-4864-b883-66bd7b417693",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8d74919a-755a-457d-b865-2c796afdbde9",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6cd30fa1-d173-40e7-ad28-c60f3c4a24d5",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "c0bdc591-cafb-4ead-bae1-806f0c448e2c",
"EffectiveDate": "2026-03-02T01:48:16.306251-08:00",
"StatusType": {
"StatusTypeId": "3a3d1371-c1bc-4f23-a493-344415313c53",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a93c6b79-94b1-4789-a751-cee78564ac37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "87943a37-3edf-4864-b883-66bd7b417693",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "63e0ec4f-b7f8-4ab4-b9ae-772081367b47",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "39589c3d-0ee4-4e5e-85eb-1a26565b9820",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cb8ed668-afbb-49c9-abc8-f128e2a66e82",
"EffectiveDate": "2026-03-02T01:48:16.306251-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "cc5d938e-2322-4948-8b74-a3079f77f7f4",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5389054b-f14b-4cab-8071-b560d6a89b28",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "76a096f1-48d1-4a2d-abb1-847b08b8ead6",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"MeasurementValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ab2147f2-1b5b-4b0f-adfc-5f717acf47d5",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "37d2966f-87b2-4db7-899c-c5004a7b44ee",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a93c6b79-94b1-4789-a751-cee78564ac37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "87943a37-3edf-4864-b883-66bd7b417693",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"Fields": [
{
"FormTypeFieldId": "8fda88a9-fece-4a54-a667-2697bd1f3b0e",
"Section": {
"FormTypeSectionId": "258160b1-0eec-429f-ab19-3b6c0788148f",
"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": "c3f4c95d-2747-4c57-a7d0-0f0a0dbe57b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8819e8e8-3650-48cc-a052-4ff55547d8dd",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8b26770-c7ff-4b87-bd9d-4dacaf06ea79",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"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": "8fda88a9-fece-4a54-a667-2697bd1f3b0e",
"Section": {
"FormTypeSectionId": "258160b1-0eec-429f-ab19-3b6c0788148f",
"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": "c3f4c95d-2747-4c57-a7d0-0f0a0dbe57b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8819e8e8-3650-48cc-a052-4ff55547d8dd",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8b26770-c7ff-4b87-bd9d-4dacaf06ea79",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"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": "5046a0ee-1895-4266-b1e4-af1ac46c953e",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-02T01:48:16.306251-08:00",
"Location": "sample string 1",
"TaskId": "f4158b90-0569-4b49-bd4d-18fea4a21382",
"Values": [
{
"FormFieldValueId": "94a5c3ca-bfe8-4100-8021-c5f71a1f6b05",
"FormId": "8dfc7bb2-5584-44ff-b9dd-e018962ec0f2",
"FormTypeField": {
"FormTypeFieldId": "8fda88a9-fece-4a54-a667-2697bd1f3b0e",
"FormType": {
"FormTypeId": "37d2966f-87b2-4db7-899c-c5004a7b44ee",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a93c6b79-94b1-4789-a751-cee78564ac37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "87943a37-3edf-4864-b883-66bd7b417693",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "5046a0ee-1895-4266-b1e4-af1ac46c953e",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "258160b1-0eec-429f-ab19-3b6c0788148f",
"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": "c3f4c95d-2747-4c57-a7d0-0f0a0dbe57b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8819e8e8-3650-48cc-a052-4ff55547d8dd",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8b26770-c7ff-4b87-bd9d-4dacaf06ea79",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"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": "94a5c3ca-bfe8-4100-8021-c5f71a1f6b05",
"FormId": "8dfc7bb2-5584-44ff-b9dd-e018962ec0f2",
"FormTypeField": {
"FormTypeFieldId": "8fda88a9-fece-4a54-a667-2697bd1f3b0e",
"FormType": {
"FormTypeId": "37d2966f-87b2-4db7-899c-c5004a7b44ee",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "a93c6b79-94b1-4789-a751-cee78564ac37",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "87943a37-3edf-4864-b883-66bd7b417693",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-02T01:48:16.306251-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "5046a0ee-1895-4266-b1e4-af1ac46c953e",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "258160b1-0eec-429f-ab19-3b6c0788148f",
"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": "c3f4c95d-2747-4c57-a7d0-0f0a0dbe57b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "8819e8e8-3650-48cc-a052-4ff55547d8dd",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8b26770-c7ff-4b87-bd9d-4dacaf06ea79",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "3fed5ffb-0aef-4826-8b4f-732c684cbeb6",
"FieldId": "f7317332-371e-4654-8698-400950c15a38",
"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": "13925062-510c-40d0-832d-f7873e5d97f4",
"CreateDate": "2026-03-02T01:48:16.306251-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-02T01:48:16.306251-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}