POST Properties

Back to endpoints

POST Properties

Creates a new property.

Request Information

URI Parameters

None.

Body Parameters

Property to be created. PropertyId should not be filled in.

Property

Name	Type	Additional information
PropertyId	globally unique identifier	None.
Asset	Asset	None.
ValueText	string	None.
DisplayText	string	None.
PropertyType	PropertyType	None.
IsValid	boolean	None.
IsValidMessage	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:

{
  "PropertyId": "26cdfe4c-699a-4364-8fd5-c54b5e4dd038",
  "Asset": {
    "AssetId": "2c34830d-ed63-4792-93e2-4d2ca1d1d339",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "8e180b73-44f2-4943-9a2a-c3cc6339133f",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "dfe5b5c0-b4f2-4275-ae3f-98fd712025f9",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "032ad1ef-4fb8-4539-b050-cfb3ca17f5db",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
      "MeasurementValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "03117210-337a-41bb-ae6a-ecffc5f1ef55",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "State": {
      "StateId": "f32f5cdb-bd0e-4309-a73d-553845a8d4f4",
      "EffectiveDate": "2025-04-17T04:23:58.0002794-07:00",
      "StateType": {
        "StateTypeId": "c6b3922d-e419-4984-a78f-6f8c7e1c8f59",
        "Name": "sample string 1",
        "IsOperational": true,
        "AssetType": {
          "AssetTypeId": "8e180b73-44f2-4943-9a2a-c3cc6339133f",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "dfe5b5c0-b4f2-4275-ae3f-98fd712025f9",
          "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 3",
        "CompanyId": "6bea9a0e-9f4e-4568-9067-7aee655c1412",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "9a123351-d17b-4840-b909-d6cae15a1dc9",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "Status": {
      "StatusId": "620daced-6f13-4600-b21a-8ea0690de143",
      "EffectiveDate": "2025-04-17T04:23:58.0002794-07:00",
      "StatusType": {
        "StatusTypeId": "52655586-30e5-4d84-b3ed-0cf372302787",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "8e180b73-44f2-4943-9a2a-c3cc6339133f",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "dfe5b5c0-b4f2-4275-ae3f-98fd712025f9",
          "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "8061126f-04c4-4de4-83d5-03c9a8813651",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "8eccc815-b22f-4866-89bf-9e42e14fb420",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "WellPurpose": {
      "WellPurposeId": "ec76daf0-70b1-4603-92b9-6c0cac649605",
      "EffectiveDate": "2025-04-17T04:23:58.0002794-07:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "b4093cc8-1eb6-4b1a-af18-40006069fe9b",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "375a5c09-862c-447e-9465-332df8b32fca",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "ae121ca0-8b1b-4cba-b9aa-18dff7b36dbf",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
    "MeasurementValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "a5daff8e-4085-4ee5-a9e2-43e914c42954",
    "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "ValueText": "sample string 1",
  "DisplayText": "sample string 2",
  "PropertyType": {
    "PropertyTypeId": "ff7964e0-1691-4f00-a9ab-665519e60423",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "8e180b73-44f2-4943-9a2a-c3cc6339133f",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "dfe5b5c0-b4f2-4275-ae3f-98fd712025f9",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "DataType": {
      "DataTypeId": "f1810a41-6a2b-434a-9538-0d1dd83284b4",
      "Name": "sample string 1"
    },
    "Unit": {
      "UnitId": "7eabec62-8e40-4fad-a355-4fe12d0534f7",
      "Code": "sample string 1",
      "Description": "sample string 2",
      "SourceSystemId": "sample string 3",
      "CompanyId": "90969097-7454-42fc-bed6-36d5d917a9bd",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "MinValue": 1.0,
    "MaxValue": 1.0,
    "MinLength": 1,
    "MaxLength": 1,
    "HasValidValues": true,
    "ValidValues": [
      {
        "ValidValueId": "9ed442da-2609-4132-b036-c39d86a43c29",
        "FieldId": "1255b225-acba-4710-980c-8554792e8459",
        "FieldName": "sample string 1",
        "FieldLable": "sample string 2",
        "ValueText": "sample string 3",
        "LabelText": "sample string 4"
      },
      {
        "ValidValueId": "9ed442da-2609-4132-b036-c39d86a43c29",
        "FieldId": "1255b225-acba-4710-980c-8554792e8459",
        "FieldName": "sample string 1",
        "FieldLable": "sample string 2",
        "ValueText": "sample string 3",
        "LabelText": "sample string 4"
      }
    ],
    "SourceSystemId": "sample string 4",
    "CompanyId": "ed836c56-93ad-4205-b882-a9c212954534",
    "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
    "LastModifiedUser": "sample string 7"
  },
  "IsValid": true,
  "IsValidMessage": "sample string 4",
  "SourceSystemId": "sample string 5",
  "CompanyId": "f15bf01f-295a-4d41-b588-0d418e4b07ef",
  "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
  "CreateUser": "sample string 7",
  "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
  "LastModifiedUser": "sample string 8"
}

Response Information

Resource Description

On success, the created property.

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

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "PropertyId": "863d69f7-3611-45e3-bf9e-dd57a7760339",
    "Asset": {
      "AssetId": "a6ad0a7b-abe3-426a-a1c4-9b92d5987576",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "66783e81-0f0b-480b-b854-edf7bc7e2d33",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "f648f560-af0b-4c94-8841-0a1a3839556f",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "d1ca114c-9855-480e-9155-277f7259d393",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
        "MeasurementValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "1242e09e-ba32-419d-b2ac-26dcfca2c51c",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "bfce4520-f507-45b7-8ce4-925a0fb41be2",
        "EffectiveDate": "2025-04-17T04:23:58.0002794-07:00",
        "StateType": {
          "StateTypeId": "d5bc11b2-d1bd-455a-b2f2-1fa72995ce0e",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "66783e81-0f0b-480b-b854-edf7bc7e2d33",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "f648f560-af0b-4c94-8841-0a1a3839556f",
            "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "536c2247-265d-4bbb-a495-87c151b6deb1",
          "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "0725e8c1-a678-4fbc-a0b0-b3e8aac15016",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "64070ddd-db73-49fa-b405-d455915457ec",
        "EffectiveDate": "2025-04-17T04:23:58.0002794-07:00",
        "StatusType": {
          "StatusTypeId": "e3cb1619-b025-4b79-95c4-35508a28df72",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "66783e81-0f0b-480b-b854-edf7bc7e2d33",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "f648f560-af0b-4c94-8841-0a1a3839556f",
            "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "0c297c6e-d859-4ef1-9e17-60687fcc0526",
          "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "0e61d681-22ef-41ea-9326-f5e6f8f39f37",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "9bf34a76-6cf4-43d6-8366-1ec7cefa25b0",
        "EffectiveDate": "2025-04-17T04:23:58.0002794-07:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "e0213b26-6946-4733-ba05-93da061da2d7",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "041fe931-63e2-44b5-84e9-88dd32a5c5c3",
          "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "9a351b5a-b857-4e51-89e7-1535024d822e",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
      "MeasurementValueNeededDate": "2025-04-17T04:23:58.0002794-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "6391042e-4da9-4df1-a2ad-8770a4947e13",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "ValueText": "sample string 1",
    "DisplayText": "sample string 2",
    "PropertyType": {
      "PropertyTypeId": "d0e599c6-39dc-45e4-b72e-032f9c2f81f7",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AssetType": {
        "AssetTypeId": "66783e81-0f0b-480b-b854-edf7bc7e2d33",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "f648f560-af0b-4c94-8841-0a1a3839556f",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "DataType": {
        "DataTypeId": "c9511ee8-6512-48c6-967d-e98dae3d1be0",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "ee165bb3-826c-4373-b2e6-51e346d7ad05",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "76d4afaf-9b67-408c-8ac2-c1ea4fc19d21",
        "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "MinValue": 1.0,
      "MaxValue": 1.0,
      "MinLength": 1,
      "MaxLength": 1,
      "HasValidValues": true,
      "ValidValues": [
        {
          "ValidValueId": "8fe80a32-e3c4-478e-8d5c-0f5faf8d7230",
          "FieldId": "3e3a0788-cf3f-425e-be27-c56850468c1b",
          "FieldName": "sample string 1",
          "FieldLable": "sample string 2",
          "ValueText": "sample string 3",
          "LabelText": "sample string 4"
        },
        {
          "ValidValueId": "8fe80a32-e3c4-478e-8d5c-0f5faf8d7230",
          "FieldId": "3e3a0788-cf3f-425e-be27-c56850468c1b",
          "FieldName": "sample string 1",
          "FieldLable": "sample string 2",
          "ValueText": "sample string 3",
          "LabelText": "sample string 4"
        }
      ],
      "SourceSystemId": "sample string 4",
      "CompanyId": "8ac99adf-416b-42a0-aef0-8f7fd723c1dd",
      "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
      "LastModifiedUser": "sample string 7"
    },
    "IsValid": true,
    "IsValidMessage": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "62909505-bc93-49fa-a877-864781c2de3b",
    "CreateDate": "2025-04-17T04:23:58.0002794-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2025-04-17T04:23:58.0002794-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "Total": 1,
  "Message": "sample string 1"
}