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": "19d5319c-706d-4732-b67b-3f508bd4ef63",
"Asset": {
"AssetId": "53d2bb3b-690c-4f7b-8205-1f1963aea02c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a754e585-a845-4ba2-a0a6-f1f5adc42fbc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b7dd10b4-c02a-4d8c-9751-570b8f7d16a4",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "506e6ea2-bf1e-4085-a1c6-cde0d619105d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:51:14.3815509-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:51:14.3815509-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ab028ef3-f91b-4be2-878c-d7328abf99e9",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "5e217a5a-20f4-4ba8-96f3-192eff1e9f39",
"EffectiveDate": "2025-11-17T18:51:14.3815509-08:00",
"StateType": {
"StateTypeId": "b3bb8aa6-0e4e-48a1-ab93-585af44e1bdd",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a754e585-a845-4ba2-a0a6-f1f5adc42fbc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b7dd10b4-c02a-4d8c-9751-570b8f7d16a4",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5ddc3e2b-610d-4344-8fd8-e1dbcdbfe60c",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "19a890ab-0c61-4155-9504-fbeb4e11051e",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ce4f7dee-899d-4dfd-9485-b7065aff14f2",
"EffectiveDate": "2025-11-17T18:51:14.3815509-08:00",
"StatusType": {
"StatusTypeId": "742d68da-15b0-4b87-99d2-f711e67a5a4e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a754e585-a845-4ba2-a0a6-f1f5adc42fbc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b7dd10b4-c02a-4d8c-9751-570b8f7d16a4",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c7757129-7f86-4035-8ab5-2f6ce78a7f9b",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b45a8e90-654d-42d2-a1a8-699e619fe99b",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c74c5d35-929a-4972-a2b7-e5e692399870",
"EffectiveDate": "2025-11-17T18:51:14.3815509-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "d1822dda-bd12-4afc-a9ba-2efa47407a16",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "978f7e10-027f-4db0-9595-0a26d210cfdf",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e35b7dde-190e-4608-bae1-1feeb403f5c8",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.3815509-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:51:14.3815509-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:51:14.3815509-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e3377618-1a9d-4f1d-aa69-fb5c697e3f8a",
"CreateDate": "2025-11-17T18:51:14.3815509-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2817a40c-e877-4087-94d4-5a9468ad2d9e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d9c42566-1ccc-4850-8c05-f4637cb4bc59",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-17T18:51:14.3972399-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "529e21d3-e706-461c-b712-7b42c4a95b23",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-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": "a00dcf3b-054f-47b1-b860-046dc147384d",
"Asset": {
"AssetId": "1155fecc-4701-4030-befd-8a8bb77a7097",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8cfb04cc-cd22-4ae7-a668-28e9bccb2c14",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e8d0ad4-2c2b-4368-8613-f50186f2cc23",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8c48f151-49eb-4a14-93f1-79641ca3903f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-11-17T18:51:14.3972399-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:51:14.3972399-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "50cca9cc-ed80-4b75-af5d-cd38693a072f",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dce13c03-e985-4558-866f-c8b71cb84e1b",
"EffectiveDate": "2025-11-17T18:51:14.3972399-08:00",
"StateType": {
"StateTypeId": "8e3f48cb-ee6b-4307-9aba-088e73e5fa5e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8cfb04cc-cd22-4ae7-a668-28e9bccb2c14",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e8d0ad4-2c2b-4368-8613-f50186f2cc23",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "03c61794-c527-4eb4-839f-d4b21d3db26f",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3a7f8bbe-0b33-4e1d-a461-33aa662780cd",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "56885c3d-2cf9-473e-982a-9562131dee7a",
"EffectiveDate": "2025-11-17T18:51:14.3972399-08:00",
"StatusType": {
"StatusTypeId": "07ba09c2-d807-44d5-9a22-aeb89aa22787",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8cfb04cc-cd22-4ae7-a668-28e9bccb2c14",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6e8d0ad4-2c2b-4368-8613-f50186f2cc23",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e96302a2-496a-44b7-946b-8e068e8ba10b",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0bf7b055-7f62-4ed6-8996-65ee1f316056",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6b070559-1275-4fec-bd0b-949d73ba004b",
"EffectiveDate": "2025-11-17T18:51:14.3972399-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2da0cd75-93cc-4bd6-9458-204ba8192e03",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7d523cfe-9467-4adc-b9f2-f39890f5a754",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f924b90-9d07-4fb0-a235-055ff485416e",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-11-17T18:51:14.3972399-08:00",
"MeasurementValueNeededDate": "2025-11-17T18:51:14.3972399-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "595f30f5-b7bd-46de-9e6e-9aabc749dab3",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "16ae377f-8e0e-451a-be64-bb0bfad1c8c8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "716eebdf-7a8b-4279-ab4d-7137ba516001",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-11-17T18:51:14.3972399-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c14ca73-a00d-45d9-a1cd-72a579ac0351",
"CreateDate": "2025-11-17T18:51:14.3972399-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-11-17T18:51:14.3972399-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}