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": "ea165cbd-f2e5-4591-acf4-1de169a23e62",
"Asset": {
"AssetId": "d389d263-aca0-4efc-a737-417e1f8dd5bc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cdbb7982-cd25-41a2-a6b1-2822bdcb77c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b387d501-3e79-4d72-bcb9-ac16116bb84e",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5b0a5d35-451f-4a33-b6f9-81033238d608",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"MeasurementValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b4cce32a-9569-458c-b027-a210b84eda3b",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "58a425bb-c6a8-44c0-b4d1-1fce425f1a26",
"EffectiveDate": "2026-09-19T18:36:17.664419-07:00",
"StateType": {
"StateTypeId": "b49dccb1-8608-411f-983c-9bb6a73be2f8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "cdbb7982-cd25-41a2-a6b1-2822bdcb77c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b387d501-3e79-4d72-bcb9-ac16116bb84e",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "77004b4a-7bec-43b3-b329-a6606da2863c",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "735328d9-0d42-4ed5-8a63-95ead6fdca9a",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "59975768-4ff0-431e-80f8-f5059dc48557",
"EffectiveDate": "2026-09-19T18:36:17.664419-07:00",
"StatusType": {
"StatusTypeId": "79222687-3db9-43df-984f-d8a0061ce0fb",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "cdbb7982-cd25-41a2-a6b1-2822bdcb77c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b387d501-3e79-4d72-bcb9-ac16116bb84e",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a9573222-ba52-4e16-a003-b8f22b5d702a",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8e71302c-790f-4a69-b226-29d4c1d57395",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "7c37c837-acbe-429c-b2ed-24f3f49da186",
"EffectiveDate": "2026-09-19T18:36:17.664419-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "e8b90fdb-1cff-418c-9436-01cf548840a6",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "48341e35-4a75-4f66-b703-4d2cd01db159",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "20f498a5-72a0-4f2b-a742-6552e83f7464",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"MeasurementValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b6b1852b-a034-423e-bda0-dbfb3c4bd975",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "aa901eb2-a028-43b0-b6f5-4a430512d21c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cdbb7982-cd25-41a2-a6b1-2822bdcb77c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b387d501-3e79-4d72-bcb9-ac16116bb84e",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"Fields": [
{
"FormTypeFieldId": "8807b6ca-34c0-49ef-b10c-9c0fdef8c85f",
"Section": {
"FormTypeSectionId": "1cfad743-8ebf-41cc-a44c-bb31bda6e142",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f08ea80f-221e-4a94-b6f3-b9c3bcef29f3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d46e983f-b3ae-43dc-9d07-b64baba26527",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4ec5d38-2aaf-4c7e-9fb8-3ad2a9b05ccf",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "8807b6ca-34c0-49ef-b10c-9c0fdef8c85f",
"Section": {
"FormTypeSectionId": "1cfad743-8ebf-41cc-a44c-bb31bda6e142",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f08ea80f-221e-4a94-b6f3-b9c3bcef29f3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d46e983f-b3ae-43dc-9d07-b64baba26527",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4ec5d38-2aaf-4c7e-9fb8-3ad2a9b05ccf",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "47409e84-0a6c-4103-9957-3ca234922ce3",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-09-19T18:36:17.664419-07:00",
"Location": "sample string 1",
"TaskId": "d11c2294-c55a-45f1-91b9-f6bef9aa4281",
"Values": [
{
"FormFieldValueId": "f82a6a50-c953-46ca-88a1-8dcedd2276c2",
"FormId": "f23e25e7-94cf-41f7-8387-f5f9d4aa678e",
"FormTypeField": {
"FormTypeFieldId": "8807b6ca-34c0-49ef-b10c-9c0fdef8c85f",
"FormType": {
"FormTypeId": "aa901eb2-a028-43b0-b6f5-4a430512d21c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cdbb7982-cd25-41a2-a6b1-2822bdcb77c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b387d501-3e79-4d72-bcb9-ac16116bb84e",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "47409e84-0a6c-4103-9957-3ca234922ce3",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "1cfad743-8ebf-41cc-a44c-bb31bda6e142",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f08ea80f-221e-4a94-b6f3-b9c3bcef29f3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d46e983f-b3ae-43dc-9d07-b64baba26527",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4ec5d38-2aaf-4c7e-9fb8-3ad2a9b05ccf",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
"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": "f82a6a50-c953-46ca-88a1-8dcedd2276c2",
"FormId": "f23e25e7-94cf-41f7-8387-f5f9d4aa678e",
"FormTypeField": {
"FormTypeFieldId": "8807b6ca-34c0-49ef-b10c-9c0fdef8c85f",
"FormType": {
"FormTypeId": "aa901eb2-a028-43b0-b6f5-4a430512d21c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cdbb7982-cd25-41a2-a6b1-2822bdcb77c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b387d501-3e79-4d72-bcb9-ac16116bb84e",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-19T18:36:17.664419-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "47409e84-0a6c-4103-9957-3ca234922ce3",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "1cfad743-8ebf-41cc-a44c-bb31bda6e142",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f08ea80f-221e-4a94-b6f3-b9c3bcef29f3",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d46e983f-b3ae-43dc-9d07-b64baba26527",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4ec5d38-2aaf-4c7e-9fb8-3ad2a9b05ccf",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "c959f4bf-a001-4aae-9554-66575dac8439",
"FieldId": "b739cac4-a3c0-4976-896d-2b3e75b2ef14",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
"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": "791d107c-2778-4a61-a5d0-4906543b5a4a",
"CreateDate": "2026-09-19T18:36:17.664419-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-19T18:36:17.664419-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}