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": "385f884b-5678-48b9-a686-a39179c46411",
"Asset": {
"AssetId": "3b895910-86e3-4b42-b220-17d328bc387e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3294b585-c763-4fda-8a69-98d30d9b9b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31c78b7b-0f63-4e21-ba32-796bb296f406",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "65354966-448d-451d-9ba4-82c55639cbdc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"MeasurementValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e344d8c1-83e7-43d6-ba86-134891b6bb2a",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dbff2181-81b6-45e7-838a-57100a027819",
"EffectiveDate": "2026-06-13T07:52:40.8791387-07:00",
"StateType": {
"StateTypeId": "8d460162-5083-4ae8-b20d-54697b4bd09f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3294b585-c763-4fda-8a69-98d30d9b9b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31c78b7b-0f63-4e21-ba32-796bb296f406",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "1dd5be18-ff03-4057-bafe-c899a88b97c9",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4c049409-d5f3-44a0-bfa6-c68c27a6ae5e",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b97fe08d-ad46-4070-8643-a78ba2441220",
"EffectiveDate": "2026-06-13T07:52:40.8791387-07:00",
"StatusType": {
"StatusTypeId": "3a4c072a-0082-4d55-99ad-298c98d8da10",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3294b585-c763-4fda-8a69-98d30d9b9b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31c78b7b-0f63-4e21-ba32-796bb296f406",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fcdab080-0c3e-4ebf-a45c-c6987ede5b03",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b7d37986-501d-4a56-9869-51e9a2175a38",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "de87c486-7845-47d8-ba33-70f02d1c0a0d",
"EffectiveDate": "2026-06-13T07:52:40.8791387-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e6fdb9ba-0c5e-457f-9ef0-250c49eae0d7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b77b9476-918e-4de1-844c-989d12629292",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "be5659ea-2271-4845-b162-3e90b4e187ed",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"MeasurementValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "464c3703-383f-40b4-9dc0-0455fc3f1f51",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "3a111c1b-9af0-40a8-9c9d-5fa6a8c00421",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3294b585-c763-4fda-8a69-98d30d9b9b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31c78b7b-0f63-4e21-ba32-796bb296f406",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"Fields": [
{
"FormTypeFieldId": "d3408bfb-4714-47c1-beb2-1498e8f2ce39",
"Section": {
"FormTypeSectionId": "ccbce7ef-0310-40de-9944-941b7f23bff6",
"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": "90a31904-d8dd-439c-96ed-0ebbee528abd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ddb67a38-7c4a-4e72-963a-e3344e33abde",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "668f51bb-aa5b-4140-b7cb-6c3327a7475f",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"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": "d3408bfb-4714-47c1-beb2-1498e8f2ce39",
"Section": {
"FormTypeSectionId": "ccbce7ef-0310-40de-9944-941b7f23bff6",
"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": "90a31904-d8dd-439c-96ed-0ebbee528abd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ddb67a38-7c4a-4e72-963a-e3344e33abde",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "668f51bb-aa5b-4140-b7cb-6c3327a7475f",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"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": "d5b1f182-b55e-4f34-a893-205c9c5fad60",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-06-13T07:52:40.8791387-07:00",
"Location": "sample string 1",
"TaskId": "e94bcc61-dcba-4ed1-94d2-c55821a8c240",
"Values": [
{
"FormFieldValueId": "423924a3-5462-42ea-a4e0-ec087c5b94b8",
"FormId": "1c0535e8-7960-4f5d-baa5-f8dc123ca784",
"FormTypeField": {
"FormTypeFieldId": "d3408bfb-4714-47c1-beb2-1498e8f2ce39",
"FormType": {
"FormTypeId": "3a111c1b-9af0-40a8-9c9d-5fa6a8c00421",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3294b585-c763-4fda-8a69-98d30d9b9b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31c78b7b-0f63-4e21-ba32-796bb296f406",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d5b1f182-b55e-4f34-a893-205c9c5fad60",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "ccbce7ef-0310-40de-9944-941b7f23bff6",
"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": "90a31904-d8dd-439c-96ed-0ebbee528abd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ddb67a38-7c4a-4e72-963a-e3344e33abde",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "668f51bb-aa5b-4140-b7cb-6c3327a7475f",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"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": "423924a3-5462-42ea-a4e0-ec087c5b94b8",
"FormId": "1c0535e8-7960-4f5d-baa5-f8dc123ca784",
"FormTypeField": {
"FormTypeFieldId": "d3408bfb-4714-47c1-beb2-1498e8f2ce39",
"FormType": {
"FormTypeId": "3a111c1b-9af0-40a8-9c9d-5fa6a8c00421",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3294b585-c763-4fda-8a69-98d30d9b9b8f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "31c78b7b-0f63-4e21-ba32-796bb296f406",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-06-13T07:52:40.8791387-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "d5b1f182-b55e-4f34-a893-205c9c5fad60",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "ccbce7ef-0310-40de-9944-941b7f23bff6",
"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": "90a31904-d8dd-439c-96ed-0ebbee528abd",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ddb67a38-7c4a-4e72-963a-e3344e33abde",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "668f51bb-aa5b-4140-b7cb-6c3327a7475f",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e8b5f6f3-b408-4898-8424-fa199d1d4b1c",
"FieldId": "55a2c91c-5b0c-4823-a0b3-f16f06d41e03",
"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": "f8d3bdfd-2260-4678-8d91-aa5128d0096c",
"CreateDate": "2026-06-13T07:52:40.8791387-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-13T07:52:40.8791387-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}