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": "37ea6cd1-992e-4f4f-9b2c-13a009b4ff5d", "Asset": { "AssetId": "9051373e-976a-4c25-b19f-cd38d99de0a4", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "0d02e523-1fbf-4b1c-9bb2-629c4b5f2451", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "beea12c6-44d5-4138-a126-64d2a5f97407", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "adac2b17-033b-4d74-8595-ad422f651c13", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "MeasurementValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5fff52bb-ebdb-4505-9163-b40d16e5aa0e", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "MeasurementValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "0d57ef85-290e-4a8f-a86f-04cb5be62e64", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "a2558e00-d78b-4ff5-acba-5f23a52274e5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0d02e523-1fbf-4b1c-9bb2-629c4b5f2451", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "beea12c6-44d5-4138-a126-64d2a5f97407", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "580a79f3-be61-4d64-8125-ce700197e846", "Section": { "FormTypeSectionId": "33f311ce-2b65-4e8d-8177-17b4a1db2c9e", "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": "c9eeab80-1b2d-44cd-855f-084062aafc98", "Name": "sample string 1" }, "Unit": { "UnitId": "e09b27e1-fa90-411b-a6be-c8177ecdc0a0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f544d148-a94f-408d-b546-6c4967ab02a6", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "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": "580a79f3-be61-4d64-8125-ce700197e846", "Section": { "FormTypeSectionId": "33f311ce-2b65-4e8d-8177-17b4a1db2c9e", "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": "c9eeab80-1b2d-44cd-855f-084062aafc98", "Name": "sample string 1" }, "Unit": { "UnitId": "e09b27e1-fa90-411b-a6be-c8177ecdc0a0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f544d148-a94f-408d-b546-6c4967ab02a6", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "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": "2a2967bf-d720-4587-82f6-df9c017b6f6e", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-09-13T21:02:56.4562034-07:00", "Location": "sample string 1", "TaskId": "e8e25b09-a670-42f7-8439-5e27ea714fec", "Values": [ { "FormFieldValueId": "96b72779-a161-4062-b4b3-687f021f0111", "FormId": "7e33f1fe-d7cf-4399-9c7d-198d2144c050", "FormTypeField": { "FormTypeFieldId": "580a79f3-be61-4d64-8125-ce700197e846", "FormType": { "FormTypeId": "a2558e00-d78b-4ff5-acba-5f23a52274e5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0d02e523-1fbf-4b1c-9bb2-629c4b5f2451", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "beea12c6-44d5-4138-a126-64d2a5f97407", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "2a2967bf-d720-4587-82f6-df9c017b6f6e", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "33f311ce-2b65-4e8d-8177-17b4a1db2c9e", "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": "c9eeab80-1b2d-44cd-855f-084062aafc98", "Name": "sample string 1" }, "Unit": { "UnitId": "e09b27e1-fa90-411b-a6be-c8177ecdc0a0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f544d148-a94f-408d-b546-6c4967ab02a6", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "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": "96b72779-a161-4062-b4b3-687f021f0111", "FormId": "7e33f1fe-d7cf-4399-9c7d-198d2144c050", "FormTypeField": { "FormTypeFieldId": "580a79f3-be61-4d64-8125-ce700197e846", "FormType": { "FormTypeId": "a2558e00-d78b-4ff5-acba-5f23a52274e5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0d02e523-1fbf-4b1c-9bb2-629c4b5f2451", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "beea12c6-44d5-4138-a126-64d2a5f97407", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-13T21:02:56.4562034-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "2a2967bf-d720-4587-82f6-df9c017b6f6e", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "33f311ce-2b65-4e8d-8177-17b4a1db2c9e", "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": "c9eeab80-1b2d-44cd-855f-084062aafc98", "Name": "sample string 1" }, "Unit": { "UnitId": "e09b27e1-fa90-411b-a6be-c8177ecdc0a0", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f544d148-a94f-408d-b546-6c4967ab02a6", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "afe9fb96-6684-4b54-8d03-0e01fedc5117", "FieldId": "d152e633-a3d5-4df2-973a-e258679863bf", "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": "0773884d-11fa-4608-bedf-c9afaef921f9", "CreateDate": "2025-09-13T21:02:56.4562034-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-13T21:02:56.4562034-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }