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": "170b18cb-4529-4871-ac32-98352581c58f",
"Asset": {
"AssetId": "43e21d12-ae14-40fb-adf7-6b017d495de2",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "35ad4c2e-6ec1-4eed-983e-3eedaa69039e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "32c6fd46-4bef-4597-8699-2140aefba946",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c3f3c7cd-0c88-4572-bd3c-fab5f9ca98ea",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"MeasurementValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e8452e2b-8c7c-4248-b9f3-efa28d545e27",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "10fb7075-9d6d-411c-976b-d3731c66a61e",
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"StateType": {
"StateTypeId": "ac1d3027-08af-43b8-8025-06728d7869ba",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "35ad4c2e-6ec1-4eed-983e-3eedaa69039e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "32c6fd46-4bef-4597-8699-2140aefba946",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0488c35b-4211-4a27-b7ea-4677eeaf249e",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "617a8dce-5229-406e-b190-327e86903c47",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "57fe277a-6ec0-43a0-8990-641af52586a4",
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"StatusType": {
"StatusTypeId": "88105587-1499-494e-afd4-e7bc0e62756d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "35ad4c2e-6ec1-4eed-983e-3eedaa69039e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "32c6fd46-4bef-4597-8699-2140aefba946",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "94fb616b-08aa-4cd4-aa83-d11d999d14cf",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7adfc300-55bd-47e9-95f9-beaf466ea827",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "89e009bb-9a84-4e19-9765-33d45eee28bc",
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "787e544e-fd7c-4d65-a9ad-3649bd25bcf5",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "25cc7be8-1713-49d5-9290-57e0a394a035",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5af395e9-5703-4bf7-aa66-7e3521fd4040",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"MeasurementValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "04c7e2c9-29a9-42ab-addf-a751dedbb004",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "e67a1dc4-a28a-4989-afe0-ce18cc5b88cc",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e627773c-c2e8-4e86-99b1-1a880ab6721c",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "431d07bc-0187-43d1-9666-ff539adcede1",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-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": "afd6162d-715a-4876-a8f3-224e5c2373be",
"Asset": {
"AssetId": "9675d020-d777-47d7-98a1-79782e56da92",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8b01bd89-4d2b-40c8-99a3-36260127dc70",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c23e30bb-05a0-4a4b-b7fd-8928ac77fab9",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5ca9df88-82ae-460d-87f1-e8bf3421bce2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"MeasurementValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4498f384-d5f7-4163-be3f-adbdcd944920",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5b979406-b220-4901-b20a-07dafd1fc609",
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"StateType": {
"StateTypeId": "21094ef9-9211-4cc0-b14f-d270fc03dbd9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8b01bd89-4d2b-40c8-99a3-36260127dc70",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c23e30bb-05a0-4a4b-b7fd-8928ac77fab9",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e2aab6f7-bb3f-4b29-bd4c-fd249ef4ce66",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e6dd4e3f-8f53-4945-86dd-ff4d6235cce9",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "161e1410-30ca-4dda-9652-52c9f7950a49",
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"StatusType": {
"StatusTypeId": "328cbdbb-1047-475e-9b2b-c820dc218c31",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8b01bd89-4d2b-40c8-99a3-36260127dc70",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c23e30bb-05a0-4a4b-b7fd-8928ac77fab9",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "16e926df-ccbc-40a2-8659-163fffe7227b",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3f6cfac9-41ee-4b22-87db-84201e548578",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9bf240b3-455e-43ad-8d2a-8fd7013b30cb",
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "9b83709b-a523-478b-afc9-c86c77662fa9",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9d3af637-645f-4f46-8281-888af5885e0c",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d84cddd9-1def-4793-a95a-81f56306e04b",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"MeasurementValueNeededDate": "2026-01-07T09:47:33.3676536-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b34eb0b8-c4c8-4253-aed1-0a127a097b62",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "15c9472f-2d20-432a-82f1-af1c305df65b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "73abfc37-fe3a-4cb0-8517-bf57eea5ff4f",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-07T09:47:33.3676536-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b574277d-f727-426b-91ab-b5bf1656f688",
"CreateDate": "2026-01-07T09:47:33.3676536-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-07T09:47:33.3676536-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}