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": "f1a19be4-aeba-4f66-911c-93c153d1dd2e", "Asset": { "AssetId": "8da3b698-1fa8-46fb-a045-7f8ef397501b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ada7956a-3eb0-45ce-8aaa-5f90a38d8e69", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c6cf68d-93b0-4e94-8785-8240513c7c31", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "abd82e81-7bbe-4504-8b82-f081ce1c292c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-19T17:55:04.611315-07:00", "MeasurementValueNeededDate": "2024-04-19T17:55:04.611315-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fa7838f5-5365-4ea1-bc53-d28cbb630812", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "7aae6153-1c2c-43dc-bf15-e5f18d7c6984", "EffectiveDate": "2024-04-19T17:55:04.611315-07:00", "StateType": { "StateTypeId": "5007d684-7f76-4237-968c-16ad7ff226b3", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "ada7956a-3eb0-45ce-8aaa-5f90a38d8e69", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c6cf68d-93b0-4e94-8785-8240513c7c31", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "0120d727-3862-4dab-8e27-b9daeae64837", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "6d289704-bc14-40a8-ae4c-69c06ad440c8", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "b299c32a-e593-4436-b312-7f7c725a4a79", "EffectiveDate": "2024-04-19T17:55:04.611315-07:00", "StatusType": { "StatusTypeId": "b9e45bd6-9c72-46c1-a77a-efadb47971cb", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "ada7956a-3eb0-45ce-8aaa-5f90a38d8e69", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c6cf68d-93b0-4e94-8785-8240513c7c31", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "a239cc4f-8a92-4dc8-8599-b3c189da9ed0", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0207e73c-d460-4482-aa8e-4269a87adcb2", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "a8076bc0-0bd2-4107-aaec-40a645be4b4e", "EffectiveDate": "2024-04-19T17:55:04.611315-07:00", "WellPurposeType": { "WellPurposeTypeId": "ec6be0b0-aa6a-4799-a70a-67d3ef16e24c", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "319a6d2f-84c6-476f-8b74-3d1d590ce18e", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4cb708ce-571e-41b9-b423-c82d74dbfaba", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-19T17:55:04.611315-07:00", "MeasurementValueNeededDate": "2024-04-19T17:55:04.611315-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4a7bb49e-31e4-472e-bc21-1472854a2fbe", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "c8fb2c6d-fb55-41bd-af03-4c7d08973938", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ada7956a-3eb0-45ce-8aaa-5f90a38d8e69", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c6cf68d-93b0-4e94-8785-8240513c7c31", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-19T17:55:04.611315-07:00", "Fields": [ { "FormTypeFieldId": "f3576afe-c619-450d-91dd-6ec8796abb33", "Section": { "FormTypeSectionId": "b5c95257-5d3e-4c89-ab46-be5b3b602a85", "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": "04887575-8e73-4b28-9ea0-8a2a32d9a56a", "Name": "sample string 1" }, "Unit": { "UnitId": "3d61df92-34bf-4965-8e22-fc1115278c60", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f85a1aec-8e5a-4810-8fe0-7f108e0b39b7", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-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": "f3576afe-c619-450d-91dd-6ec8796abb33", "Section": { "FormTypeSectionId": "b5c95257-5d3e-4c89-ab46-be5b3b602a85", "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": "04887575-8e73-4b28-9ea0-8a2a32d9a56a", "Name": "sample string 1" }, "Unit": { "UnitId": "3d61df92-34bf-4965-8e22-fc1115278c60", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f85a1aec-8e5a-4810-8fe0-7f108e0b39b7", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-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": "ee483b4e-039f-4cb0-a081-a69528d957ee", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-19T17:55:04.611315-07:00", "Location": "sample string 1", "Values": [ { "FormFieldValueId": "55efd04f-11f3-4d8a-94f0-7de2bd87ccba", "FormTypeField": { "FormTypeFieldId": "f3576afe-c619-450d-91dd-6ec8796abb33", "Section": { "FormTypeSectionId": "b5c95257-5d3e-4c89-ab46-be5b3b602a85", "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": "04887575-8e73-4b28-9ea0-8a2a32d9a56a", "Name": "sample string 1" }, "Unit": { "UnitId": "3d61df92-34bf-4965-8e22-fc1115278c60", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f85a1aec-8e5a-4810-8fe0-7f108e0b39b7", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-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": "55efd04f-11f3-4d8a-94f0-7de2bd87ccba", "FormTypeField": { "FormTypeFieldId": "f3576afe-c619-450d-91dd-6ec8796abb33", "Section": { "FormTypeSectionId": "b5c95257-5d3e-4c89-ab46-be5b3b602a85", "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": "04887575-8e73-4b28-9ea0-8a2a32d9a56a", "Name": "sample string 1" }, "Unit": { "UnitId": "3d61df92-34bf-4965-8e22-fc1115278c60", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f85a1aec-8e5a-4810-8fe0-7f108e0b39b7", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T17:55:04.611315-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": "a6b32f39-8b30-443c-9367-3b3fa07b259f", "CreateDate": "2024-04-19T17:55:04.611315-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-19T17:55:04.611315-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }