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": "94aec4d1-88a5-47ae-886b-df018df26b0b", "Asset": { "AssetId": "4a4e0ed6-0a77-471a-b91a-3f63859ca802", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d70f6abc-57ac-435c-ab4a-1592231bbbf0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a6082f7a-9dbb-4e2a-a54b-27e2c030516f", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-19T03:02:28.8438663-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "86c0f223-adba-45bb-ab1f-45c3ab358ced", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-19T03:02:28.8438663-07:00", "MeasurementValueNeededDate": "2024-04-19T03:02:28.8438663-07:00", "SourceSystemId": "sample string 3", "CompanyId": "598ffe1a-ace6-40b4-b9b4-e9c093952bf1", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T03:02:28.8438663-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-19T03:02:28.8438663-07:00", "MeasurementValueNeededDate": "2024-04-19T03:02:28.8438663-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "01e893fc-da65-4c0d-9cb4-3fe816c3db47", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-19T03:02:28.8438663-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "83f7057f-6b95-433a-9ab8-0b8fc28acef2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d70f6abc-57ac-435c-ab4a-1592231bbbf0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a6082f7a-9dbb-4e2a-a54b-27e2c030516f", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-19T03:02:28.8438663-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-19T03:02:28.8438663-07:00", "Fields": [ { "FormTypeFieldId": "e0782c63-1a75-4b2c-bde6-3194321c6117", "Section": { "FormTypeSectionId": "abe791c9-b977-4fb4-af9d-61e709c3b283", "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": "dab5e610-7637-40e5-af2e-82047eab8058", "Name": "sample string 1" }, "Unit": { "UnitId": "6b24258b-9ce8-4319-a381-cde4b057a826", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8ae4d756-efff-48b7-87d5-f40eb9dde443", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T03:02:28.8438663-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": "e0782c63-1a75-4b2c-bde6-3194321c6117", "Section": { "FormTypeSectionId": "abe791c9-b977-4fb4-af9d-61e709c3b283", "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": "dab5e610-7637-40e5-af2e-82047eab8058", "Name": "sample string 1" }, "Unit": { "UnitId": "6b24258b-9ce8-4319-a381-cde4b057a826", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8ae4d756-efff-48b7-87d5-f40eb9dde443", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T03:02:28.8438663-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": "31f38464-a401-4950-93db-103717240297", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T03:02:28.8438663-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-19T03:02:28.8438663-07:00", "Location": "sample string 1", "TaskId": "f7592167-0db4-4c9e-9905-46d41febab04", "Values": [ { "FormFieldValueId": "00a0ef6c-5779-4273-9dfc-ea308ee4972b", "FormTypeField": { "FormTypeFieldId": "e0782c63-1a75-4b2c-bde6-3194321c6117", "Section": { "FormTypeSectionId": "abe791c9-b977-4fb4-af9d-61e709c3b283", "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": "dab5e610-7637-40e5-af2e-82047eab8058", "Name": "sample string 1" }, "Unit": { "UnitId": "6b24258b-9ce8-4319-a381-cde4b057a826", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8ae4d756-efff-48b7-87d5-f40eb9dde443", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T03:02:28.8438663-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": "00a0ef6c-5779-4273-9dfc-ea308ee4972b", "FormTypeField": { "FormTypeFieldId": "e0782c63-1a75-4b2c-bde6-3194321c6117", "Section": { "FormTypeSectionId": "abe791c9-b977-4fb4-af9d-61e709c3b283", "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": "dab5e610-7637-40e5-af2e-82047eab8058", "Name": "sample string 1" }, "Unit": { "UnitId": "6b24258b-9ce8-4319-a381-cde4b057a826", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8ae4d756-efff-48b7-87d5-f40eb9dde443", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-19T03:02:28.8438663-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": "5909ee22-37b4-45bb-b71d-f19b3bb8356d", "CreateDate": "2024-04-19T03:02:28.8438663-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-19T03:02:28.8438663-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }