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": "ee930fc7-b7bf-4579-a180-39ed80d0c430", "Asset": { "AssetId": "a7dac4e6-7e64-4cbd-a390-f8d96230ce90", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "11996966-02f5-45d3-b7b5-e65c127f394f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4235403a-0c43-4d56-92d4-9d27c32faba5", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "c68a5136-3d13-421a-b5cb-41c1d58e50a9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T22:41:51.6003963-07:00", "MeasurementValueNeededDate": "2024-04-28T22:41:51.6003963-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5efea274-1aba-4b36-8d14-2f20e50cc59e", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "db2e5a3c-cd48-4ed5-a50f-831ac3299809", "EffectiveDate": "2024-04-28T22:41:51.6003963-07:00", "StateType": { "StateTypeId": "4f57fd22-dff6-4467-9c88-b3327c005500", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "11996966-02f5-45d3-b7b5-e65c127f394f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4235403a-0c43-4d56-92d4-9d27c32faba5", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "84ea9e35-b611-4190-aabd-41f12f3137b3", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "6df9d98f-893b-480c-a3af-de9edd743721", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "b0e8690c-3178-400f-a723-2bb0dbebcaf2", "EffectiveDate": "2024-04-28T22:41:51.6003963-07:00", "StatusType": { "StatusTypeId": "9b3a47fb-bf69-4f93-b54e-0a184ef6daeb", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "11996966-02f5-45d3-b7b5-e65c127f394f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4235403a-0c43-4d56-92d4-9d27c32faba5", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "06599973-800c-40c9-9179-0c24f64d4c3f", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "fd213b20-8a6c-4212-a36c-cdf571c7cd29", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "81d27a1e-6c43-42ec-89cc-d0b4aabb1dc6", "EffectiveDate": "2024-04-28T22:41:51.6003963-07:00", "WellPurposeType": { "WellPurposeTypeId": "edc06762-186b-4b62-87d9-55ea0f678653", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "15d9dc3b-e115-45a1-8c67-3b4c234b63de", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "eb4ed486-12e6-408d-94db-a0649603bed0", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T22:41:51.6003963-07:00", "MeasurementValueNeededDate": "2024-04-28T22:41:51.6003963-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d7d26f13-1a5c-4bb6-8c6b-1b6e50769d27", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "36d3a830-d607-4b42-b0ad-02a9796c2c0c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "11996966-02f5-45d3-b7b5-e65c127f394f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "4235403a-0c43-4d56-92d4-9d27c32faba5", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T22:41:51.6003963-07:00", "Fields": [ { "FormTypeFieldId": "e4e258e7-96b6-4e60-97ae-05a91192741c", "Section": { "FormTypeSectionId": "142bc001-10b8-46b8-ab2e-c64f799d0b43", "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": "0858b8cb-acbe-4776-8875-e429c3730aa9", "Name": "sample string 1" }, "Unit": { "UnitId": "b7c21769-2c05-4376-8963-3b20c2eabd21", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6e8b9ac7-606c-470c-bf4f-3b5f6e44ee06", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "e4e258e7-96b6-4e60-97ae-05a91192741c", "Section": { "FormTypeSectionId": "142bc001-10b8-46b8-ab2e-c64f799d0b43", "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": "0858b8cb-acbe-4776-8875-e429c3730aa9", "Name": "sample string 1" }, "Unit": { "UnitId": "b7c21769-2c05-4376-8963-3b20c2eabd21", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6e8b9ac7-606c-470c-bf4f-3b5f6e44ee06", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "3b495305-4e80-401d-a111-db78662c0f7f", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-28T22:41:51.6003963-07:00", "Location": "sample string 1", "Values": [ { "FormFieldValueId": "bb4e2d3f-5f13-4043-a82c-c85adf731ad4", "FormTypeField": { "FormTypeFieldId": "e4e258e7-96b6-4e60-97ae-05a91192741c", "Section": { "FormTypeSectionId": "142bc001-10b8-46b8-ab2e-c64f799d0b43", "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": "0858b8cb-acbe-4776-8875-e429c3730aa9", "Name": "sample string 1" }, "Unit": { "UnitId": "b7c21769-2c05-4376-8963-3b20c2eabd21", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6e8b9ac7-606c-470c-bf4f-3b5f6e44ee06", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "bb4e2d3f-5f13-4043-a82c-c85adf731ad4", "FormTypeField": { "FormTypeFieldId": "e4e258e7-96b6-4e60-97ae-05a91192741c", "Section": { "FormTypeSectionId": "142bc001-10b8-46b8-ab2e-c64f799d0b43", "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": "0858b8cb-acbe-4776-8875-e429c3730aa9", "Name": "sample string 1" }, "Unit": { "UnitId": "b7c21769-2c05-4376-8963-3b20c2eabd21", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6e8b9ac7-606c-470c-bf4f-3b5f6e44ee06", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "e693f5a0-9ade-4166-bbca-fc49d7152300", "CreateDate": "2024-04-28T22:41:51.6003963-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T22:41:51.6003963-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }