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": "20c70982-f14f-4176-81f8-d5becb5d15b4",
"Asset": {
"AssetId": "9a04ae09-f6bd-48b2-b70d-ab49c55ebb53",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "48f48eea-4f94-4a05-82e1-75e33d2317b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7408dc0f-23f8-41ed-9ece-d9974cc43202",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "14d70af2-dfd4-485b-8823-2be32bbae03e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "95e92560-7258-4d00-97b7-3eeff4806d67",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"MeasurementValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a0f742e3-dce7-418b-8181-1e9450d51894",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "695e5430-22e2-420e-a293-36c663003e5e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "48f48eea-4f94-4a05-82e1-75e33d2317b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7408dc0f-23f8-41ed-9ece-d9974cc43202",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"Active": true,
"Fields": [
{
"FormTypeFieldId": "91d61ebf-dfc9-49f5-a842-3fad45a147fd",
"Section": {
"FormTypeSectionId": "91955c54-9eb6-4292-b4a8-71e7e5acf249",
"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": "3553246a-16af-4408-a9fd-28992479e51e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "84e25c15-8c72-4098-b762-b19267070c55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8b9e4f12-d91c-420a-91fe-c6c50cb71ac4",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"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": "91d61ebf-dfc9-49f5-a842-3fad45a147fd",
"Section": {
"FormTypeSectionId": "91955c54-9eb6-4292-b4a8-71e7e5acf249",
"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": "3553246a-16af-4408-a9fd-28992479e51e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "84e25c15-8c72-4098-b762-b19267070c55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8b9e4f12-d91c-420a-91fe-c6c50cb71ac4",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"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": "2d40e8ab-7b7b-4b3c-903c-82f87e73bead",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"EffectiveDate": "2026-09-22T03:30:40.6811192-07:00",
"Location": "sample string 1",
"TaskId": "abfc103f-bd79-401d-9671-9f62eb3cc5eb",
"Values": [
{
"FormFieldValueId": "718c4dfc-4c04-4e67-994c-afaa12aee5a8",
"FormId": "ac835782-455b-4b2a-a0ac-dd5cff8f5d84",
"FormTypeField": {
"FormTypeFieldId": "91d61ebf-dfc9-49f5-a842-3fad45a147fd",
"FormType": {
"FormTypeId": "695e5430-22e2-420e-a293-36c663003e5e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "48f48eea-4f94-4a05-82e1-75e33d2317b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7408dc0f-23f8-41ed-9ece-d9974cc43202",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "2d40e8ab-7b7b-4b3c-903c-82f87e73bead",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "91955c54-9eb6-4292-b4a8-71e7e5acf249",
"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": "3553246a-16af-4408-a9fd-28992479e51e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "84e25c15-8c72-4098-b762-b19267070c55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8b9e4f12-d91c-420a-91fe-c6c50cb71ac4",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"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": "718c4dfc-4c04-4e67-994c-afaa12aee5a8",
"FormId": "ac835782-455b-4b2a-a0ac-dd5cff8f5d84",
"FormTypeField": {
"FormTypeFieldId": "91d61ebf-dfc9-49f5-a842-3fad45a147fd",
"FormType": {
"FormTypeId": "695e5430-22e2-420e-a293-36c663003e5e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "48f48eea-4f94-4a05-82e1-75e33d2317b2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7408dc0f-23f8-41ed-9ece-d9974cc43202",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-09-22T03:30:40.6811192-07:00",
"Active": true,
"Fields": [],
"SourceSystemId": "sample string 4",
"CompanyId": "2d40e8ab-7b7b-4b3c-903c-82f87e73bead",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 7"
},
"Section": {
"FormTypeSectionId": "91955c54-9eb6-4292-b4a8-71e7e5acf249",
"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": "3553246a-16af-4408-a9fd-28992479e51e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "84e25c15-8c72-4098-b762-b19267070c55",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8b9e4f12-d91c-420a-91fe-c6c50cb71ac4",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"FieldName": "sample string 1",
"FieldLabel": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "bd7c29db-a9e2-4310-8f17-ae55c3302a9d",
"FieldId": "7c0b5e76-5ef0-4b82-92ef-de6df7245842",
"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": "2081007e-b506-4edb-bd5b-4b6da26ed550",
"CreateDate": "2026-09-22T03:30:40.6811192-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-22T03:30:40.6811192-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}