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": "b08a42fa-614c-4e67-a242-38ab432c6d2e",
"Asset": {
"AssetId": "b57c2dcc-a134-4188-a1ce-b0776d111bcb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "67695dcf-693a-4872-bf98-8a46c607a6e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7469ea5d-f285-4e09-b6e0-a9aa0c6063c4",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "10ef8c19-a94e-41c5-8ccb-f7a8fa5b42c7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:09.9150527-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:09.9150527-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bab2d950-df52-4147-adb4-db79acd9cebe",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d01488b9-368b-4a25-be5f-0a36ebf76c22",
"EffectiveDate": "2026-09-26T13:57:09.9150527-07:00",
"StateType": {
"StateTypeId": "1620ba1b-cee3-4b0b-9469-ac76b6bed529",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "67695dcf-693a-4872-bf98-8a46c607a6e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7469ea5d-f285-4e09-b6e0-a9aa0c6063c4",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "502a40ba-3a96-4b5f-ae9e-30dee23fb917",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ab152ab2-3219-45ec-b2c7-7d16a077689a",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1ef9aa9b-11a6-4987-afca-42b94ac292d3",
"EffectiveDate": "2026-09-26T13:57:09.9150527-07:00",
"StatusType": {
"StatusTypeId": "5b6ce0ea-fb12-4374-b431-9a44fa20217f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "67695dcf-693a-4872-bf98-8a46c607a6e8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "7469ea5d-f285-4e09-b6e0-a9aa0c6063c4",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "038040fb-9646-49c5-b5ef-f66af1d0ef38",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "042ec083-8d39-4281-8cbf-a9b6a0b38ad4",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "3d9ae462-bd06-4b44-9cb3-e9855506b778",
"EffectiveDate": "2026-09-26T13:57:09.9150527-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "fdbe85cd-0d23-4909-9976-7c2c088b2f1d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e6a05e6d-874e-497c-9956-89d013815bd7",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a8576d40-77fa-4639-a2f6-e63eef37cbea",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T13:57:09.9150527-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:09.9150527-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "80f84d9f-c8b9-4bf1-b310-ac15f665c16d",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "bccefa8a-1521-45bf-9f17-fb2a25a49582",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "aaad9b87-e208-4e93-887e-ab88202107f5",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-26T13:57:09.9150527-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "54645a32-7fe0-432c-a84e-be4c5ab2f31d",
"CreateDate": "2026-09-26T13:57:09.9150527-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:09.9150527-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": "e514cf29-80b5-4359-9189-fd6326d55632",
"Asset": {
"AssetId": "750f4348-adb4-48ff-abf3-02cf48360f2f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d7223160-3db8-4da7-955b-f73f8d0043f8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e008abd2-5db3-4bb4-adda-0bdc1e25a465",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "8a076832-6321-468e-b3ff-a795db90ab48",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-26T13:57:09.9306601-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:09.9306601-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c50ca84b-2273-4105-81d9-8fa19a06bdf1",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "8083e110-8a9d-4ae9-8ae0-5a585cec9154",
"EffectiveDate": "2026-09-26T13:57:09.9306601-07:00",
"StateType": {
"StateTypeId": "5aa9456d-2027-4ea1-a95c-184d4797fb03",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d7223160-3db8-4da7-955b-f73f8d0043f8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e008abd2-5db3-4bb4-adda-0bdc1e25a465",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e4b94101-e1d0-48d6-acc8-67dc79df6658",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5cb2faea-b0bd-4620-b901-1cdcb647a0b1",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e0a37f10-9d9e-407a-ae68-a02188813234",
"EffectiveDate": "2026-09-26T13:57:09.9306601-07:00",
"StatusType": {
"StatusTypeId": "71c1610e-76d3-4a56-8e7a-bd796460934d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d7223160-3db8-4da7-955b-f73f8d0043f8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e008abd2-5db3-4bb4-adda-0bdc1e25a465",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b66346b6-d24b-433f-a9ac-dc457ae484b6",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "caf42fe8-ed33-4017-8499-bbb9789e058a",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "86f68fef-7c55-4137-a8ca-c0e00e37c564",
"EffectiveDate": "2026-09-26T13:57:09.9306601-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "f850d61f-f243-44cf-9e4d-42cd7112fe35",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "92c174fa-17bd-4d18-adad-0f02a167c41a",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b69f942f-5862-4aec-8297-a22363a97b7d",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-26T13:57:09.9306601-07:00",
"MeasurementValueNeededDate": "2026-09-26T13:57:09.9306601-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3117f496-ea83-499c-a987-c001d24c1efe",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "da5e930d-4244-48f9-a23a-379c8858ba87",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ab389a04-e37f-4704-8e5b-be992d663f28",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-26T13:57:09.9306601-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4724b80b-45da-4fc0-8ba0-0fdc61b08c2b",
"CreateDate": "2026-09-26T13:57:09.9306601-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-26T13:57:09.9306601-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}