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": "1e1b1196-3c93-435b-8fbd-293ce9396dcc",
"Asset": {
"AssetId": "80c199ed-d8d8-4ca0-b15c-2de2576073ec",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "811b52e7-683d-4f74-aa29-8044f98f6174",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cb599d0c-ce60-4a13-81e9-e2ef431593fe",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9201dc48-9072-46bc-aecc-285ce2ab0b88",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:05:28.6287723-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:05:28.6287723-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8e85dbf3-6566-45c7-b966-cf380f0dfa92",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "edad544b-6c03-4bf9-a443-6668b1900970",
"EffectiveDate": "2026-05-12T17:05:28.6287723-07:00",
"StateType": {
"StateTypeId": "87a3ce78-f3d0-4b38-8ac0-8e94507fd93e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "811b52e7-683d-4f74-aa29-8044f98f6174",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cb599d0c-ce60-4a13-81e9-e2ef431593fe",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e9671c36-9ce2-4a54-ac62-1afb0d496925",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7fc694c2-b19f-4acc-ae5a-2ef140f9ecba",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3c6ba446-6192-4095-82c4-6a4f3ffcb2af",
"EffectiveDate": "2026-05-12T17:05:28.6287723-07:00",
"StatusType": {
"StatusTypeId": "1568cabe-816b-4b59-97d4-b04867a88493",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "811b52e7-683d-4f74-aa29-8044f98f6174",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cb599d0c-ce60-4a13-81e9-e2ef431593fe",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d26a93ac-4d1a-448b-80fa-052a21026b78",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a188858e-f682-4f34-bd6b-7353cdbe812e",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6af4791f-a0c0-40a2-9e42-3594153d14e8",
"EffectiveDate": "2026-05-12T17:05:28.6287723-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8f10e275-987d-4d0a-b560-d0e663fbc7a8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dd2f4325-01e3-46c6-b2c6-7d6cf816d99c",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f2a5aed6-e8f7-4cf7-9331-78b20e13008a",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:05:28.6287723-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:05:28.6287723-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "c96dd286-0242-4fed-b81a-b0ab03b86694",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "40b8ca2d-97b8-4dff-8c2e-aa0b4cdf3856",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "da781677-78d0-4238-a9f9-29538a7ff74f",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-12T17:05:28.6287723-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "63e10e44-adad-4ba6-a106-0e4b85b8f9df",
"CreateDate": "2026-05-12T17:05:28.6287723-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:28.6287723-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": "bbbf01a2-4069-4989-8071-66817b95a16e",
"Asset": {
"AssetId": "e83410e6-14e6-4610-806c-0e2513a0ff14",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4ccce233-7cd0-47f4-8161-12e63b00a2cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e53d157-dbd3-468c-9514-674b3bd115e5",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "3f20922a-2aa9-49c9-a694-a50d9664bcfc",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-05-12T17:05:28.6444216-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:05:28.6444216-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9ae97a1c-3dfe-4bd0-97af-62efd2e651fb",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a2ecd74f-f677-4a0f-a5e9-3704d840351d",
"EffectiveDate": "2026-05-12T17:05:28.6444216-07:00",
"StateType": {
"StateTypeId": "fa7a556b-760d-437f-ab57-aface559f028",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4ccce233-7cd0-47f4-8161-12e63b00a2cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e53d157-dbd3-468c-9514-674b3bd115e5",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d37d4632-b7bb-4f4b-a8f3-a060be3f3c1d",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0ea0e3fe-3448-443c-8983-c3be29059f70",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d763604c-e2f1-4ef8-9be6-9876d5d998cc",
"EffectiveDate": "2026-05-12T17:05:28.6444216-07:00",
"StatusType": {
"StatusTypeId": "955f6920-17cf-4b42-8782-f59235656d9d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4ccce233-7cd0-47f4-8161-12e63b00a2cc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e53d157-dbd3-468c-9514-674b3bd115e5",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8637d85f-9da0-43e2-96dd-19487aded13c",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9934bc5b-a1e7-4a0a-a601-1adaf88d3b69",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e444bc7e-7bc8-4e2a-8a90-46453d68d10b",
"EffectiveDate": "2026-05-12T17:05:28.6444216-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5ac57dbe-8cb8-4c2b-86cf-b8d2393c7456",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "05475ab4-8cfa-4531-a6a1-62a965b39cfe",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cb6431e2-2e1c-4b3d-804f-34e93bbaed72",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-05-12T17:05:28.6444216-07:00",
"MeasurementValueNeededDate": "2026-05-12T17:05:28.6444216-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e3f8fc1b-dd39-4835-8850-5c74a34fe42f",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "226c055d-26e6-4d2f-8a57-282419987cde",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ee970383-e66d-4145-aa0f-7ac5fd9ea68e",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-05-12T17:05:28.6444216-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7617ae83-42cf-4fee-ab68-2d1ace41931b",
"CreateDate": "2026-05-12T17:05:28.6444216-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-05-12T17:05:28.6444216-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}