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": "a3864614-7408-401e-8499-2925ebb74d9e",
"Asset": {
"AssetId": "32f7a1c6-7fdf-4618-aee0-21534979b798",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "bfca846f-b926-417d-91c8-675ca9aa2cfa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18a3defe-70e0-45f1-92e3-f890a8452b01",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e07b04ae-6fa3-4958-ae4e-cb5de68a366e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "63f29d92-0906-496f-a171-1410dd0cad4c",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "af7a133e-1eb7-47ef-9030-f9d21304d55d",
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"StateType": {
"StateTypeId": "131ccab8-601b-42c8-a3d3-eefd5dd1faa4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "bfca846f-b926-417d-91c8-675ca9aa2cfa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18a3defe-70e0-45f1-92e3-f890a8452b01",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "61a79b86-d8ef-4c71-9d81-2677c3d4b87f",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "163c2d94-9680-4b8e-810f-e4c16f5dcdf5",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9eaea6f2-0c1c-49f1-8534-6d58f01af405",
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"StatusType": {
"StatusTypeId": "95fe3afd-c48d-478f-8cd5-ec9fda3e392f",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "bfca846f-b926-417d-91c8-675ca9aa2cfa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18a3defe-70e0-45f1-92e3-f890a8452b01",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1a416fbb-8eb6-45bd-a5d5-688e41c84117",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "35b4b66c-62c0-410b-87f3-ba3848fbe070",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fa69db4b-d929-402c-851a-b9ff9cfe088e",
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "2234b7ba-6936-47b7-b91d-79534c325136",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "02cb32e3-d40a-485b-a866-76f0ea697715",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d181100f-e876-46e6-89d2-94d92ee2cb6b",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f19cbd9e-7bbd-4548-aa7e-5834ef0e2876",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9a47147a-c580-4832-a402-f9bd29fc9a5e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9a1c121f-2281-481e-b764-b4c3783fad2d",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8a301445-cb21-4854-a654-69518c6d1532",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-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": "d6d5f6c7-6ffb-4b7b-962f-413136ebd290",
"Asset": {
"AssetId": "a6078f68-d839-435c-9262-41e0bc785ecc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "844eff23-e1db-4904-a5b9-072b3d9f24fa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6cba944e-df95-4858-94b5-525c1a461764",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "179d3525-2284-4ca4-b01a-a699d6e777db",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "dcd61c0e-2284-4beb-913d-edca67c830a0",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "e26901e5-425b-4060-9f6c-2ae10783d83d",
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"StateType": {
"StateTypeId": "1d74ebcd-48bc-4fa4-989a-8c511c909347",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "844eff23-e1db-4904-a5b9-072b3d9f24fa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6cba944e-df95-4858-94b5-525c1a461764",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "004980a5-e897-4d13-a137-dc425cca0694",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5cd27590-0487-43ab-a22e-18927fae71d7",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ef05e00b-af32-4585-8987-14e4eb18e9a1",
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"StatusType": {
"StatusTypeId": "adfb4500-0912-4b11-8f14-2dba32131390",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "844eff23-e1db-4904-a5b9-072b3d9f24fa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6cba944e-df95-4858-94b5-525c1a461764",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "767725ad-9130-4423-9f0b-c94f74e1160b",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "07b00a6c-5d0b-4358-aa1d-5a31bded9ff7",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4bcb31cc-8206-4775-9b0f-11ad40908e5c",
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4757a902-fd50-46e7-9574-1ef63cdcab66",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "17f84f9f-ae2a-43c7-afa0-d629f7d953d2",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "202c4f45-464d-41ea-9e39-88b903d6f860",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"MeasurementValueNeededDate": "2025-06-02T14:46:08.4096386-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5762365a-83bf-40f4-bf46-d70a3f878601",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f9e71429-85af-4de1-b32d-d4b171829fe1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f4448c0b-3b4b-41ff-8805-4824a8d75eba",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-02T14:46:08.4096386-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1071ae70-60af-44a2-9b32-a566066a0277",
"CreateDate": "2025-06-02T14:46:08.4096386-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T14:46:08.4096386-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}