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": "9a5b5ab4-4dc2-4af7-87de-3e410d75c7df",
"Asset": {
"AssetId": "56ee2baf-1dda-4394-9b1e-028f196da30f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4ef5f520-f38e-4c73-8cb4-4c8a4b5f5f43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d91f51c6-1223-46c6-89e1-cde03d68a247",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "84c680b5-7932-480b-a9db-665bee2b8f5c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a04b3342-6970-4e09-995e-a691ecc32d72",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2e2d2f9c-a93c-463f-acb3-e4d391d07714",
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"StateType": {
"StateTypeId": "d86edaea-78d0-4e4d-82fe-1e45e594d64b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4ef5f520-f38e-4c73-8cb4-4c8a4b5f5f43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d91f51c6-1223-46c6-89e1-cde03d68a247",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "db6135cc-6ae6-45a3-a574-a9f7dc690ce6",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4bfa19b9-65c5-4be2-8742-99a8aaca18c4",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "981b3e47-74a6-48f1-aed1-9877bf1aae17",
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"StatusType": {
"StatusTypeId": "0ff23b4d-2c8f-40a0-9171-dab4960c6ff7",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4ef5f520-f38e-4c73-8cb4-4c8a4b5f5f43",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d91f51c6-1223-46c6-89e1-cde03d68a247",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "74c3238f-7a73-4edb-a166-189b4b3b9312",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d01bb35f-74f3-446f-ba3c-4ff49ade27d1",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "107e4735-98ff-4b84-b215-591d9d5ed3c0",
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4b42970a-d9ae-49e0-bd4f-2ecb1ce50755",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c04d6100-2019-432e-90e2-991a4c2622c4",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "be8fd1cc-6c5d-46a6-9b34-88f0b6692b87",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "aee0c8d7-3d43-49f6-9495-a3e1e4688f9e",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6df15869-5cba-4376-a88f-ffc3f9ab50ed",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "6f41bc3e-bc93-4d03-98ce-dd6c5860dd45",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3fa954c0-5089-45aa-bdc5-94a54d6a5f2f",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-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": "8e7ce3b7-22b0-479d-8d2a-1749d80e5c80",
"Asset": {
"AssetId": "091e9fd0-d4ec-4a0b-9a66-ccce8aa8b5cd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "940130f9-ffda-45f2-a13e-3f78616985b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ba1021b7-763c-4f35-8a19-5e3eae06ff8c",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4a9e06cf-2485-4a63-b9fd-fac82bf4841a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4d053eae-60e1-41a0-913f-01e612c034ef",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cc35161d-d86d-4f8e-83ea-d9409c67f181",
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"StateType": {
"StateTypeId": "68df0268-c1c9-4c57-84bc-e135962e89d2",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "940130f9-ffda-45f2-a13e-3f78616985b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ba1021b7-763c-4f35-8a19-5e3eae06ff8c",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4b6e3165-2358-4fba-83e4-eb580940bfca",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "62435f50-05de-4ad5-8049-4161a388d7f7",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d38ab626-b59e-41bb-9193-20e4e62ce938",
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"StatusType": {
"StatusTypeId": "7277a9dc-2ac8-466b-971d-7e97176c1c24",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "940130f9-ffda-45f2-a13e-3f78616985b3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ba1021b7-763c-4f35-8a19-5e3eae06ff8c",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "381f3108-3805-4556-ab53-30b15c8d86c0",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dde13c4d-744d-4a41-a56b-39de006b3193",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "460563db-70ce-4547-b351-1681713dc535",
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "805b07a1-87bf-4363-a7d7-27a3281aa6ea",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c865629f-d28d-4d37-9c7e-8d2727b11538",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "98f38f13-e9e5-44a1-bbae-38132cee643e",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"MeasurementValueNeededDate": "2026-06-22T01:36:44.2190874-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fabe5e8b-0cca-429c-840f-d52dc1d24c4f",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4a1f515a-48b9-4745-af91-6d0438f197f4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3f69bcc8-4b29-4817-895f-f0f81c10daff",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-06-22T01:36:44.2190874-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "891d77d9-d470-41d2-9cc2-e84d87252f13",
"CreateDate": "2026-06-22T01:36:44.2190874-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-06-22T01:36:44.2190874-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}