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": "76f52a67-3b6f-4759-9baa-e3db3be3896f",
"Asset": {
"AssetId": "130853cf-b353-4a53-b190-f2ebea9c6a2d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "e8339463-31e7-4a6d-b790-638c991183d7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3473dd38-3598-47b1-8654-724b91880b39",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "58b30818-7400-420c-a956-7c982b9ceb74",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"MeasurementValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a07b5ced-3ff1-4881-be05-9ac335d1a65e",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b9b7f9f9-1ce3-4509-ab00-43cca4dba84b",
"EffectiveDate": "2026-03-18T04:14:49.8860363-07:00",
"StateType": {
"StateTypeId": "aeac0466-c30b-429c-932a-9af3fdbc4d70",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "e8339463-31e7-4a6d-b790-638c991183d7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3473dd38-3598-47b1-8654-724b91880b39",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "53c0fa4e-dd60-43da-ae07-04c1c928735e",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "40b716e8-ad53-4002-b9aa-80cd9a127138",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "68f4f8a4-d9bc-4fd1-8e05-5d87aa5ea57d",
"EffectiveDate": "2026-03-18T04:14:49.8860363-07:00",
"StatusType": {
"StatusTypeId": "1b011035-e7b6-48e9-9797-80530935b13e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "e8339463-31e7-4a6d-b790-638c991183d7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3473dd38-3598-47b1-8654-724b91880b39",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d00e97c7-fb1a-4aaa-b1e9-38878b1999d1",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9da2715d-4074-4251-9596-dc7628764416",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "733b0f27-f1ec-450e-91a5-1f1a320ee768",
"EffectiveDate": "2026-03-18T04:14:49.8860363-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f55a7a31-f0e4-42f7-94de-61f11580d9af",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e4ec9166-f6dc-48f8-a226-5e3fe5853902",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d30b92ec-15b1-4f47-ac01-4e500823cd75",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"MeasurementValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f7debd1a-6a18-4973-aaa1-a77998de9f38",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "2c48afe1-4435-4ee0-8381-e6a8fc02d603",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e8339463-31e7-4a6d-b790-638c991183d7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3473dd38-3598-47b1-8654-724b91880b39",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"Fields": [
{
"FormTypeFieldId": "bf93fe60-8906-4d60-a62b-fd629977e2de",
"Section": {
"FormTypeSectionId": "076728e3-f877-4ed2-b9a8-cefbefadd653",
"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": "a69dbccf-d3f2-4d6b-8682-c8042b3a9125",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f41f5c35-288c-44ce-b07a-94de59c7ee9f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f1edaf19-16c1-4626-a1c8-dd30da3d4257",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"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": "bf93fe60-8906-4d60-a62b-fd629977e2de",
"Section": {
"FormTypeSectionId": "076728e3-f877-4ed2-b9a8-cefbefadd653",
"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": "a69dbccf-d3f2-4d6b-8682-c8042b3a9125",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f41f5c35-288c-44ce-b07a-94de59c7ee9f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f1edaf19-16c1-4626-a1c8-dd30da3d4257",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"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": "e09e94af-3f3d-4334-8c81-62f108c1a0b0",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-18T04:14:49.8860363-07:00",
"Location": "sample string 1",
"TaskId": "e004297c-5183-4396-8efe-b41d8aca28b2",
"Values": [
{
"FormFieldValueId": "129d2d07-6d53-46a0-a611-4bbcc1488b25",
"FormId": "814f2dbd-a7ac-4a3a-acb9-5d236951dc89",
"FormTypeField": {
"FormTypeFieldId": "bf93fe60-8906-4d60-a62b-fd629977e2de",
"FormType": {
"FormTypeId": "2c48afe1-4435-4ee0-8381-e6a8fc02d603",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e8339463-31e7-4a6d-b790-638c991183d7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3473dd38-3598-47b1-8654-724b91880b39",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e09e94af-3f3d-4334-8c81-62f108c1a0b0",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "076728e3-f877-4ed2-b9a8-cefbefadd653",
"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": "a69dbccf-d3f2-4d6b-8682-c8042b3a9125",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f41f5c35-288c-44ce-b07a-94de59c7ee9f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f1edaf19-16c1-4626-a1c8-dd30da3d4257",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"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": "129d2d07-6d53-46a0-a611-4bbcc1488b25",
"FormId": "814f2dbd-a7ac-4a3a-acb9-5d236951dc89",
"FormTypeField": {
"FormTypeFieldId": "bf93fe60-8906-4d60-a62b-fd629977e2de",
"FormType": {
"FormTypeId": "2c48afe1-4435-4ee0-8381-e6a8fc02d603",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "e8339463-31e7-4a6d-b790-638c991183d7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3473dd38-3598-47b1-8654-724b91880b39",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-18T04:14:49.8860363-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "e09e94af-3f3d-4334-8c81-62f108c1a0b0",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "076728e3-f877-4ed2-b9a8-cefbefadd653",
"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": "a69dbccf-d3f2-4d6b-8682-c8042b3a9125",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f41f5c35-288c-44ce-b07a-94de59c7ee9f",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f1edaf19-16c1-4626-a1c8-dd30da3d4257",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "154d3003-c6ef-4826-b2fb-24a4605e6c33",
"FieldId": "df0c1b7f-eed5-4361-8d99-38c8ddd8ac53",
"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": "ea529413-cec9-4a90-933c-0b733b53fbad",
"CreateDate": "2026-03-18T04:14:49.8860363-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-18T04:14:49.8860363-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}