POST PropertyTypes

Creates a new property type.

Request Information

URI Parameters

None.

Body Parameters

Property type to create. PropertyTypeId should not be filled in.

PropertyType
NameDescriptionTypeAdditional information
PropertyTypeId

globally unique identifier

None.

Name

string

None.

Description

string

None.

AssetType

AssetType

None.

DataType

DataType

None.

Unit

Unit

None.

MinValue

decimal number

None.

MaxValue

decimal number

None.

MinLength

integer

None.

MaxLength

integer

None.

HasValidValues

boolean

None.

ValidValues

Collection of string

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:
{
  "PropertyTypeId": "e43ef1e5-10f7-4380-b5bc-ac215b1b3adb",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "AssetType": {
    "AssetTypeId": "9f0e53db-6b9b-48a5-a691-eef32fc5bc20",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsWell": true,
    "DisplayColor": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "86cc5a9d-d1d6-4e1e-9fda-72866ee2b3cd",
    "CreateDate": "2024-03-27T20:23:11.441195-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-03-27T20:23:11.441195-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "DataType": {
    "DataTypeId": "e44bb7c9-afa2-4921-acbb-3df040c334cc",
    "Name": "sample string 1"
  },
  "Unit": {
    "UnitId": "0c170b4c-b7d5-40b1-809f-1de414d3742b",
    "Code": "sample string 1",
    "Description": "sample string 2",
    "SourceSystemId": "sample string 3",
    "CompanyId": "fa6e8672-cf9d-4b29-902e-d8b912361051",
    "CreateDate": "2024-03-27T20:23:11.441195-07:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2024-03-27T20:23:11.441195-07:00",
    "LastModifiedUser": "sample string 6"
  },
  "MinValue": 1.0,
  "MaxValue": 1.0,
  "MinLength": 1,
  "MaxLength": 1,
  "HasValidValues": true,
  "ValidValues": [
    "sample string 1",
    "sample string 2"
  ],
  "SourceSystemId": "sample string 4",
  "CompanyId": "7c218dab-9247-4ade-9140-ab98d1d5a1ae",
  "CreateDate": "2024-03-27T20:23:11.441195-07:00",
  "CreateUser": "sample string 6",
  "LastModifiedDate": "2024-03-27T20:23:11.441195-07:00",
  "LastModifiedUser": "sample string 7"
}

Response Information

Resource Description

On success, the created property type.

NameDescriptionTypeAdditional information
Data

PropertyType

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PropertyTypeId": "c99cd337-4be3-49b3-bcec-bee1012c392d",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "3ecf0bd8-1bd8-4c22-b3e9-2ff9edec9b77",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "20c3dd49-f108-45eb-9938-f9cd0b34a5ce",
      "CreateDate": "2024-03-27T20:23:11.441195-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-03-27T20:23:11.441195-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "DataType": {
      "DataTypeId": "7b639aaf-7ae6-4d5b-8e0b-dd6c03c474ff",
      "Name": "sample string 1"
    },
    "Unit": {
      "UnitId": "e5494469-d262-4b74-9e3f-42ae8cf87e51",
      "Code": "sample string 1",
      "Description": "sample string 2",
      "SourceSystemId": "sample string 3",
      "CompanyId": "e5f18d49-eb66-4642-a48b-427de8789f99",
      "CreateDate": "2024-03-27T20:23:11.441195-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-03-27T20:23:11.441195-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "MinValue": 1.0,
    "MaxValue": 1.0,
    "MinLength": 1,
    "MaxLength": 1,
    "HasValidValues": true,
    "ValidValues": [
      "sample string 1",
      "sample string 2"
    ],
    "SourceSystemId": "sample string 4",
    "CompanyId": "b42fc57f-9625-4bba-bc75-4d90f86ccf6d",
    "CreateDate": "2024-03-27T20:23:11.441195-07:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2024-03-27T20:23:11.441195-07:00",
    "LastModifiedUser": "sample string 7"
  },
  "Total": 1,
  "Message": "sample string 1"
}