GET FormTypes?formTypeId={formTypeId}

Retrieves a form type by its Id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
formTypeId

Id of the form type

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

On success, the form type.

NameDescriptionTypeAdditional information
Data

FormType

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "FormTypeId": "03698c59-7ce7-4de8-80e9-c13bc73098c7",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "cce91b78-837b-4b76-827f-1bbbcb006065",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayColor": "sample string 3",
      "SourceSystemId": "sample string 4",
      "CompanyId": "6357f3a2-3ae1-4f38-9aa8-6c916e0edf25",
      "CreateDate": "2021-04-17T08:10:59.0976873-07:00",
      "CreateUser": "sample string 6",
      "CreateMachine": "sample string 7",
      "LastModifiedDate": "2021-04-17T08:10:59.0976873-07:00",
      "LastModifiedUser": "sample string 8",
      "LastModifiedMachine": "sample string 9"
    },
    "FrequencyNeeded": 1,
    "ValueNeededDate": "2021-04-17T08:10:59.0976873-07:00",
    "Fields": [
      {
        "FormTypeFieldId": "d400b65f-4b19-4227-aba5-49808c2ddd6c",
        "Name": "sample string 1",
        "Label": "sample string 2",
        "Description": "sample string 3",
        "DataType": {
          "DataTypeId": "7f995e37-7153-400e-8d64-ae1c4ec57952",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "cd783456-1266-46b6-a0e2-e5c46f326039",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "480fc6ef-88ee-43b6-ae3f-0213a855839f",
          "CreateDate": "2021-04-17T08:10:59.0976873-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T08:10:59.0976873-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": "d400b65f-4b19-4227-aba5-49808c2ddd6c",
        "Name": "sample string 1",
        "Label": "sample string 2",
        "Description": "sample string 3",
        "DataType": {
          "DataTypeId": "7f995e37-7153-400e-8d64-ae1c4ec57952",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "cd783456-1266-46b6-a0e2-e5c46f326039",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "480fc6ef-88ee-43b6-ae3f-0213a855839f",
          "CreateDate": "2021-04-17T08:10:59.0976873-07:00",
          "CreateUser": "sample string 5",
          "CreateMachine": "sample string 6",
          "LastModifiedDate": "2021-04-17T08:10:59.0976873-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": "bb50491f-491a-45d8-96b1-da206a5c2fc1",
    "CreateDate": "2021-04-17T08:10:59.0976873-07:00",
    "CreateUser": "sample string 5",
    "CreateMachine": "sample string 6",
    "LastModifiedDate": "2021-04-17T08:10:59.0976873-07:00",
    "LastModifiedUser": "sample string 7",
    "LastModifiedMachine": "sample string 8"
  },
  "Total": 1,
  "Message": "sample string 1"
}