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": "f814e899-30b1-4da2-886e-e5540cee4a7a", "Asset": { "AssetId": "a6145525-556d-4b7e-8406-1a0d06671b1d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "85312763-ea70-4cc0-a808-ab9795230fc2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bd27cbc1-33ca-44cd-8b84-6daf1ab8a70c", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e2dd3c88-1008-41ed-90ae-204ff0f68ac2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "MeasurementValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "SourceSystemId": "sample string 3", "CompanyId": "6ba6f823-ad09-497f-87f7-4d057e877580", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "MeasurementValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "fbed6456-fd92-43e3-986e-0edaa956fa9a", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "92f7d8a3-bfd0-4bc2-a5b5-771e02a3cf70", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "85312763-ea70-4cc0-a808-ab9795230fc2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bd27cbc1-33ca-44cd-8b84-6daf1ab8a70c", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "f00e4c7f-eba9-4e3e-b341-1c7614b6c1fb", "Section": { "FormTypeSectionId": "1fe700bc-79ff-4fe0-b68c-a90b7b21ee8f", "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": "9ce26f86-b7a3-4dbc-b1c1-4a7495560805", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc45460-5043-4c83-a973-f1ee95bc3b16", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ea911706-5744-4a62-b200-98592e3ce0ea", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "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": "f00e4c7f-eba9-4e3e-b341-1c7614b6c1fb", "Section": { "FormTypeSectionId": "1fe700bc-79ff-4fe0-b68c-a90b7b21ee8f", "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": "9ce26f86-b7a3-4dbc-b1c1-4a7495560805", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc45460-5043-4c83-a973-f1ee95bc3b16", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ea911706-5744-4a62-b200-98592e3ce0ea", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "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": "f53433ce-42c7-4c2a-97c3-5fc69639ebdc", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "EffectiveDate": "2025-10-10T14:53:58.4906415-07:00", "Location": "sample string 1", "TaskId": "72ba67ee-af53-4997-a4b7-3d6854acf02a", "Values": [ { "FormFieldValueId": "281d83c6-3035-4bf3-9ab5-892f440f46a3", "FormId": "0b38dadf-7a20-4964-aacf-cd8b8dce07bc", "FormTypeField": { "FormTypeFieldId": "f00e4c7f-eba9-4e3e-b341-1c7614b6c1fb", "FormType": { "FormTypeId": "92f7d8a3-bfd0-4bc2-a5b5-771e02a3cf70", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "85312763-ea70-4cc0-a808-ab9795230fc2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bd27cbc1-33ca-44cd-8b84-6daf1ab8a70c", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "f53433ce-42c7-4c2a-97c3-5fc69639ebdc", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "1fe700bc-79ff-4fe0-b68c-a90b7b21ee8f", "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": "9ce26f86-b7a3-4dbc-b1c1-4a7495560805", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc45460-5043-4c83-a973-f1ee95bc3b16", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ea911706-5744-4a62-b200-98592e3ce0ea", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "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": "281d83c6-3035-4bf3-9ab5-892f440f46a3", "FormId": "0b38dadf-7a20-4964-aacf-cd8b8dce07bc", "FormTypeField": { "FormTypeFieldId": "f00e4c7f-eba9-4e3e-b341-1c7614b6c1fb", "FormType": { "FormTypeId": "92f7d8a3-bfd0-4bc2-a5b5-771e02a3cf70", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "85312763-ea70-4cc0-a808-ab9795230fc2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bd27cbc1-33ca-44cd-8b84-6daf1ab8a70c", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-10T14:53:58.4906415-07:00", "Active": true, "Fields": [], "SourceSystemId": "sample string 4", "CompanyId": "f53433ce-42c7-4c2a-97c3-5fc69639ebdc", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 7" }, "Section": { "FormTypeSectionId": "1fe700bc-79ff-4fe0-b68c-a90b7b21ee8f", "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": "9ce26f86-b7a3-4dbc-b1c1-4a7495560805", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc45460-5043-4c83-a973-f1ee95bc3b16", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ea911706-5744-4a62-b200-98592e3ce0ea", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "2184c9e8-4734-47e7-b07b-1e5ac546dd8a", "FieldId": "59932550-7e2f-4cd0-a458-e42c764a6ee0", "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": "5eb3dacc-2854-4823-a906-cfde2238f774", "CreateDate": "2025-10-10T14:53:58.4906415-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-10T14:53:58.4906415-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }