POST PropertyTypes

Back to endpoints

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

Name	Type	Additional 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 ValidValue	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": "e3289e9c-962a-43d5-b070-5ec92c821958",
  "Name": "sample string 1",
  "Description": "sample string 2",
  "AssetType": {
    "AssetTypeId": "1597f112-c3c7-4174-a342-675b968e8260",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsWell": true,
    "DisplayColor": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "e4c37ace-ea81-41b7-87e3-5bc1d5ef108f",
    "CreateDate": "2024-12-21T19:25:32.2024873-08:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-12-21T19:25:32.2024873-08:00",
    "LastModifiedUser": "sample string 8"
  },
  "DataType": {
    "DataTypeId": "bbd8834d-c0ba-42d2-90bd-043711573878",
    "Name": "sample string 1"
  },
  "Unit": {
    "UnitId": "ff04316e-0ac7-403a-a888-1708e5be282e",
    "Code": "sample string 1",
    "Description": "sample string 2",
    "SourceSystemId": "sample string 3",
    "CompanyId": "a86ae9d8-abbe-45fb-b3d0-4e486c94d411",
    "CreateDate": "2024-12-21T19:25:32.2024873-08:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2024-12-21T19:25:32.2024873-08:00",
    "LastModifiedUser": "sample string 6"
  },
  "MinValue": 1.0,
  "MaxValue": 1.0,
  "MinLength": 1,
  "MaxLength": 1,
  "HasValidValues": true,
  "ValidValues": [
    {
      "ValidValueId": "6d60f08f-1702-4bfe-a367-94fca6f85ffc",
      "FieldId": "84ff853f-516a-4424-b409-3357e48dc368",
      "FieldName": "sample string 1",
      "FieldLable": "sample string 2",
      "ValueText": "sample string 3",
      "LabelText": "sample string 4"
    },
    {
      "ValidValueId": "6d60f08f-1702-4bfe-a367-94fca6f85ffc",
      "FieldId": "84ff853f-516a-4424-b409-3357e48dc368",
      "FieldName": "sample string 1",
      "FieldLable": "sample string 2",
      "ValueText": "sample string 3",
      "LabelText": "sample string 4"
    }
  ],
  "SourceSystemId": "sample string 4",
  "CompanyId": "2fb296ca-2b68-4382-8a2e-cea82533364c",
  "CreateDate": "2024-12-21T19:25:32.2024873-08:00",
  "CreateUser": "sample string 6",
  "LastModifiedDate": "2024-12-21T19:25:32.2024873-08:00",
  "LastModifiedUser": "sample string 7"
}

Response Information

Resource Description

On success, the created property type.

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

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "PropertyTypeId": "9100863b-4525-4e15-a95f-19cceeb3300a",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "d345b1b7-6dda-4804-ac30-2090f493efeb",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "8c6e2327-08b7-40ba-ab92-abb2b48d1ebf",
      "CreateDate": "2024-12-21T19:25:32.2024873-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-12-21T19:25:32.2024873-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "DataType": {
      "DataTypeId": "875633e4-1188-4554-95ba-978433fd93b3",
      "Name": "sample string 1"
    },
    "Unit": {
      "UnitId": "ac345999-7024-4fd1-87be-c7ff42af84d7",
      "Code": "sample string 1",
      "Description": "sample string 2",
      "SourceSystemId": "sample string 3",
      "CompanyId": "a12c3cd9-d8fd-4875-ba4e-f61513d23052",
      "CreateDate": "2024-12-21T19:25:32.2024873-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-12-21T19:25:32.2024873-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "MinValue": 1.0,
    "MaxValue": 1.0,
    "MinLength": 1,
    "MaxLength": 1,
    "HasValidValues": true,
    "ValidValues": [
      {
        "ValidValueId": "c178b759-859d-4bbf-82b8-fd3dd8197e48",
        "FieldId": "9f582cf9-4cb6-4da1-9bb8-4fc2feab8a88",
        "FieldName": "sample string 1",
        "FieldLable": "sample string 2",
        "ValueText": "sample string 3",
        "LabelText": "sample string 4"
      },
      {
        "ValidValueId": "c178b759-859d-4bbf-82b8-fd3dd8197e48",
        "FieldId": "9f582cf9-4cb6-4da1-9bb8-4fc2feab8a88",
        "FieldName": "sample string 1",
        "FieldLable": "sample string 2",
        "ValueText": "sample string 3",
        "LabelText": "sample string 4"
      }
    ],
    "SourceSystemId": "sample string 4",
    "CompanyId": "43b1f74c-41ca-4740-9396-cc0c727c597e",
    "CreateDate": "2024-12-21T19:25:32.2024873-08:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2024-12-21T19:25:32.2024873-08:00",
    "LastModifiedUser": "sample string 7"
  },
  "Total": 1,
  "Message": "sample string 1"
}