POST PropertyTypes
Creates a new property type.
Request Information
URI Parameters
None.
Body Parameters
Property type to create. PropertyTypeId should not be filled in.
PropertyTypeName | Description | 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": "a6d43758-bfda-4e6c-84cf-c99e27c96249", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9dc13842-eab5-4d87-9097-ef5f9fcc2ed0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5c32e0a6-d323-4146-be98-d5e9ee22d632", "CreateDate": "2025-09-13T18:40:37.6694802-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:40:37.6694802-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "c0346d0a-c4ac-4ca5-bee0-cd1163b1f851", "Name": "sample string 1" }, "Unit": { "UnitId": "1c504eb0-e741-4354-9956-e0d3035c951b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eb91d22a-20f8-485d-a666-4d3d06c52165", "CreateDate": "2025-09-13T18:40:37.6694802-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:40:37.6694802-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "bdf3ab39-28f2-4595-8393-a9097991ab60", "FieldId": "1cb683b6-d1bc-4759-a27e-cf72c8014f31", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "bdf3ab39-28f2-4595-8393-a9097991ab60", "FieldId": "1cb683b6-d1bc-4759-a27e-cf72c8014f31", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "12b25ddf-660d-473a-b15e-72d335911e23", "CreateDate": "2025-09-13T18:40:37.6694802-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T18:40:37.6694802-07:00", "LastModifiedUser": "sample string 7" }
Response Information
Resource Description
On success, the created property type.
Name | Description | Type | Additional information |
---|---|---|---|
Data | PropertyType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "PropertyTypeId": "02b36880-dd84-4a83-810f-b5277d3c43b3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3164f7ed-982e-4a4e-8930-6d97a6233a20", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "5064bf49-de3b-43ed-b119-9590995ab475", "CreateDate": "2025-09-13T18:40:37.6694802-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-13T18:40:37.6694802-07:00", "LastModifiedUser": "sample string 8" }, "DataType": { "DataTypeId": "0c04d03d-0561-4b6e-a760-8bf9c7eab947", "Name": "sample string 1" }, "Unit": { "UnitId": "1f8d7e9a-b874-49c2-a8bc-ed5089180b0f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c4f6e186-b13c-4243-854a-4933ceecebd2", "CreateDate": "2025-09-13T18:40:37.6694802-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-13T18:40:37.6694802-07:00", "LastModifiedUser": "sample string 6" }, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cf22b62d-3347-430f-bb9b-eed0b1e042fc", "FieldId": "61ff269e-03bb-4719-8811-f8f880846603", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cf22b62d-3347-430f-bb9b-eed0b1e042fc", "FieldId": "61ff269e-03bb-4719-8811-f8f880846603", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "SourceSystemId": "sample string 4", "CompanyId": "0973ddc6-d608-4603-b705-cdd6fe839b9f", "CreateDate": "2025-09-13T18:40:37.6694802-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-13T18:40:37.6694802-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }