GET Forms?formId={formId}

Retrieves a form by its Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formId

Id of the form

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

On success, the form.

NameDescriptionTypeAdditional information
Data

Form

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "FormId": "416e8fba-80cc-4b79-be67-62e7649e25d0",
    "Asset": {
      "AssetId": "612a5659-2d55-4016-943f-22a94a1ea1d9",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "81cb3d3a-47b0-465a-8fe6-640cf488068c",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayColor": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "c0d13a84-5a7b-46ab-9751-8384d546a3b8",
        "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
        "CreateUser": "sample string 6",
        "CreateMachine": "sample string 7",
        "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
        "LastModifiedUser": "sample string 8",
        "LastModifiedMachine": "sample string 9"
      },
      "AssetGroup": {
        "AssetGroupId": "a1fbf75f-0d57-4894-ae11-a9cee7edb3b0",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2021-04-17T07:24:05.3360737-07:00",
        "MeasurementValueNeededDate": "2021-04-17T07:24:05.3360737-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "0bf016fa-6660-4b0d-a632-569e6482820b",
        "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
        "CreateUser": "sample string 5",
        "CreateMachine": "sample string 6",
        "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
        "LastModifiedUser": "sample string 7",
        "LastModifiedMachine": "sample string 8"
      },
      "ParentAsset": null,
      "WellKnownText": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "FormValueNeededDate": "2021-04-17T07:24:05.3360737-07:00",
      "MeasurementValueNeededDate": "2021-04-17T07:24:05.3360737-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "cd59e1eb-b1dd-4a11-a31f-9299e95943e3",
      "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
      "CreateUser": "sample string 7",
      "CreateMachine": "sample string 8",
      "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
      "LastModifiedUser": "sample string 9",
      "LastModifiedMachine": "sample string 10"
    },
    "FormType": {
      "FormTypeId": "6c140738-0c7b-445a-9b13-ade9b0b9f06b",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AssetType": {
        "AssetTypeId": "81cb3d3a-47b0-465a-8fe6-640cf488068c",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "DisplayColor": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "c0d13a84-5a7b-46ab-9751-8384d546a3b8",
        "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
        "CreateUser": "sample string 6",
        "CreateMachine": "sample string 7",
        "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
        "LastModifiedUser": "sample string 8",
        "LastModifiedMachine": "sample string 9"
      },
      "FrequencyNeeded": 1,
      "ValueNeededDate": "2021-04-17T07:24:05.3360737-07:00",
      "Fields": [
        {
          "FormTypeFieldId": "9dc08e63-9fdc-4563-a43c-3f86b439f894",
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "b2a885a3-790e-488e-bab1-5ca562b5c760",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "d376647c-4cea-478a-9b19-27cee9b0e751",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "672aa1a0-2cfa-4685-893c-1c664f232aac",
            "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            "sample string 1",
            "sample string 2"
          ],
          "Expression": "sample string 5",
          "IsRequired": true,
          "IsAttachment": true,
          "DefaultValue": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "SourceSystemId": "sample string 11"
        },
        {
          "FormTypeFieldId": "9dc08e63-9fdc-4563-a43c-3f86b439f894",
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "b2a885a3-790e-488e-bab1-5ca562b5c760",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "d376647c-4cea-478a-9b19-27cee9b0e751",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "672aa1a0-2cfa-4685-893c-1c664f232aac",
            "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            "sample string 1",
            "sample string 2"
          ],
          "Expression": "sample string 5",
          "IsRequired": true,
          "IsAttachment": true,
          "DefaultValue": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "SourceSystemId": "sample string 11"
        }
      ],
      "SourceSystemId": "sample string 3",
      "CompanyId": "894be87d-205b-484d-8ebd-1e5a1ffafc4c",
      "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
      "CreateUser": "sample string 5",
      "CreateMachine": "sample string 6",
      "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
      "LastModifiedUser": "sample string 7",
      "LastModifiedMachine": "sample string 8"
    },
    "EffectiveDate": "2021-04-17T07:24:05.3360737-07:00",
    "WellKnownText": "sample string 1",
    "Values": [
      {
        "FormFieldValueId": "0ac85dfd-88ec-4e14-a75d-4bd1aafad930",
        "FormTypeField": {
          "FormTypeFieldId": "9dc08e63-9fdc-4563-a43c-3f86b439f894",
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "b2a885a3-790e-488e-bab1-5ca562b5c760",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "d376647c-4cea-478a-9b19-27cee9b0e751",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "672aa1a0-2cfa-4685-893c-1c664f232aac",
            "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            "sample string 1",
            "sample string 2"
          ],
          "Expression": "sample string 5",
          "IsRequired": true,
          "IsAttachment": true,
          "DefaultValue": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "SourceSystemId": "sample string 11"
        },
        "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": "0ac85dfd-88ec-4e14-a75d-4bd1aafad930",
        "FormTypeField": {
          "FormTypeFieldId": "9dc08e63-9fdc-4563-a43c-3f86b439f894",
          "Name": "sample string 1",
          "Label": "sample string 2",
          "Description": "sample string 3",
          "DataType": {
            "DataTypeId": "b2a885a3-790e-488e-bab1-5ca562b5c760",
            "Name": "sample string 1"
          },
          "Unit": {
            "UnitId": "d376647c-4cea-478a-9b19-27cee9b0e751",
            "Code": "sample string 1",
            "Description": "sample string 2",
            "SourceSystemId": "sample string 3",
            "CompanyId": "672aa1a0-2cfa-4685-893c-1c664f232aac",
            "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
            "CreateUser": "sample string 5",
            "CreateMachine": "sample string 6",
            "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
            "LastModifiedUser": "sample string 7",
            "LastModifiedMachine": "sample string 8"
          },
          "DisplayOrder": 1,
          "MinValue": 1.0,
          "MaxValue": 1.0,
          "MinLength": 1,
          "MaxLength": 1,
          "HasValidValues": true,
          "ValidValues": [
            "sample string 1",
            "sample string 2"
          ],
          "Expression": "sample string 5",
          "IsRequired": true,
          "IsAttachment": true,
          "DefaultValue": "sample string 8",
          "IsAccumulator": true,
          "IsMultiline": true,
          "SourceSystemId": "sample string 11"
        },
        "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": "503b27ce-5dd6-4f3a-ae5d-ac85afacc581",
    "CreateDate": "2021-04-17T07:24:05.3360737-07:00",
    "CreateUser": "sample string 4",
    "CreateMachine": "sample string 5",
    "LastModifiedDate": "2021-04-17T07:24:05.3360737-07:00",
    "LastModifiedUser": "sample string 6",
    "LastModifiedMachine": "sample string 7"
  },
  "Total": 1,
  "Message": "sample string 1"
}