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": "585083aa-04bd-4de0-9aba-76e79faead9a",
"Asset": {
"AssetId": "c9b7ce38-60e4-4f0e-b3d0-1a9e3f287f05",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0e695976-6160-4fe6-bc83-2c5c35fbb4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2bba86fb-3f94-4166-92c9-e4ff85c7261e",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "003b5e59-826a-436b-b290-1af497d81a6f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"MeasurementValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "974967b2-8f52-4567-86b3-13ac1b2e64ed",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "52193ffc-c7fc-4553-b559-f6003ffaccfa",
"EffectiveDate": "2026-03-09T03:03:38.9373513-07:00",
"StateType": {
"StateTypeId": "2d625e6b-0d02-4d00-ab75-89cd5f5823eb",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0e695976-6160-4fe6-bc83-2c5c35fbb4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2bba86fb-3f94-4166-92c9-e4ff85c7261e",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "65d4ad26-c6dd-4f72-beba-9461e17503f8",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cbe57639-d19a-4b8d-83d0-17fd1149fd21",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "38de296d-4ea8-494e-9c21-8df940e15fe4",
"EffectiveDate": "2026-03-09T03:03:38.9373513-07:00",
"StatusType": {
"StatusTypeId": "ae4d191b-45cf-4cc8-beef-8aa09b8809a4",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0e695976-6160-4fe6-bc83-2c5c35fbb4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2bba86fb-3f94-4166-92c9-e4ff85c7261e",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "45c6f560-9859-4ecb-a873-690710336011",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "10e75b84-1f07-451a-9dc9-b602fb29c033",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a53e9e73-b390-4a06-b7b0-fdfa1e21ed28",
"EffectiveDate": "2026-03-09T03:03:38.9373513-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "61d4a0fb-d7bd-447d-8d65-af1258411402",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "56d245aa-c891-4f08-b5f8-ede7704dd7cb",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b3f30322-d9b9-4dc7-b427-4178f8746749",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"MeasurementValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7d646528-25ed-4a8c-bfee-bad4ee9b2202",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "c23a509a-cb10-4cb1-a386-0abfdab42c39",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0e695976-6160-4fe6-bc83-2c5c35fbb4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2bba86fb-3f94-4166-92c9-e4ff85c7261e",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"Fields": [
{
"FormTypeFieldId": "16710f8b-de2e-4fb7-8eed-c36ff8cc3f16",
"Section": {
"FormTypeSectionId": "41fa468d-8d56-43fc-a492-9a3ce721384d",
"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": "46ce4d46-477e-4a90-a286-c5ab80d564bc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98d0791c-baab-404d-baa6-6f56230a9193",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5f820f2-cb38-476b-970b-8385ad618320",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"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": "16710f8b-de2e-4fb7-8eed-c36ff8cc3f16",
"Section": {
"FormTypeSectionId": "41fa468d-8d56-43fc-a492-9a3ce721384d",
"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": "46ce4d46-477e-4a90-a286-c5ab80d564bc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98d0791c-baab-404d-baa6-6f56230a9193",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5f820f2-cb38-476b-970b-8385ad618320",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"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": "27358c1c-25c7-4fd3-a962-98e6991be608",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2026-03-09T03:03:38.9373513-07:00",
"Location": "sample string 1",
"TaskId": "5d599d0e-791a-4aba-a1fe-011817800398",
"Values": [
{
"FormFieldValueId": "919d1c60-3acc-4b19-9bac-933d78aad9dc",
"FormId": "12a41658-b49c-41ba-8610-e9271aa78372",
"FormTypeField": {
"FormTypeFieldId": "16710f8b-de2e-4fb7-8eed-c36ff8cc3f16",
"FormType": {
"FormTypeId": "c23a509a-cb10-4cb1-a386-0abfdab42c39",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0e695976-6160-4fe6-bc83-2c5c35fbb4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2bba86fb-3f94-4166-92c9-e4ff85c7261e",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "27358c1c-25c7-4fd3-a962-98e6991be608",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "41fa468d-8d56-43fc-a492-9a3ce721384d",
"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": "46ce4d46-477e-4a90-a286-c5ab80d564bc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98d0791c-baab-404d-baa6-6f56230a9193",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5f820f2-cb38-476b-970b-8385ad618320",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"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": "919d1c60-3acc-4b19-9bac-933d78aad9dc",
"FormId": "12a41658-b49c-41ba-8610-e9271aa78372",
"FormTypeField": {
"FormTypeFieldId": "16710f8b-de2e-4fb7-8eed-c36ff8cc3f16",
"FormType": {
"FormTypeId": "c23a509a-cb10-4cb1-a386-0abfdab42c39",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "0e695976-6160-4fe6-bc83-2c5c35fbb4ab",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2bba86fb-3f94-4166-92c9-e4ff85c7261e",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-03-09T03:03:38.9373513-07:00",
"Fields": [],
"SourceSystemId": "sample string 3",
"CompanyId": "27358c1c-25c7-4fd3-a962-98e6991be608",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"Section": {
"FormTypeSectionId": "41fa468d-8d56-43fc-a492-9a3ce721384d",
"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": "46ce4d46-477e-4a90-a286-c5ab80d564bc",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "98d0791c-baab-404d-baa6-6f56230a9193",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f5f820f2-cb38-476b-970b-8385ad618320",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "37629f13-97fb-472a-8532-b1c4041b1e8b",
"FieldId": "07058435-af7e-4022-bdf3-6b17133ae821",
"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": "425f4a66-7a77-44a0-bae3-d501883e3f75",
"CreateDate": "2026-03-09T03:03:38.9373513-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-09T03:03:38.9373513-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}