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": "da2782e6-bbf9-4568-8a3f-743f2897ac61", "Asset": { "AssetId": "3c3ed296-d0d4-4dbb-82a7-fb723b84d6b0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "b4d8f708-4fb1-42bc-8e81-932efe1fe28b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "15961b75-0508-4721-b718-e3898b1ca59e", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "a29f1157-0ac0-42f3-890a-2edadacc3516", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-05T08:04:12.4248277-08:00", "MeasurementValueNeededDate": "2025-02-05T08:04:12.4248277-08:00", "SourceSystemId": "sample string 3", "CompanyId": "38c352ce-256e-4cc7-80bb-1b5e4384d144", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-02-05T08:04:12.4248277-08:00", "MeasurementValueNeededDate": "2025-02-05T08:04:12.4248277-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3a2d0e22-85de-4966-8d4e-b4c651382bde", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "65a09001-67c2-4ffa-ab27-94516802eeae", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b4d8f708-4fb1-42bc-8e81-932efe1fe28b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "15961b75-0508-4721-b718-e3898b1ca59e", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-02-05T08:04:12.4248277-08:00", "Fields": [ { "FormTypeFieldId": "9abd8db3-4e1e-4e21-bc81-e0191505db33", "Section": { "FormTypeSectionId": "75b130ba-d511-4177-8fc4-1dfe36158c39", "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": "18899fe7-4fd6-48ec-8057-fd9ae17c705f", "Name": "sample string 1" }, "Unit": { "UnitId": "ecab7e1c-60c5-408a-8d57-55a68f049a29", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "938adadf-15bf-45cb-933b-9555b63c24b9", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08: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": "9abd8db3-4e1e-4e21-bc81-e0191505db33", "Section": { "FormTypeSectionId": "75b130ba-d511-4177-8fc4-1dfe36158c39", "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": "18899fe7-4fd6-48ec-8057-fd9ae17c705f", "Name": "sample string 1" }, "Unit": { "UnitId": "ecab7e1c-60c5-408a-8d57-55a68f049a29", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "938adadf-15bf-45cb-933b-9555b63c24b9", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08: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": "6ce85774-7fb1-4c3c-883a-94195121f423", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-02-05T08:04:12.4248277-08:00", "Location": "sample string 1", "TaskId": "728d5da9-f688-4b78-a965-d89aca5e52e2", "Values": [ { "FormFieldValueId": "9752cad7-c47b-4656-8155-38697e872aa6", "FormTypeField": { "FormTypeFieldId": "9abd8db3-4e1e-4e21-bc81-e0191505db33", "Section": { "FormTypeSectionId": "75b130ba-d511-4177-8fc4-1dfe36158c39", "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": "18899fe7-4fd6-48ec-8057-fd9ae17c705f", "Name": "sample string 1" }, "Unit": { "UnitId": "ecab7e1c-60c5-408a-8d57-55a68f049a29", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "938adadf-15bf-45cb-933b-9555b63c24b9", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08: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": "9752cad7-c47b-4656-8155-38697e872aa6", "FormTypeField": { "FormTypeFieldId": "9abd8db3-4e1e-4e21-bc81-e0191505db33", "Section": { "FormTypeSectionId": "75b130ba-d511-4177-8fc4-1dfe36158c39", "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": "18899fe7-4fd6-48ec-8057-fd9ae17c705f", "Name": "sample string 1" }, "Unit": { "UnitId": "ecab7e1c-60c5-408a-8d57-55a68f049a29", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "938adadf-15bf-45cb-933b-9555b63c24b9", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08: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": "3c4a7b50-f740-4b96-9a15-a35b312d7766", "CreateDate": "2025-02-05T08:04:12.4248277-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-02-05T08:04:12.4248277-08:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }