POST FormTypes

Back to endpoints

POST FormTypes

Creates a new form type.

Request Information

URI Parameters

None.

Body Parameters

The form type to create. FormTypeId should not be filled in.

FormType

Name	Type	Additional information
FormTypeId	globally unique identifier	None.
Name	string	None.
Description	string	None.
AssetType	AssetType	None.
FrequencyNeeded	integer	None.
ValueNeededDate	date	None.
Fields	Collection of FormTypeField	None.
SourceSystemId	string	None.
CompanyId	globally unique identifier	None.
CreateDate	date	None.
CreateUser	string	None.
LastModifiedDate	date	None.
LastModifiedUser	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FormTypeId": "08daf0ae-6ab6-4f74-a60f-2573d9b83881",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "AssetType": {
    "AssetTypeId": "93cba999-4a66-43c1-a117-8d826b59bad5",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsWell": true,
    "DisplayColor": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "203f41f2-094a-432a-9eee-9dc406f5ed72",
    "CreateDate": "2023-06-04T03:07:18.4622081-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2023-06-04T03:07:18.4622081-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "FrequencyNeeded": 1,
  "ValueNeededDate": "2023-06-04T03:07:18.4622081-07:00",
  "Fields": [
    {
      "FormTypeFieldId": "e5f23323-7f93-4a38-b33e-e809a11c2251",
      "Section": {
        "FormTypeSectionId": "21168ff7-9bda-4726-a48e-4e2f4686fa59",
        "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": "99da866c-0d40-4876-918f-57a936bf0542",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "59b41cac-9812-4634-99ea-28328f46d6df",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "cec0ea0a-27ca-4e71-b706-f12f8e11672c",
        "CreateDate": "2023-06-04T03:07:18.4777457-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2023-06-04T03:07:18.4777457-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "DisplayOrder": 1,
      "MinValue": 1.0,
      "MaxValue": 1.0,
      "MinLength": 1,
      "MaxLength": 1,
      "HasValidValues": true,
      "ValidValues": [
        "sample string 1",
        "sample string 2"
      ],
      "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": "e5f23323-7f93-4a38-b33e-e809a11c2251",
      "Section": {
        "FormTypeSectionId": "21168ff7-9bda-4726-a48e-4e2f4686fa59",
        "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": "99da866c-0d40-4876-918f-57a936bf0542",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "59b41cac-9812-4634-99ea-28328f46d6df",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "cec0ea0a-27ca-4e71-b706-f12f8e11672c",
        "CreateDate": "2023-06-04T03:07:18.4777457-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2023-06-04T03:07:18.4777457-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "DisplayOrder": 1,
      "MinValue": 1.0,
      "MaxValue": 1.0,
      "MinLength": 1,
      "MaxLength": 1,
      "HasValidValues": true,
      "ValidValues": [
        "sample string 1",
        "sample string 2"
      ],
      "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 3",
  "CompanyId": "cbb7a556-a06a-4383-8b1a-7571bc56a18c",
  "CreateDate": "2023-06-04T03:07:18.4777457-07:00",
  "CreateUser": "sample string 5",
  "LastModifiedDate": "2023-06-04T03:07:18.4777457-07:00",
  "LastModifiedUser": "sample string 6"
}

Response Information

Resource Description

On success, the created form type.

Name	Type	Additional information
Data	FormType	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "FormTypeId": "c08dc9c9-21c8-49bd-931b-ee48352d9f7d",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "1b088efb-71d4-45b6-abe1-c9aeae62e875",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "3c05b387-c433-425f-a7f4-fdba826e8045",
      "CreateDate": "2023-06-04T03:07:18.493368-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2023-06-04T03:07:18.493368-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "FrequencyNeeded": 1,
    "ValueNeededDate": "2023-06-04T03:07:18.493368-07:00",
    "Fields": [
      {
        "FormTypeFieldId": "7e907632-2d94-467f-ab74-bbeef0148616",
        "Section": {
          "FormTypeSectionId": "fdbdc29d-e643-412f-b600-d0d71a98d552",
          "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": "a2d353f3-be79-488c-b937-f765f123a6cd",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "af0e2986-5113-4055-be5f-7bd6b57fdff7",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "a8eb7889-2341-46e2-a902-0e62cb692412",
          "CreateDate": "2023-06-04T03:07:18.493368-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2023-06-04T03:07:18.493368-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "DisplayOrder": 1,
        "MinValue": 1.0,
        "MaxValue": 1.0,
        "MinLength": 1,
        "MaxLength": 1,
        "HasValidValues": true,
        "ValidValues": [
          "sample string 1",
          "sample string 2"
        ],
        "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": "7e907632-2d94-467f-ab74-bbeef0148616",
        "Section": {
          "FormTypeSectionId": "fdbdc29d-e643-412f-b600-d0d71a98d552",
          "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": "a2d353f3-be79-488c-b937-f765f123a6cd",
          "Name": "sample string 1"
        },
        "Unit": {
          "UnitId": "af0e2986-5113-4055-be5f-7bd6b57fdff7",
          "Code": "sample string 1",
          "Description": "sample string 2",
          "SourceSystemId": "sample string 3",
          "CompanyId": "a8eb7889-2341-46e2-a902-0e62cb692412",
          "CreateDate": "2023-06-04T03:07:18.493368-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2023-06-04T03:07:18.493368-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "DisplayOrder": 1,
        "MinValue": 1.0,
        "MaxValue": 1.0,
        "MinLength": 1,
        "MaxLength": 1,
        "HasValidValues": true,
        "ValidValues": [
          "sample string 1",
          "sample string 2"
        ],
        "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 3",
    "CompanyId": "4d933d40-3a61-4348-a6b6-841307042cf4",
    "CreateDate": "2023-06-04T03:07:18.493368-07:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2023-06-04T03:07:18.493368-07:00",
    "LastModifiedUser": "sample string 6"
  },
  "Total": 1,
  "Message": "sample string 1"
}