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": "ba65ef33-f3a2-480a-971f-9ca6a67581fc",
"Asset": {
"AssetId": "fe88d9ce-b593-47c3-bf7a-8bb2f5d9ebf7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f67ef8d1-6bea-4d1f-a3ff-47208d2d420f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "39d5f7e0-25a9-4cd9-a22c-0187fabe100e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "dc5fc4bb-8221-4946-aa7c-b3e00e8caeb1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"MeasurementValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1a18a640-ef1f-4cbd-bee1-c8a25b7cd73e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f0938e28-090e-4fcf-b791-07be10068628",
"EffectiveDate": "2026-04-30T22:55:53.3907988-07:00",
"StateType": {
"StateTypeId": "3d1244eb-be05-4fe8-8392-068918debe3d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f67ef8d1-6bea-4d1f-a3ff-47208d2d420f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "39d5f7e0-25a9-4cd9-a22c-0187fabe100e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6f1e1b89-613f-4305-832f-15d358fbdf86",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f03713f6-bb02-415a-8040-80722b6f4bfd",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9cca09a4-ef0a-48d5-a59e-b953a67e8ce3",
"EffectiveDate": "2026-04-30T22:55:53.3907988-07:00",
"StatusType": {
"StatusTypeId": "d9659fa9-b16d-4bd3-a15e-d40b72df3866",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f67ef8d1-6bea-4d1f-a3ff-47208d2d420f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "39d5f7e0-25a9-4cd9-a22c-0187fabe100e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "89822409-afa7-435d-b8c5-1980d817f1d0",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2c2964a2-44c1-4873-ac0c-504d12f8c346",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b795fb0a-8c9f-4241-b27f-25ef722fb58c",
"EffectiveDate": "2026-04-30T22:55:53.3907988-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d11960a9-da31-4b2e-972c-36a9eecdc09e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "556c8b89-0202-476a-9995-e6cbaec5eec0",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "af0131b1-0fe0-4baf-ba8d-d7ac868b3b6e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"MeasurementValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "861576fa-de5b-410e-b454-cb6f392c6250",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "bc3f776c-01d2-43bc-b870-145571836321",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f67ef8d1-6bea-4d1f-a3ff-47208d2d420f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "39d5f7e0-25a9-4cd9-a22c-0187fabe100e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"Fields": [
{
"FormTypeFieldId": "58645cb9-afe0-4c96-810f-5a90856cbed3",
"Section": {
"FormTypeSectionId": "51e2e214-c32f-42b4-a2e2-9d7a9e9cacff",
"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": "ac5227bc-eda4-4ac3-b85e-cbd3bde5e3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cb1f9553-aa9e-44af-a94e-2f718221060c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fbd81d14-59ab-4704-8b9b-e728daf32881",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"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": "58645cb9-afe0-4c96-810f-5a90856cbed3",
"Section": {
"FormTypeSectionId": "51e2e214-c32f-42b4-a2e2-9d7a9e9cacff",
"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": "ac5227bc-eda4-4ac3-b85e-cbd3bde5e3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cb1f9553-aa9e-44af-a94e-2f718221060c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fbd81d14-59ab-4704-8b9b-e728daf32881",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"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": "fe4e7b06-128a-49c2-a072-e828e6923f8e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-04-30T22:55:53.3907988-07:00",
"Location": "sample string 1",
"TaskId": "cb328686-c318-4f8d-abe6-309febf4dfa1",
"Values": [
{
"FormFieldValueId": "499f64f7-2ddb-41e8-b05b-92e7be7a929b",
"FormId": "cbae9057-d79b-4f36-baf3-017265999431",
"FormTypeField": {
"FormTypeFieldId": "58645cb9-afe0-4c96-810f-5a90856cbed3",
"FormType": {
"FormTypeId": "bc3f776c-01d2-43bc-b870-145571836321",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f67ef8d1-6bea-4d1f-a3ff-47208d2d420f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "39d5f7e0-25a9-4cd9-a22c-0187fabe100e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "fe4e7b06-128a-49c2-a072-e828e6923f8e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "51e2e214-c32f-42b4-a2e2-9d7a9e9cacff",
"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": "ac5227bc-eda4-4ac3-b85e-cbd3bde5e3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cb1f9553-aa9e-44af-a94e-2f718221060c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fbd81d14-59ab-4704-8b9b-e728daf32881",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"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": "499f64f7-2ddb-41e8-b05b-92e7be7a929b",
"FormId": "cbae9057-d79b-4f36-baf3-017265999431",
"FormTypeField": {
"FormTypeFieldId": "58645cb9-afe0-4c96-810f-5a90856cbed3",
"FormType": {
"FormTypeId": "bc3f776c-01d2-43bc-b870-145571836321",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "f67ef8d1-6bea-4d1f-a3ff-47208d2d420f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "39d5f7e0-25a9-4cd9-a22c-0187fabe100e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-30T22:55:53.3907988-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "fe4e7b06-128a-49c2-a072-e828e6923f8e",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "51e2e214-c32f-42b4-a2e2-9d7a9e9cacff",
"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": "ac5227bc-eda4-4ac3-b85e-cbd3bde5e3ac",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "cb1f9553-aa9e-44af-a94e-2f718221060c",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fbd81d14-59ab-4704-8b9b-e728daf32881",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "ad32770a-5d8a-4d65-8ab3-acb6c37fa078",
"FieldId": "21ff1ff0-0c8a-43a1-aeb3-d6c599abb492",
"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": "b492ee55-7ff1-4ed6-82bc-cd15cea118d4",
"CreateDate": "2026-04-30T22:55:53.3907988-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-30T22:55:53.3907988-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}