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": "d75e517e-2b05-4025-bc4f-0f420b479dd4", "Asset": { "AssetId": "27307b0a-84d2-4e41-b0d3-0c8eafab10ff", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6fa7a696-906a-4e09-b76b-73409c48bd6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6305f8d8-6e6f-4a63-90dd-c9af21950e7f", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "a7538bd4-824d-4551-9ca0-a8f38881bfec", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "MeasurementValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8dbbb52a-3ad2-4850-b9bf-eb327661b6aa", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "2d8f69a0-a57a-4a07-890b-00c956eb4a23", "EffectiveDate": "2025-06-02T14:47:38.6026416-07:00", "StateType": { "StateTypeId": "2ecaac20-7dcc-4cb3-b45d-09a40aba8f54", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6fa7a696-906a-4e09-b76b-73409c48bd6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6305f8d8-6e6f-4a63-90dd-c9af21950e7f", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "4fc0c03e-b1dc-4a38-9748-371ba131c55a", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "4b9b6ed7-a24c-41c9-993e-8cab2e0e84ee", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "13c3fd79-c861-4202-88f9-2dbff1ad111c", "EffectiveDate": "2025-06-02T14:47:38.6026416-07:00", "StatusType": { "StatusTypeId": "2fa57f48-6726-46bf-90e6-71e11603bd40", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6fa7a696-906a-4e09-b76b-73409c48bd6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6305f8d8-6e6f-4a63-90dd-c9af21950e7f", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "13b023a4-4728-4f63-b57a-70bab63d0e94", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "e5fb14d8-9c4e-448d-b343-5c4a8d6f6375", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "82cd9b47-ebde-40be-b43f-8993a2e3d12c", "EffectiveDate": "2025-06-02T14:47:38.6026416-07:00", "WellPurposeType": { "WellPurposeTypeId": "913d7f69-0338-4885-9b00-5b65ac9f5de3", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "830b319b-66eb-45b3-a0cf-b46b742a1e66", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "75e3f8f0-20c8-4b60-932d-1b00380af7e4", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "MeasurementValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a57069c0-a695-421d-b4a4-f81f5ba88735", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "f5ff90e6-ea03-4919-8065-eb5934d00ea0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6fa7a696-906a-4e09-b76b-73409c48bd6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6305f8d8-6e6f-4a63-90dd-c9af21950e7f", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "Fields": [ { "FormTypeFieldId": "b3a74971-3a48-4800-b256-46a075e8020b", "Section": { "FormTypeSectionId": "fafb6751-b866-47ed-9d9f-6ee06944fb21", "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": "dd9f5f13-86ff-4312-89b9-f6c4676e1831", "Name": "sample string 1" }, "Unit": { "UnitId": "ab2f6615-2ee6-415d-82a5-dcc1dc6cc0b2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "40c963c7-0684-43d1-bb48-a698d3c14838", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "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": "b3a74971-3a48-4800-b256-46a075e8020b", "Section": { "FormTypeSectionId": "fafb6751-b866-47ed-9d9f-6ee06944fb21", "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": "dd9f5f13-86ff-4312-89b9-f6c4676e1831", "Name": "sample string 1" }, "Unit": { "UnitId": "ab2f6615-2ee6-415d-82a5-dcc1dc6cc0b2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "40c963c7-0684-43d1-bb48-a698d3c14838", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "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": "adf029cf-fd31-4099-9136-01e6c5c1dcc3", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-02T14:47:38.6026416-07:00", "Location": "sample string 1", "TaskId": "572dec12-6a5f-4fef-86a4-e91f3330a8d5", "Values": [ { "FormFieldValueId": "ece52dcf-7903-4013-b94a-cf1c19ac2047", "FormId": "828d151e-368f-4784-8be4-9310f18e8337", "FormTypeField": { "FormTypeFieldId": "b3a74971-3a48-4800-b256-46a075e8020b", "FormType": { "FormTypeId": "f5ff90e6-ea03-4919-8065-eb5934d00ea0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6fa7a696-906a-4e09-b76b-73409c48bd6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6305f8d8-6e6f-4a63-90dd-c9af21950e7f", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "adf029cf-fd31-4099-9136-01e6c5c1dcc3", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "fafb6751-b866-47ed-9d9f-6ee06944fb21", "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": "dd9f5f13-86ff-4312-89b9-f6c4676e1831", "Name": "sample string 1" }, "Unit": { "UnitId": "ab2f6615-2ee6-415d-82a5-dcc1dc6cc0b2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "40c963c7-0684-43d1-bb48-a698d3c14838", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "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": "ece52dcf-7903-4013-b94a-cf1c19ac2047", "FormId": "828d151e-368f-4784-8be4-9310f18e8337", "FormTypeField": { "FormTypeFieldId": "b3a74971-3a48-4800-b256-46a075e8020b", "FormType": { "FormTypeId": "f5ff90e6-ea03-4919-8065-eb5934d00ea0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6fa7a696-906a-4e09-b76b-73409c48bd6c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6305f8d8-6e6f-4a63-90dd-c9af21950e7f", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T14:47:38.6026416-07:00", "Fields": [], "SourceSystemId": "sample string 3", "CompanyId": "adf029cf-fd31-4099-9136-01e6c5c1dcc3", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "Section": { "FormTypeSectionId": "fafb6751-b866-47ed-9d9f-6ee06944fb21", "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": "dd9f5f13-86ff-4312-89b9-f6c4676e1831", "Name": "sample string 1" }, "Unit": { "UnitId": "ab2f6615-2ee6-415d-82a5-dcc1dc6cc0b2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "40c963c7-0684-43d1-bb48-a698d3c14838", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "386031ad-b1f4-4a48-bef1-de71c6817545", "FieldId": "15d08522-40a7-459e-810b-c355aa5ceef2", "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": "2ec616d8-b173-4595-a6cf-20f3f3435ab9", "CreateDate": "2025-06-02T14:47:38.6026416-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T14:47:38.6026416-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }