POST Properties

Creates a new property.

Request Information

URI Parameters

None.

Body Parameters

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

Property
NameDescriptionTypeAdditional 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": "9ba63b3e-80c3-4e8a-a1a8-bfbf42d3e307",
  "Asset": {
    "AssetId": "1dc929d4-c729-4c14-9ed9-cdab00278508",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "081c6e0b-c0e6-45eb-80ce-7c1a38844de7",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "63166330-38b5-4b1e-8766-4f177c72a7c7",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "8d76eb5c-94cb-45b4-bdb4-a88ccfc0fe7a",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
      "MeasurementValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "9952c0c8-6914-4377-b52e-863201af1b05",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "State": {
      "StateId": "3bcd9275-7cc7-4672-ae5e-858ae0f0e305",
      "EffectiveDate": "2024-11-21T04:54:16.282075-08:00",
      "StateType": {
        "StateTypeId": "ca4a7f4b-b957-4aef-81d3-f4b11c6699bf",
        "Name": "sample string 1",
        "IsOperational": true,
        "AssetType": {
          "AssetTypeId": "081c6e0b-c0e6-45eb-80ce-7c1a38844de7",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "63166330-38b5-4b1e-8766-4f177c72a7c7",
          "CreateDate": "2024-11-21T04:54:16.282075-08:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 3",
        "CompanyId": "d131ef69-5cd3-49a6-adce-af1871a4923a",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "95fb31ea-6725-4b44-9e78-767a7099bddc",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "Status": {
      "StatusId": "62524a4d-d8dc-4d00-8d48-cca5a2783a5a",
      "EffectiveDate": "2024-11-21T04:54:16.282075-08:00",
      "StatusType": {
        "StatusTypeId": "9b187300-02bd-48f9-9f16-9bb8f85c20b6",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "081c6e0b-c0e6-45eb-80ce-7c1a38844de7",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "63166330-38b5-4b1e-8766-4f177c72a7c7",
          "CreateDate": "2024-11-21T04:54:16.282075-08:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "732caa3d-45ab-4761-90a0-1c29adf3e1ad",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "bd03c195-6918-4042-8a62-8283ba9208a5",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "WellPurpose": {
      "WellPurposeId": "a3e43330-0d8f-4c3e-b9b7-93d347141722",
      "EffectiveDate": "2024-11-21T04:54:16.282075-08:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "8cab120f-8c52-4e31-9d1b-4b650788f049",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "cfc1fc56-9249-4f1c-bc33-40ae3c8a69fe",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "b7af0fc6-234f-4696-9db2-5103bd6a2b7c",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
    "MeasurementValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "43d8805e-2517-4756-978e-082f26280503",
    "CreateDate": "2024-11-21T04:54:16.282075-08:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
    "LastModifiedUser": "sample string 8"
  },
  "ValueText": "sample string 1",
  "DisplayText": "sample string 2",
  "PropertyType": {
    "PropertyTypeId": "7f27ca22-4f8c-4262-b003-1c5c663ba083",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "AssetType": {
      "AssetTypeId": "081c6e0b-c0e6-45eb-80ce-7c1a38844de7",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "63166330-38b5-4b1e-8766-4f177c72a7c7",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "DataType": {
      "DataTypeId": "40363ce0-1566-4731-9001-30eadfd6d91b",
      "Name": "sample string 1"
    },
    "Unit": {
      "UnitId": "b967ad46-8ba9-42ee-a144-9d7d1b122537",
      "Code": "sample string 1",
      "Description": "sample string 2",
      "SourceSystemId": "sample string 3",
      "CompanyId": "46f35a03-23c8-4533-b3fe-bd36eb1600f7",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 6"
    },
    "MinValue": 1.0,
    "MaxValue": 1.0,
    "MinLength": 1,
    "MaxLength": 1,
    "HasValidValues": true,
    "ValidValues": [
      {
        "ValidValueId": "8a8558c6-9050-4c6b-b6e6-702497b3e3e5",
        "FieldId": "d468fedf-6693-4a10-85c1-ff9828bec0d5",
        "FieldName": "sample string 1",
        "FieldLable": "sample string 2",
        "ValueText": "sample string 3",
        "LabelText": "sample string 4"
      },
      {
        "ValidValueId": "8a8558c6-9050-4c6b-b6e6-702497b3e3e5",
        "FieldId": "d468fedf-6693-4a10-85c1-ff9828bec0d5",
        "FieldName": "sample string 1",
        "FieldLable": "sample string 2",
        "ValueText": "sample string 3",
        "LabelText": "sample string 4"
      }
    ],
    "SourceSystemId": "sample string 4",
    "CompanyId": "2a9116e2-72c9-4da2-b73e-eb1217b1d871",
    "CreateDate": "2024-11-21T04:54:16.282075-08:00",
    "CreateUser": "sample string 6",
    "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
    "LastModifiedUser": "sample string 7"
  },
  "IsValid": true,
  "IsValidMessage": "sample string 4",
  "SourceSystemId": "sample string 5",
  "CompanyId": "b83cb93f-262d-4b83-8e61-e6ec158fb194",
  "CreateDate": "2024-11-21T04:54:16.282075-08:00",
  "CreateUser": "sample string 7",
  "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
  "LastModifiedUser": "sample string 8"
}

Response Information

Resource Description

On success, the created property.

NameDescriptionTypeAdditional information
Data

Property

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PropertyId": "d566be0a-889b-4663-8638-ca43afd1a6b3",
    "Asset": {
      "AssetId": "876eab91-3767-4184-a02e-d545767b8f99",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "9f9e7cfb-fa0b-49dd-bcd7-9d384280e1b5",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "edd09ad5-dada-4c24-bdc5-0134d727ed9b",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "c19bca05-8046-4b38-92d8-a6c1d3c354fe",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
        "MeasurementValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "284c71ec-e708-4173-89ad-b2c9f3a5116a",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "State": {
        "StateId": "8384bc69-340d-4a81-977a-18391c24b742",
        "EffectiveDate": "2024-11-21T04:54:16.282075-08:00",
        "StateType": {
          "StateTypeId": "90901936-8321-4876-a7cc-ffb3a8e6b076",
          "Name": "sample string 1",
          "IsOperational": true,
          "AssetType": {
            "AssetTypeId": "9f9e7cfb-fa0b-49dd-bcd7-9d384280e1b5",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "edd09ad5-dada-4c24-bdc5-0134d727ed9b",
            "CreateDate": "2024-11-21T04:54:16.282075-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 3",
          "CompanyId": "9340c2e5-4040-4759-b726-be573c18c0dd",
          "CreateDate": "2024-11-21T04:54:16.282075-08:00",
          "CreateUser": "sample string 5",
          "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
          "LastModifiedUser": "sample string 6"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "773952bf-1bf5-4cf1-bf89-3730def06cca",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "Status": {
        "StatusId": "fd561259-9d5c-4aad-9e2b-797412244192",
        "EffectiveDate": "2024-11-21T04:54:16.282075-08:00",
        "StatusType": {
          "StatusTypeId": "c4521e7f-9c71-452a-a19f-2f2816550fa1",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "9f9e7cfb-fa0b-49dd-bcd7-9d384280e1b5",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "edd09ad5-dada-4c24-bdc5-0134d727ed9b",
            "CreateDate": "2024-11-21T04:54:16.282075-08:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "1175c9a4-9e2e-4a2a-a4b5-2f43a7941123",
          "CreateDate": "2024-11-21T04:54:16.282075-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "44cbd7ca-c6d4-468b-9716-67b83f9dcd8a",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "a69f4786-5732-4ba3-a366-c64b14d85c07",
        "EffectiveDate": "2024-11-21T04:54:16.282075-08:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "6dcf0d1b-e8f2-4910-a6fe-e920784b20be",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "7ea63e59-8f9b-49b7-bc1e-2b86c7b7db3d",
          "CreateDate": "2024-11-21T04:54:16.282075-08:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "a1e917bc-6704-4c93-b425-508037fbb9b6",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
      "MeasurementValueNeededDate": "2024-11-21T04:54:16.282075-08:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "40e33261-5691-4565-a9a4-ad260224718a",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 8"
    },
    "ValueText": "sample string 1",
    "DisplayText": "sample string 2",
    "PropertyType": {
      "PropertyTypeId": "da53766f-ac43-43d5-b883-c31e542784dd",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "AssetType": {
        "AssetTypeId": "9f9e7cfb-fa0b-49dd-bcd7-9d384280e1b5",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "edd09ad5-dada-4c24-bdc5-0134d727ed9b",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 8"
      },
      "DataType": {
        "DataTypeId": "d333988d-a476-40d9-9649-935e663548d7",
        "Name": "sample string 1"
      },
      "Unit": {
        "UnitId": "8fadaeb1-39b2-49f3-be24-4b510cd5d0a2",
        "Code": "sample string 1",
        "Description": "sample string 2",
        "SourceSystemId": "sample string 3",
        "CompanyId": "b858889e-e57d-4163-85a9-37e4aabd0ace",
        "CreateDate": "2024-11-21T04:54:16.282075-08:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
        "LastModifiedUser": "sample string 6"
      },
      "MinValue": 1.0,
      "MaxValue": 1.0,
      "MinLength": 1,
      "MaxLength": 1,
      "HasValidValues": true,
      "ValidValues": [
        {
          "ValidValueId": "d1e647c7-c024-4b36-9515-5f7d062c0c23",
          "FieldId": "627268ba-133f-444f-9f8a-5f1d2cee731d",
          "FieldName": "sample string 1",
          "FieldLable": "sample string 2",
          "ValueText": "sample string 3",
          "LabelText": "sample string 4"
        },
        {
          "ValidValueId": "d1e647c7-c024-4b36-9515-5f7d062c0c23",
          "FieldId": "627268ba-133f-444f-9f8a-5f1d2cee731d",
          "FieldName": "sample string 1",
          "FieldLable": "sample string 2",
          "ValueText": "sample string 3",
          "LabelText": "sample string 4"
        }
      ],
      "SourceSystemId": "sample string 4",
      "CompanyId": "9e71b535-221c-4a2f-b288-4656b5336cd8",
      "CreateDate": "2024-11-21T04:54:16.282075-08:00",
      "CreateUser": "sample string 6",
      "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
      "LastModifiedUser": "sample string 7"
    },
    "IsValid": true,
    "IsValidMessage": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "d9d4041c-2014-49d7-bab9-225e2835bedd",
    "CreateDate": "2024-11-21T04:54:16.282075-08:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-11-21T04:54:16.282075-08:00",
    "LastModifiedUser": "sample string 8"
  },
  "Total": 1,
  "Message": "sample string 1"
}