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": "2e39794a-34ee-43c9-83c7-305fbf242832", "Asset": { "AssetId": "96c5becf-5898-46d4-8f6b-f83d060509a4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d52d9f85-7931-4f34-82b3-6e47176af808", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bdfac1ee-92c4-4d6c-87b9-7f40024f0e6f", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:19:59.8506696-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "520d2cc2-1713-4a3b-9de0-7529d756a046", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T15:19:59.8506696-07:00", "MeasurementValueNeededDate": "2024-10-10T15:19:59.8506696-07:00", "SourceSystemId": "sample string 3", "CompanyId": "fbfefb82-55b2-4f60-9006-78aac0378253", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:19:59.8506696-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T15:19:59.8506696-07:00", "MeasurementValueNeededDate": "2024-10-10T15:19:59.8506696-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "0ff5aedc-cdee-49e1-9f20-16aba726ba8c", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T15:19:59.8506696-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "115f3103-5251-4943-933e-c20561713ab1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d52d9f85-7931-4f34-82b3-6e47176af808", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bdfac1ee-92c4-4d6c-87b9-7f40024f0e6f", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:19:59.8506696-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T15:19:59.8506696-07:00", "Fields": [ { "FormTypeFieldId": "c92470d6-6287-47ba-aa46-d8691d925c44", "Section": { "FormTypeSectionId": "af119107-98cf-453b-ad7e-45eaa3a01225", "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": "77cbc130-d8e9-4423-a3d2-92703694549b", "Name": "sample string 1" }, "Unit": { "UnitId": "24d96475-60ea-4d53-aeab-f740f230e7d4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31295f60-371f-467c-87fd-c6e296923efd", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:19:59.8506696-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": "c92470d6-6287-47ba-aa46-d8691d925c44", "Section": { "FormTypeSectionId": "af119107-98cf-453b-ad7e-45eaa3a01225", "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": "77cbc130-d8e9-4423-a3d2-92703694549b", "Name": "sample string 1" }, "Unit": { "UnitId": "24d96475-60ea-4d53-aeab-f740f230e7d4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31295f60-371f-467c-87fd-c6e296923efd", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:19:59.8506696-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": "14209c9f-2b8d-4285-84ea-f5cf5d2628af", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:19:59.8506696-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T15:19:59.8506696-07:00", "Location": "sample string 1", "TaskId": "10c16dfd-0946-436b-8c05-41ece2117d94", "Values": [ { "FormFieldValueId": "34869770-60f0-4c57-b570-2a27acde0203", "FormTypeField": { "FormTypeFieldId": "c92470d6-6287-47ba-aa46-d8691d925c44", "Section": { "FormTypeSectionId": "af119107-98cf-453b-ad7e-45eaa3a01225", "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": "77cbc130-d8e9-4423-a3d2-92703694549b", "Name": "sample string 1" }, "Unit": { "UnitId": "24d96475-60ea-4d53-aeab-f740f230e7d4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31295f60-371f-467c-87fd-c6e296923efd", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:19:59.8506696-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": "34869770-60f0-4c57-b570-2a27acde0203", "FormTypeField": { "FormTypeFieldId": "c92470d6-6287-47ba-aa46-d8691d925c44", "Section": { "FormTypeSectionId": "af119107-98cf-453b-ad7e-45eaa3a01225", "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": "77cbc130-d8e9-4423-a3d2-92703694549b", "Name": "sample string 1" }, "Unit": { "UnitId": "24d96475-60ea-4d53-aeab-f740f230e7d4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "31295f60-371f-467c-87fd-c6e296923efd", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:19:59.8506696-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": "cab716b9-4aca-4a20-8a20-758205f5d55d", "CreateDate": "2024-10-10T15:19:59.8506696-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T15:19:59.8506696-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }