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": "4dd851b3-2583-432b-866b-99ea4d435696",
"Asset": {
"AssetId": "13aba731-3d30-4d78-8fd4-a9b67940dacf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "565af33f-6af2-4e6c-99c0-0083e89c86fc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e7afb55-216f-492f-8187-882644639bce",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "fc6b57bc-79c5-4fa6-a8cf-18f429e55a32",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "1119b5f7-1192-4481-b2c0-3977bfd1d5ed",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8a23f14d-ad33-4867-9320-c4b77d185f7b",
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"StateType": {
"StateTypeId": "18a8c532-3115-4a39-b3da-6b5c332f3ea2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "565af33f-6af2-4e6c-99c0-0083e89c86fc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e7afb55-216f-492f-8187-882644639bce",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e3b2db7f-53ad-4a35-a3cb-9f943f83fa2e",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "37f29b3e-54dd-453a-a44d-4f88a9b49343",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b3e4be6c-1c08-4f8f-975e-0392d29cab28",
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"StatusType": {
"StatusTypeId": "f5b9916b-bc1b-4f62-9d11-0576358beda9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "565af33f-6af2-4e6c-99c0-0083e89c86fc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e7afb55-216f-492f-8187-882644639bce",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7fd92a08-df06-4942-8554-942ae3c765c8",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "898d0b7e-e8d4-4c09-8e7d-1b4919c0b4af",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "954bc738-5ffe-48ef-a0bc-40efadc21b22",
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6977a147-4d51-4b8b-a134-306e850aebbb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1cfda333-2bbe-4f7c-ad2f-22811c87f5bc",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "522d2738-f78f-4f9e-8ec4-c397a4a7cc0f",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "98a80dde-0cb1-4d13-91b1-5af6423ae0c1",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "de8496aa-d511-4d90-a669-6427ad806a53",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "611fa3df-8584-4100-a204-7b51a098d7e2",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2242e5e4-1a77-44ea-82ba-f80ed7eeec45",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-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": "c5119b8f-5c2e-48c4-91fd-805a692c7d18",
"Asset": {
"AssetId": "ed15d13e-2e19-49bf-8255-37c5ba069d2c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bb5a9a66-12d1-4924-8292-987fcb064758",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b13f0400-0fad-455f-9f49-e1cc89a55085",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "35b456b1-14b8-47ad-b968-655a23e70bc5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b74b7508-3449-462b-8774-7abcf5c95d9e",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "104ba81d-d164-44b2-b8a9-00350078388c",
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"StateType": {
"StateTypeId": "94547f1a-2d0c-42cd-ae71-4866ae170812",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bb5a9a66-12d1-4924-8292-987fcb064758",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b13f0400-0fad-455f-9f49-e1cc89a55085",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e7cb3b74-b423-46d4-8fbc-36f0392b5b94",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a9560bd6-c292-4376-89ab-f61c93441401",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4febe2ed-61c8-407e-a202-fd56ea303ab5",
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"StatusType": {
"StatusTypeId": "2f803341-0ce2-4f0a-8161-aaf8a92fa86f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bb5a9a66-12d1-4924-8292-987fcb064758",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b13f0400-0fad-455f-9f49-e1cc89a55085",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "294c6292-92af-44b9-9afe-7c4d8cb3396e",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "453373d9-dc12-4ba1-a568-17b65d961c49",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a738c3bf-6f11-422b-8a4f-b1e0d88a67b9",
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f1b25267-0186-4567-b3c8-552e0ccee703",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0222f2b1-da7f-4ce1-8340-92efacea1be6",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "03f593b5-3c9d-42bc-a48a-68f5bce06511",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"MeasurementValueNeededDate": "2026-06-01T20:27:46.7935455-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9c0d08e4-e9ec-47c6-b58e-eca577f674a0",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "1ac930d3-d80d-4c4d-bf33-19e39dc7d0e5",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3b9b40fa-8469-4557-a0c9-78d88d6084c2",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-01T20:27:46.7935455-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1ee6fbe9-61fc-43b9-bc57-2aa7dd47aedf",
"CreateDate": "2026-06-01T20:27:46.7935455-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-01T20:27:46.7935455-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}