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": "a0cfe46b-4505-4690-8928-3c0d1177454b", "Asset": { "AssetId": "2f839e95-e2f8-4c26-a614-306bceecd813", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "627fce86-1290-4208-8379-0c559168cbcf", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d82e279e-e977-4fb2-81aa-d1096c4b9d6c", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T23:59:49.1820046-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d72da7f7-2c20-4457-b3b5-e0559aeb0c60", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T23:59:49.1820046-07:00", "MeasurementValueNeededDate": "2025-05-08T23:59:49.1820046-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7085a590-d28c-4d39-be0c-53f4216f5a5b", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T23:59:49.1820046-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T23:59:49.1820046-07:00", "MeasurementValueNeededDate": "2025-05-08T23:59:49.1820046-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "875b5947-ab2a-4701-ad86-fd38963a9cc8", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T23:59:49.1820046-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "b7b17f5c-4dd1-457a-b961-61837cb5f259", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "627fce86-1290-4208-8379-0c559168cbcf", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d82e279e-e977-4fb2-81aa-d1096c4b9d6c", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T23:59:49.1820046-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-08T23:59:49.1820046-07:00", "Fields": [ { "FormTypeFieldId": "6c981f71-8b4d-4935-af75-ad155eaa7343", "Section": { "FormTypeSectionId": "d128b9ac-7f7a-47d6-97f9-c0e6abcde705", "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": "f9096262-6497-4338-925b-aab0aa1fd009", "Name": "sample string 1" }, "Unit": { "UnitId": "886bfe3f-d665-4340-9639-e1a50a1affc8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb17f298-38a2-4678-b93c-0e57426552b0", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T23:59:49.1820046-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": "6c981f71-8b4d-4935-af75-ad155eaa7343", "Section": { "FormTypeSectionId": "d128b9ac-7f7a-47d6-97f9-c0e6abcde705", "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": "f9096262-6497-4338-925b-aab0aa1fd009", "Name": "sample string 1" }, "Unit": { "UnitId": "886bfe3f-d665-4340-9639-e1a50a1affc8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb17f298-38a2-4678-b93c-0e57426552b0", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T23:59:49.1820046-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": "cf858c62-ced9-4f16-a70d-dba29cb90b82", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T23:59:49.1820046-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-08T23:59:49.1820046-07:00", "Location": "sample string 1", "TaskId": "35b7b034-919f-44f4-b9cc-cfc682338c97", "Values": [ { "FormFieldValueId": "df2ef468-dbd8-48b7-82be-da7771273c73", "FormTypeField": { "FormTypeFieldId": "6c981f71-8b4d-4935-af75-ad155eaa7343", "Section": { "FormTypeSectionId": "d128b9ac-7f7a-47d6-97f9-c0e6abcde705", "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": "f9096262-6497-4338-925b-aab0aa1fd009", "Name": "sample string 1" }, "Unit": { "UnitId": "886bfe3f-d665-4340-9639-e1a50a1affc8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb17f298-38a2-4678-b93c-0e57426552b0", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T23:59:49.1820046-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": "df2ef468-dbd8-48b7-82be-da7771273c73", "FormTypeField": { "FormTypeFieldId": "6c981f71-8b4d-4935-af75-ad155eaa7343", "Section": { "FormTypeSectionId": "d128b9ac-7f7a-47d6-97f9-c0e6abcde705", "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": "f9096262-6497-4338-925b-aab0aa1fd009", "Name": "sample string 1" }, "Unit": { "UnitId": "886bfe3f-d665-4340-9639-e1a50a1affc8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fb17f298-38a2-4678-b93c-0e57426552b0", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T23:59:49.1820046-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": "94825325-7258-4bca-b8a8-902ed5516ba2", "CreateDate": "2025-05-08T23:59:49.1820046-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T23:59:49.1820046-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }