POST Notes
Creates a new note.
Request Information
URI Parameters
None.
Body Parameters
The note to create. NoteId should not be filled in.
Note| Name | Description | Type | Additional information |
|---|---|---|---|
| NoteId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| OnBehalfOf | string |
None. |
|
| NoteCategory | NoteCategory |
None. |
|
| EffectiveDate | date |
None. |
|
| NoteHTML | 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:
{
"NoteId": "75246ad9-97e9-423f-8e6c-264dbb37fedb",
"Asset": {
"AssetId": "76f6cffc-43ba-4a05-8aa5-5f08a8893004",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "89ebb95b-66c1-480e-babf-8a9825344e12",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "026ab336-ceec-4a7d-a5e1-ce693136192d",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b0c017e3-b6b7-45a3-9aa7-bb846413bf95",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"MeasurementValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8040a078-25a2-4fd9-8d92-88eae58c30c5",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3ac0c6d0-3751-4394-840e-8444626431ed",
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"StateType": {
"StateTypeId": "d657075d-474c-4467-8244-eaa76c3d1e69",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "89ebb95b-66c1-480e-babf-8a9825344e12",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "026ab336-ceec-4a7d-a5e1-ce693136192d",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4f1ba696-79b3-46fe-a2c7-4d323d7da023",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "73b8623c-cc95-4221-905e-23223bee2f15",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "51dc22cf-e44a-4926-aa5c-a426a0f3ad0c",
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"StatusType": {
"StatusTypeId": "1a3d9147-7976-4ef0-baf0-630fbea84ca7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "89ebb95b-66c1-480e-babf-8a9825344e12",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "026ab336-ceec-4a7d-a5e1-ce693136192d",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "471c0aec-3c32-405a-a348-b3e9cc938051",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ba74f589-8661-43be-8fb7-ecfd0706f278",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "40c68729-e02b-480a-9a95-23b57fd1f819",
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8c7e2520-7d51-4d01-84ed-956da19c6788",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1a120be3-ff27-4d20-9963-1aa026a3f5b8",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "88409cbd-3dab-4c62-adc4-b3a703556e7c",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"MeasurementValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0a2669f5-bd07-4bae-8446-de5ea79c330e",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "e4c96b33-c807-4ace-8bae-3b8f51c368ad",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6f82e650-22ed-4ee8-bf99-0fe71a9d505c",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e869e840-abfd-4638-b1cd-1a5e367e242f",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 6"
}
Response Information
Resource Description
On success, the created note.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Note |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"NoteId": "f841e63e-3380-444b-8308-f4b4b8e1e81c",
"Asset": {
"AssetId": "b30a0247-d1ac-43ff-b190-dde65694c66b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6447b1c0-397d-4d32-807d-4b5f61e7b727",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "219d18b7-c51d-4597-82d2-ed916f0e36f2",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a758feff-c552-45a5-bd89-83da07aa04fa",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"MeasurementValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4b000f81-588e-4d71-9599-392656e80681",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a4055de2-51cd-4639-a0a9-9c7dbe239f42",
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"StateType": {
"StateTypeId": "ff74e671-7016-4c3a-9d6c-e8b1867642e7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6447b1c0-397d-4d32-807d-4b5f61e7b727",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "219d18b7-c51d-4597-82d2-ed916f0e36f2",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5489cbee-c461-48e8-8a49-01404a4be66f",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6c0fe3ba-14aa-4e4a-9792-1efef1a9f80c",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "103bf7f7-0c62-4079-a158-c46c8820c780",
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"StatusType": {
"StatusTypeId": "6c09c0bd-1436-49bd-8363-645b25ed5da1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6447b1c0-397d-4d32-807d-4b5f61e7b727",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "219d18b7-c51d-4597-82d2-ed916f0e36f2",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ce7ded44-f7d5-4eea-baec-e11cf9b64a0d",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fe711ad7-db73-40bb-b553-f98d7d505cf6",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0d6fd4ca-e5d7-43fa-9f9e-b9cea82256ce",
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0846b6dd-4f05-4862-8c97-1567d3cfbec5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "32bdc3e7-78cf-46bd-974d-edf3178fa359",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0e8efdd3-0a3a-424f-8034-0e4f662b3e1c",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"MeasurementValueNeededDate": "2025-08-29T17:21:12.1336185-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b20cfd6a-ea01-48ed-9690-32965b473263",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4cd84f50-2dae-4cb1-9316-4662a887e4c3",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4f34129c-b6ae-48f1-b166-aa0ec1b26eea",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-29T17:21:12.1336185-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "979f7033-5f98-4542-86d5-3c4991133b87",
"CreateDate": "2025-08-29T17:21:12.1336185-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-29T17:21:12.1336185-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}