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": "7a1e8ac0-7c70-431f-9b91-b3f6f4efa1bf",
"Asset": {
"AssetId": "0c30a069-b70c-4fb4-b772-e3021b9f7b91",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d7c8a7d9-f486-4012-b1ed-17f8541e80c3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "df131ac0-de6a-4baf-a675-8cf0558d107e",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a823cd95-5490-4740-8e70-f22cc17c9eef",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"MeasurementValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "32bc6d7f-b244-44b9-9c40-25d1cfaa6a60",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "6ebeecbe-869e-4447-8346-1e746fbd74f1",
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"StateType": {
"StateTypeId": "4c1dc698-1d91-483f-b3fd-7125156bf8e2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d7c8a7d9-f486-4012-b1ed-17f8541e80c3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "df131ac0-de6a-4baf-a675-8cf0558d107e",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d4a8ba3d-8701-495a-ac94-9a0eb8f1680b",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ae09459d-617c-410f-8ebe-729145ccd503",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "241f346b-7ed5-4722-bac5-06b134dec99e",
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"StatusType": {
"StatusTypeId": "732eb022-24b8-471a-937e-b2287cc473e6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d7c8a7d9-f486-4012-b1ed-17f8541e80c3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "df131ac0-de6a-4baf-a675-8cf0558d107e",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "826a01d3-e887-40f0-9cbf-1f2e8fdc9c0f",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5884e664-46ce-45ab-a1b9-41cc82bf9f75",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "1fbc42e6-dc2e-454e-9f71-e5aa86b85ca5",
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6a3bdcee-b215-43e0-8091-00159d449046",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3924b7ba-dae8-460d-a0fa-657489b668e9",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "de8cda37-2a82-4989-b497-9d12fc62d20a",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"MeasurementValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "22fd2d57-92c9-4e68-a322-3f85416b7cef",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b2265b20-6eab-4517-9069-27b60a2e740b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c1be3f97-7d7f-4f9a-b955-0823359183c6",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "38f577be-5d6c-43b7-a490-fc966aa3f8b3",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-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": "6d770160-ffed-4bf9-8903-2e980067d7b2",
"Asset": {
"AssetId": "055787f0-627e-4730-a049-432837b3f019",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3c6c3855-b726-4a91-808e-dd842d9c9064",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f95f6b1-7c73-41a7-a1f6-de55c6bb5b4f",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2c83ae75-5b3a-45ff-8319-3d9a2a05e861",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"MeasurementValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6f44c75f-6eac-4847-9423-03ae3f3fbd08",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f7a72d3b-99bf-4a03-9b40-992e82dc97c5",
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"StateType": {
"StateTypeId": "5120e33b-8664-4fd1-a859-8ccaf20a5c43",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3c6c3855-b726-4a91-808e-dd842d9c9064",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f95f6b1-7c73-41a7-a1f6-de55c6bb5b4f",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d33c04b6-62d6-46fb-8852-a489e0e8bad0",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b884fab0-165d-4b53-941d-69b160428075",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "2b2b7474-04fe-46d8-af22-3493e0ddb18f",
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"StatusType": {
"StatusTypeId": "58974a86-efae-405b-8838-0db770a7168e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3c6c3855-b726-4a91-808e-dd842d9c9064",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1f95f6b1-7c73-41a7-a1f6-de55c6bb5b4f",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5783a4f3-1869-42b7-829e-bbb796a575f6",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0fae3e0b-22f0-4047-90f8-86942cfbef78",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "cee61943-ba24-47a7-a261-ddd01f9490c6",
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d82fa98e-b981-47b7-8151-21cb38f5b0ad",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f7c93e16-8a86-47aa-8d76-fcfbc219d4d3",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7a225e37-1a8c-4c91-95e4-334722dc241d",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"MeasurementValueNeededDate": "2026-04-18T04:55:39.8716446-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "ab91425d-690c-4cbf-ad66-65aaf4dacf11",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3a4c338f-5cb3-434c-b8d0-18fd657ce88a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9b20bd8f-952c-40eb-808e-f3ee671d897e",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-18T04:55:39.8716446-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2242995b-df4f-49c1-aecf-15bdda2ec6d7",
"CreateDate": "2026-04-18T04:55:39.8716446-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-18T04:55:39.8716446-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}