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": "70f7f0b6-348c-48b1-8af2-4c05710fd540",
"Asset": {
"AssetId": "c31cbe89-99f6-416d-aa4a-0ebb52b4cef0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8e498a6d-5a50-4198-9de0-5d8621b5534e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62f1807d-387d-4e83-bce2-1b4c082ca1ac",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "5e1ea19d-0c23-4ecc-90d9-d436ab40b8a9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9b7420c6-5e3a-4a03-85e6-59d39f89c68b",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "40a47083-4b06-4333-82e1-ef9329f2eeb6",
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"StateType": {
"StateTypeId": "7774cf87-ff5b-4a58-afa4-2b8e74c10e1b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "8e498a6d-5a50-4198-9de0-5d8621b5534e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62f1807d-387d-4e83-bce2-1b4c082ca1ac",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4c739f7d-b442-4acb-a5b0-888dae662a50",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "acbbc5d9-661f-4fee-9cec-5d6914ecf6ea",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "49eb3834-7dd4-42b4-a2eb-38945280d97b",
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"StatusType": {
"StatusTypeId": "29ab65ae-6324-4798-9673-19734c646b62",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "8e498a6d-5a50-4198-9de0-5d8621b5534e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62f1807d-387d-4e83-bce2-1b4c082ca1ac",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "5ba5a86c-76c2-459c-aaf5-8a189dc99afb",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0a664520-f5cd-4c8f-8cca-b4fbda10a7ee",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "254463f0-a9f6-4f80-804b-ac24f65db405",
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "bdbffaae-4282-4d6a-8305-9758d80e881c",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "eddf61f2-87ba-452b-9b1d-836a3d6f432b",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3bfc3078-c2a0-4912-af02-13e4d0aabbb2",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "657dd686-bd95-47ec-90c7-06388e7d0d1f",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "066a2559-f66d-4b35-b0ef-1c1de5114ca1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c38ecabe-2804-4ac5-9721-9e14d15cb8fb",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "ea4f242b-7b7c-44a4-ae6b-b47b855d0372",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-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": "aeaf8ed9-5a35-438b-a2dc-eb6ddc4b8393",
"Asset": {
"AssetId": "fb0f49d9-7400-4494-89da-3fc2b5738346",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "528ce071-ba6b-4a76-ba64-95c55460fc05",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "363c3a43-8c12-4f0b-b6b6-f67796ea8f2f",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b63092d9-a9da-4021-b903-328e8b15b529",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e1e88173-84ad-48d2-b226-a18e8480a2f4",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "7d355cfb-71de-4548-b049-301a4b33b1d5",
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"StateType": {
"StateTypeId": "4721fa17-a471-4aa7-9c4c-304cf5069c14",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "528ce071-ba6b-4a76-ba64-95c55460fc05",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "363c3a43-8c12-4f0b-b6b6-f67796ea8f2f",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4372f685-21f2-4d27-a165-2eac9e7920a7",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1a63d95b-d05b-486c-a8c5-2dc68cfc1c44",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4e35ddeb-b64b-405c-834f-23c62a33f100",
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"StatusType": {
"StatusTypeId": "803c026a-ea57-4046-9286-3e4020bd0d09",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "528ce071-ba6b-4a76-ba64-95c55460fc05",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "363c3a43-8c12-4f0b-b6b6-f67796ea8f2f",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "75296e4c-28aa-46dd-a669-a5912e4dc834",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0c6bf017-8fe0-4602-9e09-27c92eb2264f",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fbc0d44a-c7c2-4788-8d01-8e974415be68",
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "b8e9939e-fec9-49d1-9a61-770fe39c723d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3ebf217a-cbb8-47ec-bc25-41166a771d92",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b6bfd504-934a-4e5f-9930-52b897e71fa6",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"MeasurementValueNeededDate": "2025-12-17T04:27:13.1446108-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "75382195-714d-4e6f-80f1-5cb95f44dc95",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "8305e955-cb71-4fd9-a34e-7b996408d123",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ed776eb2-8850-4d70-8921-d15391a79299",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-12-17T04:27:13.1446108-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d01ad363-ece7-4b0f-b418-be7750a38e5c",
"CreateDate": "2025-12-17T04:27:13.1446108-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-17T04:27:13.1446108-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}