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": "c19c8076-973a-4f45-9c0e-5ca48e916766",
"Asset": {
"AssetId": "cac670d8-9df9-490f-aef0-9d10463ba29d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2a0ea4de-fb23-4573-8fdc-71ef4545fbfb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b50594f3-6ade-4859-b13a-acda4a71e32c",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "63a3aa57-e1af-473a-bc48-14d9565145b6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"MeasurementValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fd6bc8d8-8260-4478-822c-b7ad979f9e75",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cae01019-058a-408c-b377-400df1f631a5",
"EffectiveDate": "2026-04-28T21:52:46.8573968-07:00",
"StateType": {
"StateTypeId": "0a3dfe58-da9e-4e76-b5b0-b899f41011de",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2a0ea4de-fb23-4573-8fdc-71ef4545fbfb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b50594f3-6ade-4859-b13a-acda4a71e32c",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c3075eb3-0d23-40f2-b1bc-25a0af6bfe91",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "76b61e86-77e6-46fa-8d0d-be331cd5c8d2",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b7ed304a-3972-4beb-bf76-ee4b119c54ff",
"EffectiveDate": "2026-04-28T21:52:46.8573968-07:00",
"StatusType": {
"StatusTypeId": "7d410bbc-55dd-4a50-83a2-999de72ac532",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2a0ea4de-fb23-4573-8fdc-71ef4545fbfb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b50594f3-6ade-4859-b13a-acda4a71e32c",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1028c177-2a89-465d-873c-1a197dabd582",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "77e0cc58-2397-4ce3-b1a3-d6b8753bc9b3",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f33a3213-0a28-4932-bc93-84dbe49cc6bf",
"EffectiveDate": "2026-04-28T21:52:46.8573968-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "59ef7597-5afe-4b77-9897-03e55321eefe",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0cf445bd-a8c8-4064-a513-648752b406c8",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "31069d59-a211-47f2-8c18-30d5811f0ab0",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"MeasurementValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "49dbceef-1823-45b1-a25a-95f1002a9b92",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c6dfff60-53c6-4f70-9c29-2e6b91ad128c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2a0ea4de-fb23-4573-8fdc-71ef4545fbfb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b50594f3-6ade-4859-b13a-acda4a71e32c",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"Fields": [
{
"FormTypeFieldId": "6a11cd41-0a13-4cee-875e-54977c0d6d21",
"Section": {
"FormTypeSectionId": "74d98cba-b908-4e81-8d9d-cea8edf519d0",
"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": "8521b03b-2e4a-47f4-b386-e143120f1f59",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5b605721-28b9-41e2-8d4b-b09d8d0302ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02d0fb4c-f613-4573-b2e0-c55388c9c013",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"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": "6a11cd41-0a13-4cee-875e-54977c0d6d21",
"Section": {
"FormTypeSectionId": "74d98cba-b908-4e81-8d9d-cea8edf519d0",
"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": "8521b03b-2e4a-47f4-b386-e143120f1f59",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5b605721-28b9-41e2-8d4b-b09d8d0302ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02d0fb4c-f613-4573-b2e0-c55388c9c013",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"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": "0a0684b7-ad3d-44cb-b074-61bc2c9061bd",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-28T21:52:46.8573968-07:00",
"Location": "sample string 1",
"TaskId": "82c1ed36-dacf-4af9-a846-877310d676fc",
"Values": [
{
"FormFieldValueId": "4a63146d-31b6-4f68-86c6-562e4887d639",
"FormId": "ae827155-0915-47cd-ba79-6a067792fe11",
"FormTypeField": {
"FormTypeFieldId": "6a11cd41-0a13-4cee-875e-54977c0d6d21",
"FormType": {
"FormTypeId": "c6dfff60-53c6-4f70-9c29-2e6b91ad128c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2a0ea4de-fb23-4573-8fdc-71ef4545fbfb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b50594f3-6ade-4859-b13a-acda4a71e32c",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "0a0684b7-ad3d-44cb-b074-61bc2c9061bd",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "74d98cba-b908-4e81-8d9d-cea8edf519d0",
"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": "8521b03b-2e4a-47f4-b386-e143120f1f59",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5b605721-28b9-41e2-8d4b-b09d8d0302ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02d0fb4c-f613-4573-b2e0-c55388c9c013",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"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": "4a63146d-31b6-4f68-86c6-562e4887d639",
"FormId": "ae827155-0915-47cd-ba79-6a067792fe11",
"FormTypeField": {
"FormTypeFieldId": "6a11cd41-0a13-4cee-875e-54977c0d6d21",
"FormType": {
"FormTypeId": "c6dfff60-53c6-4f70-9c29-2e6b91ad128c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2a0ea4de-fb23-4573-8fdc-71ef4545fbfb",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b50594f3-6ade-4859-b13a-acda4a71e32c",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-28T21:52:46.8573968-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "0a0684b7-ad3d-44cb-b074-61bc2c9061bd",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "74d98cba-b908-4e81-8d9d-cea8edf519d0",
"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": "8521b03b-2e4a-47f4-b386-e143120f1f59",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5b605721-28b9-41e2-8d4b-b09d8d0302ec",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "02d0fb4c-f613-4573-b2e0-c55388c9c013",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "0a712bf1-ea39-41f8-9506-fb2189e4283a",
"FieldId": "1372a6d4-ffa6-4385-a9cb-5fc711f8f9c6",
"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": "5a39721e-cdb8-4fd9-ae5d-826190bc735a",
"CreateDate": "2026-04-28T21:52:46.8573968-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-28T21:52:46.8573968-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}