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": "7252bb1c-da9f-4a3b-ab01-05369fcc58f0", "Asset": { "AssetId": "c08f911c-c676-4a34-9a63-8f0071b930bd", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "deab849b-742f-4104-b1bb-c665e4cef7fc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fe81218f-a518-4ca2-af89-72cc03717b1d", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "5a5040dd-0046-4379-b2e5-b7d6b3efc310", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "MeasurementValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "SourceSystemId": "sample string 3", "CompanyId": "448386bf-a600-4ff3-9571-04ccee98bd0d", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "MeasurementValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "719e1271-42c6-42ab-b337-c00eeb4c97fb", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "d7053178-0e07-4fe9-936f-60cce53be3db", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "deab849b-742f-4104-b1bb-c665e4cef7fc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fe81218f-a518-4ca2-af89-72cc03717b1d", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "b3654f9e-0570-428e-b039-6f68c90945cf", "Section": { "FormTypeSectionId": "0ec5398f-e59d-421f-89e4-c67bd812b139", "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": "70c0264e-2eba-4b0e-aee7-643eb78fb3ec", "Name": "sample string 1" }, "Unit": { "UnitId": "826b3da6-875f-46df-9599-f70c05c36ce8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "908deb85-d3eb-4669-a3ac-519c99d98cb7", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "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": "b3654f9e-0570-428e-b039-6f68c90945cf", "Section": { "FormTypeSectionId": "0ec5398f-e59d-421f-89e4-c67bd812b139", "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": "70c0264e-2eba-4b0e-aee7-643eb78fb3ec", "Name": "sample string 1" }, "Unit": { "UnitId": "826b3da6-875f-46df-9599-f70c05c36ce8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "908deb85-d3eb-4669-a3ac-519c99d98cb7", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "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": "28b555f4-c2cf-45fc-ad33-c16b74d76ad9", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-06-02T07:04:03.0754446-07:00", "Location": "sample string 1", "TaskId": "155f2869-3bfb-4783-8d12-72807d78151e", "Values": [ { "FormFieldValueId": "ef523689-c763-47bb-93f5-d23e0729b677", "FormId": "6b067240-0b2f-4c52-9725-3b291b096bb7", "FormTypeField": { "FormTypeFieldId": "b3654f9e-0570-428e-b039-6f68c90945cf", "FormType": { "FormTypeId": "d7053178-0e07-4fe9-936f-60cce53be3db", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "deab849b-742f-4104-b1bb-c665e4cef7fc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fe81218f-a518-4ca2-af89-72cc03717b1d", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "28b555f4-c2cf-45fc-ad33-c16b74d76ad9", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "0ec5398f-e59d-421f-89e4-c67bd812b139", "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": "70c0264e-2eba-4b0e-aee7-643eb78fb3ec", "Name": "sample string 1" }, "Unit": { "UnitId": "826b3da6-875f-46df-9599-f70c05c36ce8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "908deb85-d3eb-4669-a3ac-519c99d98cb7", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "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": "ef523689-c763-47bb-93f5-d23e0729b677", "FormId": "6b067240-0b2f-4c52-9725-3b291b096bb7", "FormTypeField": { "FormTypeFieldId": "b3654f9e-0570-428e-b039-6f68c90945cf", "FormType": { "FormTypeId": "d7053178-0e07-4fe9-936f-60cce53be3db", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "deab849b-742f-4104-b1bb-c665e4cef7fc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fe81218f-a518-4ca2-af89-72cc03717b1d", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-02T07:04:03.0754446-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "28b555f4-c2cf-45fc-ad33-c16b74d76ad9", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "0ec5398f-e59d-421f-89e4-c67bd812b139", "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": "70c0264e-2eba-4b0e-aee7-643eb78fb3ec", "Name": "sample string 1" }, "Unit": { "UnitId": "826b3da6-875f-46df-9599-f70c05c36ce8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "908deb85-d3eb-4669-a3ac-519c99d98cb7", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "47e2b719-2c4e-44d8-b0ea-28c70b241cb7", "FieldId": "5b0f238b-88d9-421a-b3ee-f4bc1864035e", "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": "1475a87b-5d98-4eed-8fc3-6a9aa2448d6d", "CreateDate": "2025-06-02T07:04:03.0754446-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-02T07:04:03.0754446-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }