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": "ec55d0f4-9093-468c-bb68-c09d9da39ee0",
"Asset": {
"AssetId": "1b5097ca-de07-4067-af1b-0ce90655136b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "29cc4616-8916-48ab-8947-fe34447b3b91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d604c9c-b6c2-426b-8982-e742bc49e117",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "45814622-0cd6-4468-9ac6-6cbd9f752648",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-12T13:58:27.7310004-08:00",
"MeasurementValueNeededDate": "2026-01-12T13:58:27.7310004-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "56c43965-498e-4086-bdda-45b203545b4a",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d26df66f-74e6-4c65-914f-14447eddbb2d",
"EffectiveDate": "2026-01-12T13:58:27.7466251-08:00",
"StateType": {
"StateTypeId": "4bfb0d2d-ce81-45d7-bce3-3ee0eaee11ad",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "29cc4616-8916-48ab-8947-fe34447b3b91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d604c9c-b6c2-426b-8982-e742bc49e117",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8b586c53-e927-418f-b706-ab8b81cbdb5c",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f96bd891-06aa-4de7-a0a9-8af35be848d5",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4cc997fd-67d7-4781-a95b-bb58be00b3be",
"EffectiveDate": "2026-01-12T13:58:27.7466251-08:00",
"StatusType": {
"StatusTypeId": "6c6fdac5-da5c-498c-ab77-62cc2153cfe2",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "29cc4616-8916-48ab-8947-fe34447b3b91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d604c9c-b6c2-426b-8982-e742bc49e117",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cac65877-e5fb-4161-8154-44ed6d4ee769",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "86f84a25-8012-4282-825d-b6d2165aa090",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1bc0c55b-9b36-4f13-93f3-c3ab23a3e6a0",
"EffectiveDate": "2026-01-12T13:58:27.7466251-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "a54e29f4-7942-49e1-836c-17670e81e6d5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "84b27f21-ac8d-4c45-baf6-9e2d6b18b08c",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "53267fd1-1d7c-4612-b84c-7125264508bf",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-12T13:58:27.7466251-08:00",
"MeasurementValueNeededDate": "2026-01-12T13:58:27.7466251-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b339291b-703b-4201-9995-dc0c2dfeeffa",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "12c71e92-7bce-4687-a790-d386c4db9155",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29cc4616-8916-48ab-8947-fe34447b3b91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d604c9c-b6c2-426b-8982-e742bc49e117",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-12T13:58:27.7466251-08:00",
"Fields": [
{
"FormTypeFieldId": "5a0ed06b-e899-4b04-9461-408e90b01e52",
"Section": {
"FormTypeSectionId": "a4bd48cc-bbfb-4ae6-81d3-558b175ad6a7",
"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": "6e07a294-be3f-4932-beda-d966e7cf9786",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9c733b2a-244e-4f25-9b40-3ef479c93267",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0f6078bc-e312-4eff-8bab-a36e2884a916",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"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": "5a0ed06b-e899-4b04-9461-408e90b01e52",
"Section": {
"FormTypeSectionId": "a4bd48cc-bbfb-4ae6-81d3-558b175ad6a7",
"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": "6e07a294-be3f-4932-beda-d966e7cf9786",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9c733b2a-244e-4f25-9b40-3ef479c93267",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0f6078bc-e312-4eff-8bab-a36e2884a916",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"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": "e1184537-0776-4c33-8481-b286ab20a722",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-01-12T13:58:27.7466251-08:00",
"Location": "sample string 1",
"TaskId": "ce337122-f0a2-4646-b730-3f4f9fbbcea4",
"Values": [
{
"FormFieldValueId": "690c0289-b83b-4c31-b551-0572d6c345b5",
"FormId": "ff54acc2-8482-46da-951a-ea94ace010a6",
"FormTypeField": {
"FormTypeFieldId": "5a0ed06b-e899-4b04-9461-408e90b01e52",
"FormType": {
"FormTypeId": "12c71e92-7bce-4687-a790-d386c4db9155",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29cc4616-8916-48ab-8947-fe34447b3b91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d604c9c-b6c2-426b-8982-e742bc49e117",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-12T13:58:27.7466251-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e1184537-0776-4c33-8481-b286ab20a722",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a4bd48cc-bbfb-4ae6-81d3-558b175ad6a7",
"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": "6e07a294-be3f-4932-beda-d966e7cf9786",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9c733b2a-244e-4f25-9b40-3ef479c93267",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0f6078bc-e312-4eff-8bab-a36e2884a916",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"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": "690c0289-b83b-4c31-b551-0572d6c345b5",
"FormId": "ff54acc2-8482-46da-951a-ea94ace010a6",
"FormTypeField": {
"FormTypeFieldId": "5a0ed06b-e899-4b04-9461-408e90b01e52",
"FormType": {
"FormTypeId": "12c71e92-7bce-4687-a790-d386c4db9155",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29cc4616-8916-48ab-8947-fe34447b3b91",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5d604c9c-b6c2-426b-8982-e742bc49e117",
"CreateDate": "2026-01-12T13:58:27.7310004-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-12T13:58:27.7310004-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-01-12T13:58:27.7466251-08:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e1184537-0776-4c33-8481-b286ab20a722",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "a4bd48cc-bbfb-4ae6-81d3-558b175ad6a7",
"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": "6e07a294-be3f-4932-beda-d966e7cf9786",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9c733b2a-244e-4f25-9b40-3ef479c93267",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0f6078bc-e312-4eff-8bab-a36e2884a916",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "b8e4b1b1-a161-49f9-b3ba-4135a444a666",
"FieldId": "9a1050e6-c692-45d8-a8c1-f81738a64cc9",
"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": "01eeaf89-a5c3-482d-af10-864b92852993",
"CreateDate": "2026-01-12T13:58:27.7466251-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-12T13:58:27.7466251-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}