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": "4b380b76-5b97-443d-bdd4-b590bf419a10",
"Asset": {
"AssetId": "d9002025-e33b-4797-b24d-6f3bef700183",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "482efd83-2678-4d7b-904b-86a195e1a834",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f4bfed98-b656-488d-8f61-f9a1888a9cd1",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "65305cc7-20a6-4b85-bfe6-aec45e87496d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"MeasurementValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9b930854-7ef8-42c0-9c76-18e5594b52d7",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c66bbcb6-0b65-4797-8dd1-58a5e60b088d",
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"StateType": {
"StateTypeId": "747d6cf2-1fac-458f-9583-385e546577d8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "482efd83-2678-4d7b-904b-86a195e1a834",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f4bfed98-b656-488d-8f61-f9a1888a9cd1",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "6943c8ad-987e-47ca-a1bd-0364b2bf5581",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bfbe790c-d119-4cb7-bcaf-d4ac4bf324aa",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "11df5846-c1b5-452b-b8ac-164ef8f2a24c",
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"StatusType": {
"StatusTypeId": "cb3617c0-16c5-48de-b4c6-f9c852f4c00f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "482efd83-2678-4d7b-904b-86a195e1a834",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f4bfed98-b656-488d-8f61-f9a1888a9cd1",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c4f754dd-f157-4e10-bba8-7cec0a6399e9",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e48a5709-6973-425d-93de-73198e576fb5",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "ba6de148-ac10-432a-bcab-0630e713e96e",
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "08964e16-f559-433c-993c-82e806ebccaa",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b945dd4d-1d7b-4c3f-aad5-ec31c22ff50c",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c964522d-1f47-4d17-bcde-e0aa6e3b785b",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"MeasurementValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3a8aec5b-ecef-4e0a-a52e-61218197b7db",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "73919a2c-fbc9-4bd7-855f-9f42e49f1083",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7f6c361a-ef2e-436f-8340-324a22ca4c8e",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f979488e-2077-4177-a243-4429f3eeef1d",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-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": "97b39c26-ab85-4b5c-b692-11c298fa336c",
"Asset": {
"AssetId": "4d2b8b73-4cea-4338-aa16-bb0bc4c5c32c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6555c52d-10d2-457f-aeb6-e991fd0b5ef4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "09d7e791-6ff4-4139-ae4e-cbb23c777fcd",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4a3e4141-2f37-4a20-af9a-bd332b0019ff",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"MeasurementValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "79a5f9b7-72fd-450e-a288-1063a0234139",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "22f13819-2f65-414a-aeed-536416048253",
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"StateType": {
"StateTypeId": "5b92e004-b05e-45dd-92f1-10ffe50b08fe",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6555c52d-10d2-457f-aeb6-e991fd0b5ef4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "09d7e791-6ff4-4139-ae4e-cbb23c777fcd",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c2a216f0-3f65-4f11-a751-64d94831d935",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8d6edf35-7f30-42d1-beb1-52bd6ae3017b",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ee6c1c0a-68b7-4de3-8231-7d1febd02fa4",
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"StatusType": {
"StatusTypeId": "74370a9d-3eda-436c-949c-1d020a21e240",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6555c52d-10d2-457f-aeb6-e991fd0b5ef4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "09d7e791-6ff4-4139-ae4e-cbb23c777fcd",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9fb4031a-bf4b-4d48-968b-03a5de02eb8c",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "353d4ced-69cc-45ce-9132-e8644aa53597",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "26d26624-64db-46e8-9ad5-c666195084fd",
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "4805f226-1867-471c-a25e-7c6756870b6d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c5863f5f-f278-4774-a27f-12a5e6fdfda8",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "64d21197-6dbb-456c-9ce2-4b917f334fd4",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"MeasurementValueNeededDate": "2026-02-02T09:36:45.4853322-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "babb000d-2883-42c2-9a81-973e1fdbd862",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3d7212b3-bc6a-49a4-9583-bc0e1032a7b2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a77b6477-5690-4c0c-b474-4b3925af13d8",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-02T09:36:45.4853322-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "a5a7d301-8268-4db8-bb15-f82b0bb85c7e",
"CreateDate": "2026-02-02T09:36:45.4853322-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-02T09:36:45.4853322-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}