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": "d0e798db-5af9-41d4-9c0f-ff8fc91cd4bd",
"Asset": {
"AssetId": "00c9ec5f-1986-4c86-95d6-016379872248",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "86072500-855a-45a9-a67a-ea9184cdbb80",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85bcf4d9-7a06-4a65-9d19-12e7c50e690e",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4350ed61-cced-4f81-8099-5204b694bc9a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "80e00a78-a0ee-4e5c-9fb8-158bf2f2efd6",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5852b021-d848-48ac-94ee-06f34237eb9c",
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"StateType": {
"StateTypeId": "11ffe32b-cd5c-4d95-847b-034d69c64373",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "86072500-855a-45a9-a67a-ea9184cdbb80",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85bcf4d9-7a06-4a65-9d19-12e7c50e690e",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "13ba26be-b5ea-4daf-b642-8e5105204574",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "79fb46e5-621d-492f-a0e4-70f804ecd5d3",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "52e47dcc-ae9f-4a26-b2a8-6fff03fff90e",
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"StatusType": {
"StatusTypeId": "0937c2c3-73bc-45f4-b55d-820fcecbed62",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "86072500-855a-45a9-a67a-ea9184cdbb80",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "85bcf4d9-7a06-4a65-9d19-12e7c50e690e",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f63d18d8-470a-4f29-a8b2-ab96941e09fa",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9a425ffc-fe38-4cbc-b3da-49b634ad1ae8",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "076c80a0-187b-435a-b4d5-70d2fe5995bc",
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "90f94bf9-35b9-4316-99f6-36c0c2bf9aca",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "563feadc-322a-49cd-9b4a-83f39355af52",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "605302cd-d5ac-4a35-a650-2f32f024ee54",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a369f3e7-5565-48a3-8318-d694bc7bfe48",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "77dd2926-7637-48b8-98d5-e3173b57ca08",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a5347da2-29a7-4841-bb01-5d4c94ddcfa5",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3b18c03a-a519-4737-8cf7-a738bafdfffe",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-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": "52c37f26-0401-45be-9068-8c33c9b5b233",
"Asset": {
"AssetId": "62dec90c-6305-4f55-a24a-5fbf92767de6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d0b76e06-5d8e-433c-a6b7-abed49e9d134",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bce35233-1a75-40ea-9a6d-6f0d4985dd63",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f821626f-ca74-4edb-b9f3-d544db4c2833",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c5d981ad-3602-4243-b124-fd274eecbf94",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3a132e4a-1a3e-491b-a927-3b08fa3ba6c8",
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"StateType": {
"StateTypeId": "97a49d7f-4c21-4a33-92aa-6968c4918e51",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d0b76e06-5d8e-433c-a6b7-abed49e9d134",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bce35233-1a75-40ea-9a6d-6f0d4985dd63",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "de3447b3-a022-4f6e-9ca4-a8402b19442d",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b809aa36-3c99-499f-9e9f-0bf9ed9acc0e",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "07c07bd1-51c7-4932-a39d-f057fa8bfcd6",
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"StatusType": {
"StatusTypeId": "1a82d5e1-7fe6-4f04-933a-ccf56a6a5f47",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d0b76e06-5d8e-433c-a6b7-abed49e9d134",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "bce35233-1a75-40ea-9a6d-6f0d4985dd63",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "bf2e6d05-780c-4c9d-bef5-3bcda78dff9d",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f5a48550-f420-4567-8cf8-958442e3b24e",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f6163520-e6ef-4295-a3c9-913c4c5be984",
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "bdabdf53-a4bb-4db9-b1e2-623745a73230",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fdc51fbe-fe99-4fee-bf99-06cb0f3a83b6",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7a7ddeae-1aac-4ff4-9192-c6413ba6bca2",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"MeasurementValueNeededDate": "2026-03-30T16:53:03.1859597-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0dd00a4b-c10d-4263-a707-46ec1cd279b6",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "81ee2a52-e39e-4e98-b71e-a7482f0ba12e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4a16f38b-cb07-42f2-9e68-08bf65c24cbc",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-30T16:53:03.1859597-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "0afdbc97-c9c2-4395-9991-c4ae67d336a4",
"CreateDate": "2026-03-30T16:53:03.1859597-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-30T16:53:03.1859597-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}