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": "f2fcc855-d208-4ef0-ab0e-0218c0a398e8",
"Asset": {
"AssetId": "dc0313ee-b287-4b97-805a-1536777e0113",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "64ca59e8-9778-4857-a572-eb989d18a3e0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9d7ac64c-5cf4-4bb5-9765-d71c1f007081",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "95ba8cfa-c8a3-4067-b2a5-45b40c3d5fba",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "67c2823d-b026-4869-b1f5-83bf498556a4",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d875ee09-71b4-473b-9ffc-2c0cc17023b4",
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"StateType": {
"StateTypeId": "4db290ed-3bf9-4079-954c-6fefbb8efb3f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "64ca59e8-9778-4857-a572-eb989d18a3e0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9d7ac64c-5cf4-4bb5-9765-d71c1f007081",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "790f5466-678e-4019-8b18-f7c8f4af96d8",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0e0ca994-0ee0-41e7-a33e-b8d901236fbe",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fd82e7c9-f912-424b-8ed6-57e6146ae5e2",
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"StatusType": {
"StatusTypeId": "dbbe9609-723e-4835-9d3d-4d2c714c0935",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "64ca59e8-9778-4857-a572-eb989d18a3e0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9d7ac64c-5cf4-4bb5-9765-d71c1f007081",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "586153dd-06cc-40a8-9aa9-436f4c377c27",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1480257c-87c1-41d3-9126-70851d93ddc4",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9a5791db-4e0d-453b-a754-b1da7e612c06",
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "fda1ecaa-aeea-4981-9add-36f6d5d7012c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42298bf1-209c-4e91-a7f3-20b50aa76f4d",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dbb0a849-b9b7-4510-9661-3a5f21cead75",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f22e5da4-25bf-48ad-9163-67185c2f6a46",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "37dfc2e3-3663-461e-955f-253abb5c5359",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2d266bec-96ad-4b88-aacb-60992bac6865",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e246879a-c7a4-4072-80a4-b18ffc25ef2d",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08: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": "d783295f-04f4-4821-ad7a-9f0d235743a0",
"Asset": {
"AssetId": "f1eef127-e71c-44b1-a736-b9a04b2b51df",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "34777a2a-d00f-46cd-a56a-e4545613a169",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "207bcd5f-2fb9-4096-9155-dbc13a5b63bc",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "86b1a619-8a6a-4818-a9b4-b39482f87796",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b6d1f623-14d4-4f34-9acf-23f939ef481b",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b78a3726-3e2a-4fb3-ac89-a93e267416f9",
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"StateType": {
"StateTypeId": "1cac1bc1-2a00-41c9-883d-7a3550742228",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "34777a2a-d00f-46cd-a56a-e4545613a169",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "207bcd5f-2fb9-4096-9155-dbc13a5b63bc",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "aa0ac4b6-9a99-47bf-bfd7-22e8c665e15a",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9581c2f9-f327-43dc-80da-2c19d6df8262",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "983ecd32-7ad6-4f0e-a9fd-3dc01061645a",
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"StatusType": {
"StatusTypeId": "30e98622-829b-4851-a63c-3d988d16cdba",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "34777a2a-d00f-46cd-a56a-e4545613a169",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "207bcd5f-2fb9-4096-9155-dbc13a5b63bc",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "63b25f8f-e286-497a-857b-3f7bf71c7b78",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9832ca7f-216e-4173-a457-8f90d28b15ba",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4b62d766-3476-4ecf-bd09-e8b2c55d6184",
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "0d8b7bdd-a434-42ce-9630-62c0a64b7f07",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "42123469-40d3-471d-8d95-e1daf37a7b72",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fff037e2-262c-4c8a-9f22-0eb8fa737392",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"MeasurementValueNeededDate": "2026-11-22T14:12:49.0897456-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "af0d2d8d-7f86-485e-82a9-dac53afe805e",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "022ab223-49ad-485e-b649-3c9180eb6fc1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aabd5078-ddc0-4d70-9b5d-750d800d66d5",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-22T14:12:49.0897456-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5f9301cd-98f7-42ac-b2b8-60effada1dae",
"CreateDate": "2026-11-22T14:12:49.0897456-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T14:12:49.0897456-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}