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": "14755a2d-1b51-4cdc-b321-a031e238b311",
"Asset": {
"AssetId": "f2c2a930-b996-4a2b-b5ea-7eedeae0ccc0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fad666e2-90ce-414c-8c31-61051cd64f68",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "01dcd8de-ccb3-4eec-9078-72d37c421921",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "84572338-9cd0-4e7c-a282-03a4ec6b3873",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "638e77d7-9560-4261-a457-f87f8206d37e",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"MeasurementValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "de27a4de-482a-44ff-a690-290b68431dc2",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "452621c3-6a2f-4e0e-9fe6-034c1cf93576",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fad666e2-90ce-414c-8c31-61051cd64f68",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "01dcd8de-ccb3-4eec-9078-72d37c421921",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "49f07834-c626-4118-8cca-93c257bb2f75",
"Section": {
"FormTypeSectionId": "fb2811da-55f0-44be-97ca-18db7fb52c35",
"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": "73a98d88-ebd5-4a3d-b65c-4f505a8c8a63",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f7247da5-cf10-43ab-9c0b-6bd899206f9b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4f20cca-4cc3-4922-a4f6-575a0775b44a",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"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": "49f07834-c626-4118-8cca-93c257bb2f75",
"Section": {
"FormTypeSectionId": "fb2811da-55f0-44be-97ca-18db7fb52c35",
"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": "73a98d88-ebd5-4a3d-b65c-4f505a8c8a63",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f7247da5-cf10-43ab-9c0b-6bd899206f9b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4f20cca-4cc3-4922-a4f6-575a0775b44a",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"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": "e62c164e-d4b2-437e-ad63-e13979a36a1e",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-04-27T20:32:09.85765-07:00",
"Location": "sample string 1",
"TaskId": "8bc04d58-7867-4229-8efb-fc62486e7cd2",
"Values": [
{
"FormFieldValueId": "cae30451-5b8e-404b-bee1-90b7def8cc9e",
"FormId": "e1da671a-9395-465c-afc2-55d34e51dc70",
"FormTypeField": {
"FormTypeFieldId": "49f07834-c626-4118-8cca-93c257bb2f75",
"FormType": {
"FormTypeId": "452621c3-6a2f-4e0e-9fe6-034c1cf93576",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fad666e2-90ce-414c-8c31-61051cd64f68",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "01dcd8de-ccb3-4eec-9078-72d37c421921",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "e62c164e-d4b2-437e-ad63-e13979a36a1e",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "fb2811da-55f0-44be-97ca-18db7fb52c35",
"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": "73a98d88-ebd5-4a3d-b65c-4f505a8c8a63",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f7247da5-cf10-43ab-9c0b-6bd899206f9b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4f20cca-4cc3-4922-a4f6-575a0775b44a",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"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": "cae30451-5b8e-404b-bee1-90b7def8cc9e",
"FormId": "e1da671a-9395-465c-afc2-55d34e51dc70",
"FormTypeField": {
"FormTypeFieldId": "49f07834-c626-4118-8cca-93c257bb2f75",
"FormType": {
"FormTypeId": "452621c3-6a2f-4e0e-9fe6-034c1cf93576",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "fad666e2-90ce-414c-8c31-61051cd64f68",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "01dcd8de-ccb3-4eec-9078-72d37c421921",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-04-27T20:32:09.85765-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "e62c164e-d4b2-437e-ad63-e13979a36a1e",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "fb2811da-55f0-44be-97ca-18db7fb52c35",
"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": "73a98d88-ebd5-4a3d-b65c-4f505a8c8a63",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f7247da5-cf10-43ab-9c0b-6bd899206f9b",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e4f20cca-4cc3-4922-a4f6-575a0775b44a",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "e9b7e47c-5016-4c5c-b0c4-b82e00823dd4",
"FieldId": "488bf2c3-2be9-4793-af07-aa6d82d6f35d",
"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": "371b0ea2-9b0f-4905-b1b7-8af8bbcc542d",
"CreateDate": "2026-04-27T20:32:09.85765-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-27T20:32:09.85765-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}