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": "50127dec-0e67-46f8-9936-32b8b855db85",
"Asset": {
"AssetId": "9b9a8cea-5ac1-463a-abc1-c8159913d8b8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "97dc7365-a931-4289-8321-d75d8cbade2c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bbbd0a1-21d6-4d5e-9c5d-b856440d9cc7",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b53d39ac-b8ae-4c2e-b137-a07eed9e71c3",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "904300c1-1c42-4ae0-8b0b-d367bf94ea2b",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d7f806b0-72b9-420e-a3e1-5c61b9d0d9d1",
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"StateType": {
"StateTypeId": "05177432-8f03-42a0-a5cf-ef039453bf84",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "97dc7365-a931-4289-8321-d75d8cbade2c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bbbd0a1-21d6-4d5e-9c5d-b856440d9cc7",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fe0aa361-a4e6-4745-94fc-159ac931ecf9",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8f965ec8-dc15-474e-9eb0-34534297b2ee",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "35baef7b-a7c3-4322-98a3-88dcffe82033",
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"StatusType": {
"StatusTypeId": "4043994a-1079-40aa-8898-8931e23dce8d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "97dc7365-a931-4289-8321-d75d8cbade2c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0bbbd0a1-21d6-4d5e-9c5d-b856440d9cc7",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6146a14d-9b49-4dfe-92ba-46a6ce172a1a",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d8eb84e7-d3b7-4d79-9597-d71ad7c0fc3f",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8de7651e-b5f3-485f-98bc-fb437caa7031",
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "1b67e2d9-71b1-4ed0-a92a-d2da33357d09",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ff0d11c9-bbb0-4f4c-a81e-8745639767a3",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "97c441b6-481f-408b-979a-12c6d89d08a9",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e900df5d-a7e8-4714-87c2-b91505b61992",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "bc5d5fdc-b2c5-40dc-9ed0-d1b5b72d6fd1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c73e19a9-43d9-41c3-8847-c4b83163bb88",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "62c8930d-ae20-4552-99b6-00af615e332c",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-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": "ff3d94a7-3892-4b4d-a5a5-131c79859ae7",
"Asset": {
"AssetId": "e1fc088b-4f1b-4b36-bf18-7a898f7d85eb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "377670df-11f1-47d7-a1ec-f713df0938d1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3c9a2d22-06a9-41f8-a5cc-ccf4ee45b64b",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0dc9c2fc-0c95-49df-b4ae-071169f800d9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ea9cdd50-6eef-4300-a43b-d62aaacb5451",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "9a749b28-e78d-4dfa-be51-24cfe7d1650d",
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"StateType": {
"StateTypeId": "55dc10ac-00f9-4ab5-a536-f7f2e1e4a793",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "377670df-11f1-47d7-a1ec-f713df0938d1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3c9a2d22-06a9-41f8-a5cc-ccf4ee45b64b",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "49e5df2f-7023-4ca4-9ca4-a365cb2e7130",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ce987c94-fd07-4062-9fc7-80720f0bfbdc",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ad617264-a879-4a94-9036-e9689e75e468",
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"StatusType": {
"StatusTypeId": "b645944a-a78a-462d-9782-12d8e3ccf1a0",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "377670df-11f1-47d7-a1ec-f713df0938d1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3c9a2d22-06a9-41f8-a5cc-ccf4ee45b64b",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d72bf877-12ad-499f-a99c-85db70bf8d8e",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5015f68b-9a2c-495f-927e-7b71a61f6772",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e583d4ee-f149-46eb-b4cc-bde0a7894e35",
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0949cab5-818e-4d24-830a-df28046a47c2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f27950c1-b5d9-4ec8-a41e-4cbf650063be",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fe54a6a4-366e-4f03-8eb1-e24ee36db9e1",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"MeasurementValueNeededDate": "2026-06-17T17:24:26.4260397-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "344bfdf8-3552-449a-9036-16496e35d89e",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f8b17aa1-c2b1-4163-98a1-bf221229e04c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "4210ce77-b13d-4ce4-96ac-1157da48bac0",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-17T17:24:26.4260397-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7563973f-5cf0-4baa-9768-a98095830019",
"CreateDate": "2026-06-17T17:24:26.4260397-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-17T17:24:26.4260397-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}