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": "aeab2b1e-3f35-4261-a963-b0e860a6c3a0", "Asset": { "AssetId": "1fdeb249-40d0-466a-9e32-113b17ee9cf8", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "993e60ab-1eb7-4093-a9b1-6439041837e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "75250c74-8139-48ad-ba56-73d74e2b7931", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "550d7b03-cc74-4bf7-9cdc-98b0c40de429", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "MeasurementValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7e483f19-79f0-4fcf-958c-4618c830efad", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "MeasurementValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7339f6ad-d09f-4efd-ad3d-702cd9a85a1b", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "ea47cb8a-88da-482b-b3f0-caad45fa8cf7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "993e60ab-1eb7-4093-a9b1-6439041837e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "75250c74-8139-48ad-ba56-73d74e2b7931", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "03448105-4f8b-4996-a301-94e8a9ec1971", "Section": { "FormTypeSectionId": "37ea1843-5474-40f2-8cb9-2283d73b85c3", "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": "3be63455-138f-4caf-b2fb-e270bed04054", "Name": "sample string 1" }, "Unit": { "UnitId": "5e0319d1-ad97-488a-9f9f-15e2434b96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2375d4c9-8727-4ad0-b210-f3ca06c65e18", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "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": "03448105-4f8b-4996-a301-94e8a9ec1971", "Section": { "FormTypeSectionId": "37ea1843-5474-40f2-8cb9-2283d73b85c3", "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": "3be63455-138f-4caf-b2fb-e270bed04054", "Name": "sample string 1" }, "Unit": { "UnitId": "5e0319d1-ad97-488a-9f9f-15e2434b96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2375d4c9-8727-4ad0-b210-f3ca06c65e18", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "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 4", "CompanyId": "d975aea4-db49-4384-b5b1-7373cf5aec79", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-07-30T11:53:06.5632108-07:00", "Location": "sample string 1", "TaskId": "2b803de5-2429-4877-a068-0e1f0d0481cd", "Values": [ { "FormFieldValueId": "fe3398f5-a6ac-412b-8830-9cc68c3c0c7b", "FormId": "44239ecb-1235-4341-a53b-3996d32aa957", "FormTypeField": { "FormTypeFieldId": "03448105-4f8b-4996-a301-94e8a9ec1971", "FormType": { "FormTypeId": "ea47cb8a-88da-482b-b3f0-caad45fa8cf7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "993e60ab-1eb7-4093-a9b1-6439041837e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "75250c74-8139-48ad-ba56-73d74e2b7931", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "d975aea4-db49-4384-b5b1-7373cf5aec79", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "37ea1843-5474-40f2-8cb9-2283d73b85c3", "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": "3be63455-138f-4caf-b2fb-e270bed04054", "Name": "sample string 1" }, "Unit": { "UnitId": "5e0319d1-ad97-488a-9f9f-15e2434b96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2375d4c9-8727-4ad0-b210-f3ca06c65e18", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "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": "fe3398f5-a6ac-412b-8830-9cc68c3c0c7b", "FormId": "44239ecb-1235-4341-a53b-3996d32aa957", "FormTypeField": { "FormTypeFieldId": "03448105-4f8b-4996-a301-94e8a9ec1971", "FormType": { "FormTypeId": "ea47cb8a-88da-482b-b3f0-caad45fa8cf7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "993e60ab-1eb7-4093-a9b1-6439041837e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "75250c74-8139-48ad-ba56-73d74e2b7931", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T11:53:06.5632108-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "d975aea4-db49-4384-b5b1-7373cf5aec79", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "37ea1843-5474-40f2-8cb9-2283d73b85c3", "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": "3be63455-138f-4caf-b2fb-e270bed04054", "Name": "sample string 1" }, "Unit": { "UnitId": "5e0319d1-ad97-488a-9f9f-15e2434b96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2375d4c9-8727-4ad0-b210-f3ca06c65e18", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c6240136-a617-4c79-8059-49ea8c186cfd", "FieldId": "a877f5fb-ea73-4332-b083-49a0773c58bb", "FieldName": "sample string 1", "FieldLabel": "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": "e7ea4f14-16e7-4b2f-959b-9ee016b03962", "CreateDate": "2025-07-30T11:53:06.5632108-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-30T11:53:06.5632108-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }