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": "af3a925d-4840-4c3e-8ddd-51739d0f3c8f",
"Asset": {
"AssetId": "3bd8373b-e13a-4bb1-b2f2-1bcadad0d433",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "435924f1-7f28-4c00-b6e0-4ab727643859",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c767921-11a7-4d5f-9425-8fa484f24c23",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "cac0a46e-aeca-4fcc-a20c-fac7687c3d2e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"MeasurementValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "77ead755-4cb6-4b42-a997-b7d493a87a98",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d06a594f-6e59-45c7-afdf-3508f434e234",
"EffectiveDate": "2026-05-01T08:08:53.1755843-07:00",
"StateType": {
"StateTypeId": "3112f1d6-2753-4f0c-9d05-fecc310e16bb",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "435924f1-7f28-4c00-b6e0-4ab727643859",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c767921-11a7-4d5f-9425-8fa484f24c23",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "a2f12d90-56fa-4179-b89c-80b8eb5ffd95",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "25d72b50-8755-400d-8469-3b9310b830c6",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "34eecb2a-41bb-4ee9-8f5f-bb62ad8fb157",
"EffectiveDate": "2026-05-01T08:08:53.1755843-07:00",
"StatusType": {
"StatusTypeId": "3822c933-dad9-4010-abb5-573c740c97f0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "435924f1-7f28-4c00-b6e0-4ab727643859",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c767921-11a7-4d5f-9425-8fa484f24c23",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a2fa0245-f6f0-4f1f-bb37-ccb7414d110b",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "12fd8d5b-46d8-4e6b-bce1-5d19826a95ae",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cc6c1ab0-af06-4ce4-b54a-6bdfcbf90ecf",
"EffectiveDate": "2026-05-01T08:08:53.1755843-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "437f9e98-cd24-42ad-b807-05651372249c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a36d0b6e-d4d1-4808-9190-63812b149059",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ea275e7d-be78-42f6-88c8-0ceacc10e5da",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"MeasurementValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "77e38f72-1a26-426e-b9c4-b1157497a8d9",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "ded7d1d4-2a3d-4b77-82c0-fe77f5a5fda2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "435924f1-7f28-4c00-b6e0-4ab727643859",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c767921-11a7-4d5f-9425-8fa484f24c23",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"Fields": [
{
"FormTypeFieldId": "ad180dd0-dc97-482d-8e28-d79dfc1ac21a",
"Section": {
"FormTypeSectionId": "fe596fe5-f0ea-4baa-b7f5-086620e578d0",
"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": "aa007170-3719-4e0f-adca-87cac29d4528",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4274054d-59bd-4f3e-9b6c-2c084a4d1432",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d69c9de-e7a6-42c1-b04d-3a64bf9febd3",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"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": "ad180dd0-dc97-482d-8e28-d79dfc1ac21a",
"Section": {
"FormTypeSectionId": "fe596fe5-f0ea-4baa-b7f5-086620e578d0",
"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": "aa007170-3719-4e0f-adca-87cac29d4528",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4274054d-59bd-4f3e-9b6c-2c084a4d1432",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d69c9de-e7a6-42c1-b04d-3a64bf9febd3",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"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": "b9f73c94-1429-4d7b-8129-9432dbdeead6",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-05-01T08:08:53.1755843-07:00",
"Location": "sample string 1",
"TaskId": "80981194-1dea-4631-934c-da5d2845009e",
"Values": [
{
"FormFieldValueId": "67a3b24c-30c1-4d74-83fe-d15840cdcbe6",
"FormId": "11091bce-750b-4efa-b392-df8e42333335",
"FormTypeField": {
"FormTypeFieldId": "ad180dd0-dc97-482d-8e28-d79dfc1ac21a",
"FormType": {
"FormTypeId": "ded7d1d4-2a3d-4b77-82c0-fe77f5a5fda2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "435924f1-7f28-4c00-b6e0-4ab727643859",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c767921-11a7-4d5f-9425-8fa484f24c23",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "b9f73c94-1429-4d7b-8129-9432dbdeead6",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "fe596fe5-f0ea-4baa-b7f5-086620e578d0",
"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": "aa007170-3719-4e0f-adca-87cac29d4528",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4274054d-59bd-4f3e-9b6c-2c084a4d1432",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d69c9de-e7a6-42c1-b04d-3a64bf9febd3",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"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": "67a3b24c-30c1-4d74-83fe-d15840cdcbe6",
"FormId": "11091bce-750b-4efa-b392-df8e42333335",
"FormTypeField": {
"FormTypeFieldId": "ad180dd0-dc97-482d-8e28-d79dfc1ac21a",
"FormType": {
"FormTypeId": "ded7d1d4-2a3d-4b77-82c0-fe77f5a5fda2",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "435924f1-7f28-4c00-b6e0-4ab727643859",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c767921-11a7-4d5f-9425-8fa484f24c23",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-05-01T08:08:53.1755843-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "b9f73c94-1429-4d7b-8129-9432dbdeead6",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "fe596fe5-f0ea-4baa-b7f5-086620e578d0",
"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": "aa007170-3719-4e0f-adca-87cac29d4528",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4274054d-59bd-4f3e-9b6c-2c084a4d1432",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0d69c9de-e7a6-42c1-b04d-3a64bf9febd3",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "f71d9173-de7b-4d0b-914e-f99effc7ebfd",
"FieldId": "3ae7dcf4-a805-47fd-8f02-5cabae120eb0",
"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": "3efd7fcb-0922-43d8-8f08-9c834fc5ae1e",
"CreateDate": "2026-05-01T08:08:53.1755843-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-01T08:08:53.1755843-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}