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": "3a190817-111c-4178-90ee-d81682ed515e",
"Asset": {
"AssetId": "dc9261a6-02ea-4c1e-b994-dae070e795c8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a6f52a39-cabb-4678-90aa-4081a81fd05d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e2b95d14-0154-43e6-8485-b6414413de54",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e731024a-b6d6-4ffc-bf60-0b1835fd3cc6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T04:50:55.1819886-08:00",
"MeasurementValueNeededDate": "2026-11-21T04:50:55.1819886-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4f0371b9-1c3c-477f-8103-4a55f75f0c0e",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c7299e9e-6cd7-488a-9307-5e3bf4cb29a2",
"EffectiveDate": "2026-11-21T04:50:55.1819886-08:00",
"StateType": {
"StateTypeId": "d63b8e77-a8ac-4f73-b432-310945d810cb",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "a6f52a39-cabb-4678-90aa-4081a81fd05d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e2b95d14-0154-43e6-8485-b6414413de54",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "76dfc7c1-9948-4829-b7df-7c11bbe979b6",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "303da7a4-8536-4660-9afc-e784aba54c6c",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e2db1ed7-0662-4861-83db-6b0243a060b7",
"EffectiveDate": "2026-11-21T04:50:55.1819886-08:00",
"StatusType": {
"StatusTypeId": "bb18874c-5dc8-4464-8fab-c7e35a858f46",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "a6f52a39-cabb-4678-90aa-4081a81fd05d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e2b95d14-0154-43e6-8485-b6414413de54",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "71d091b1-b5fa-4ac1-935c-967960c45a13",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e7f419cb-63b0-47b9-94ba-a1f5f0431243",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a7f2488c-3069-4d06-9a6f-9a1b0fc694ba",
"EffectiveDate": "2026-11-21T04:50:55.1819886-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "954c8109-61ed-4822-8940-089abc132ccd",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cab7651a-e2c7-4754-8fee-3752d23dbd75",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c99597a6-3c36-4376-99ee-fb9fed6ce91f",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T04:50:55.1819886-08:00",
"MeasurementValueNeededDate": "2026-11-21T04:50:55.1819886-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a606c6bf-4fdb-4fed-bf4d-ee321302cbff",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f9cd801e-1017-45f2-a8fc-9e4d8f9d3dc2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f4e6e1c2-08ac-477f-b053-2e691b165275",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T04:50:55.1819886-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "96ec3849-1de5-4da3-b053-ea06546388c0",
"CreateDate": "2026-11-21T04:50:55.1819886-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T04:50:55.1819886-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": "04c1000d-bb71-495c-8166-57aeac776e26",
"Asset": {
"AssetId": "0bf95368-27c5-478b-bf3c-bcd2e447e067",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cec217e9-9ff0-41ed-8b4c-6a7c4f85d56f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "86de0a7e-c0e2-4ab9-ae25-8b2d9e795f40",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7f41a472-f0ac-4166-bbae-afc8222c307b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-21T04:50:55.2601043-08:00",
"MeasurementValueNeededDate": "2026-11-21T04:50:55.2601043-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c01bc118-3ded-400c-b298-c41c2c86f474",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "4340e9f4-ea90-4121-a8e2-958987e9b66b",
"EffectiveDate": "2026-11-21T04:50:55.2601043-08:00",
"StateType": {
"StateTypeId": "1e7e4ba2-80d4-43b1-b4e9-6c3c0ca83a08",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "cec217e9-9ff0-41ed-8b4c-6a7c4f85d56f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "86de0a7e-c0e2-4ab9-ae25-8b2d9e795f40",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0359daef-7ea3-46c2-9682-51014e7e66b8",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "152a9196-7388-4762-b020-c31fc2624975",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "12fad899-2e10-4c6b-9522-0bf79c5184d6",
"EffectiveDate": "2026-11-21T04:50:55.2601043-08:00",
"StatusType": {
"StatusTypeId": "f350ffab-9bc5-4506-a1d6-062a8eed408b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "cec217e9-9ff0-41ed-8b4c-6a7c4f85d56f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "86de0a7e-c0e2-4ab9-ae25-8b2d9e795f40",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "17b52bc4-79f0-422f-80a4-76bea7ebb99c",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2e7ddbb2-9aef-458d-8de1-f24dbd735f62",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8b2dfa5c-06ac-42ec-989d-53f78026248d",
"EffectiveDate": "2026-11-21T04:50:55.2601043-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "98f3fd24-62cb-498f-a359-e2de403ba54e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f5f2e55a-788a-438e-8e81-2dbad0f9c59e",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54ae0536-358f-4292-b518-258fb444c976",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-21T04:50:55.2601043-08:00",
"MeasurementValueNeededDate": "2026-11-21T04:50:55.2601043-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "50da5abc-3738-4e65-a38c-f6da4fd5671a",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "88d5efd4-3f09-4e50-9e01-d0b36b1c168f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1ed5de0b-1c68-4c8d-8514-62d3ad497fce",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-21T04:50:55.2601043-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "33b2150b-0202-4dee-bf9b-0f1a4af7f644",
"CreateDate": "2026-11-21T04:50:55.2601043-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T04:50:55.2601043-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}