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": "510eba10-c82a-4c33-b046-87228860e465",
"Asset": {
"AssetId": "fecc5353-e0de-478b-89bd-62ddf2b3744d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "466adfeb-5093-40dd-b709-134e165cd632",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1afa9502-a507-4d6e-9dea-4f568fa43c68",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7621368a-38ba-4d10-92cb-5a53f55f3184",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"MeasurementValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3def0269-418b-4054-9f54-2a12c9eb9837",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f99dfd63-1f73-4683-8f1c-dde5e82ad783",
"EffectiveDate": "2026-07-11T08:18:16.3905906-07:00",
"StateType": {
"StateTypeId": "78a5b272-927f-4aa2-9ea0-837b34f5b269",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "466adfeb-5093-40dd-b709-134e165cd632",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1afa9502-a507-4d6e-9dea-4f568fa43c68",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6080cc71-c23c-4f8d-81b9-cff8ced9d4a4",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "016fdd05-bca5-4aa1-9fa4-e11bb5fa00ce",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "30e384a3-fc27-42f3-bdc4-9dd670eef1de",
"EffectiveDate": "2026-07-11T08:18:16.3905906-07:00",
"StatusType": {
"StatusTypeId": "b9fa9b68-7f44-455a-b508-ef21b2abb16d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "466adfeb-5093-40dd-b709-134e165cd632",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1afa9502-a507-4d6e-9dea-4f568fa43c68",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "416228e5-3d76-452d-bf01-af58f2adfb2b",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0bf30c51-922d-443d-a3c9-910f9477bcef",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8249909a-3ee9-4fb9-bb5e-666f30e182f6",
"EffectiveDate": "2026-07-11T08:18:16.3905906-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "cf391154-134b-467e-9bf5-b4291f555d38",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "905b1f35-d600-4f83-9a2b-9ba65d46aa9c",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6d70a0e1-b07b-4488-8ee3-ad6e50a21e73",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"MeasurementValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5016b452-9a9d-449c-8296-861e0d9ae150",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "dfa4a1b4-c98f-4f9b-92c0-575345b94d7d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "466adfeb-5093-40dd-b709-134e165cd632",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1afa9502-a507-4d6e-9dea-4f568fa43c68",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"Fields": [
{
"FormTypeFieldId": "74237c82-2035-4a15-9231-9be07a816a83",
"Section": {
"FormTypeSectionId": "25a2a27d-037e-4f94-b87a-d06f05442b61",
"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": "a68d9cfd-9c60-47b8-82fe-83066e831bff",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dc0a4288-0740-4ffc-bead-46f6bbdd181b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4f5fb209-7f4d-4fc6-b580-44423bfe1aae",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"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": "74237c82-2035-4a15-9231-9be07a816a83",
"Section": {
"FormTypeSectionId": "25a2a27d-037e-4f94-b87a-d06f05442b61",
"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": "a68d9cfd-9c60-47b8-82fe-83066e831bff",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dc0a4288-0740-4ffc-bead-46f6bbdd181b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4f5fb209-7f4d-4fc6-b580-44423bfe1aae",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"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": "2273117b-94b9-48f8-9dd2-69c6bcb28cbe",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-07-11T08:18:16.3905906-07:00",
"Location": "sample string 1",
"TaskId": "d401d65f-bb94-4b9a-b0d9-31bb062a8c6d",
"Values": [
{
"FormFieldValueId": "d211268b-4e55-4558-86af-6d3542fb2f18",
"FormId": "68bff89e-ee78-495f-8edc-3d17b3b7731d",
"FormTypeField": {
"FormTypeFieldId": "74237c82-2035-4a15-9231-9be07a816a83",
"FormType": {
"FormTypeId": "dfa4a1b4-c98f-4f9b-92c0-575345b94d7d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "466adfeb-5093-40dd-b709-134e165cd632",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1afa9502-a507-4d6e-9dea-4f568fa43c68",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "2273117b-94b9-48f8-9dd2-69c6bcb28cbe",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "25a2a27d-037e-4f94-b87a-d06f05442b61",
"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": "a68d9cfd-9c60-47b8-82fe-83066e831bff",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dc0a4288-0740-4ffc-bead-46f6bbdd181b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4f5fb209-7f4d-4fc6-b580-44423bfe1aae",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"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": "d211268b-4e55-4558-86af-6d3542fb2f18",
"FormId": "68bff89e-ee78-495f-8edc-3d17b3b7731d",
"FormTypeField": {
"FormTypeFieldId": "74237c82-2035-4a15-9231-9be07a816a83",
"FormType": {
"FormTypeId": "dfa4a1b4-c98f-4f9b-92c0-575345b94d7d",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "466adfeb-5093-40dd-b709-134e165cd632",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1afa9502-a507-4d6e-9dea-4f568fa43c68",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-07-11T08:18:16.3905906-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "2273117b-94b9-48f8-9dd2-69c6bcb28cbe",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "25a2a27d-037e-4f94-b87a-d06f05442b61",
"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": "a68d9cfd-9c60-47b8-82fe-83066e831bff",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "dc0a4288-0740-4ffc-bead-46f6bbdd181b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4f5fb209-7f4d-4fc6-b580-44423bfe1aae",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "cf45fb2f-dca2-4dbc-92e0-578adddc3646",
"FieldId": "0895abe4-ec0e-411c-8a10-e8330a814b93",
"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": "d9b3399b-d314-4689-8476-d56a2c323e0f",
"CreateDate": "2026-07-11T08:18:16.3905906-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-07-11T08:18:16.3905906-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}