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": "d2a36c1b-f222-45a0-b657-2ebcbda0479b",
"Asset": {
"AssetId": "5cd6a36f-cd8c-489a-904c-bf6915a32e84",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ac55bf88-6d1f-4386-8ece-3cb2aff84022",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f6ec5114-cc8a-4c91-85d8-656651d046b0",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ca7d6b9e-ac71-47b5-ad1b-6f863d283b2b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-19T23:45:03.6974118-08:00",
"MeasurementValueNeededDate": "2026-01-19T23:45:03.6974118-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "70424f85-8670-4e80-b0f4-0d38e998bd08",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ae8b57a3-1539-466f-b4cd-90c7489b003b",
"EffectiveDate": "2026-01-19T23:45:03.6974118-08:00",
"StateType": {
"StateTypeId": "93b4990f-e642-4f80-a1db-4136df4b868b",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ac55bf88-6d1f-4386-8ece-3cb2aff84022",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f6ec5114-cc8a-4c91-85d8-656651d046b0",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4ad14e06-f012-4d9c-b442-1279e58d0d87",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2b707ab8-e789-4ea7-af08-62780ebed72a",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "66e23f5a-6c42-4add-8696-9e224e6f1f90",
"EffectiveDate": "2026-01-19T23:45:03.6974118-08:00",
"StatusType": {
"StatusTypeId": "30db1143-732b-4874-b390-c01d0933b894",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ac55bf88-6d1f-4386-8ece-3cb2aff84022",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f6ec5114-cc8a-4c91-85d8-656651d046b0",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "fc7b5c7d-dec7-4462-b030-e06d58ecedcd",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bcdeda0f-5e2e-4a4a-9db7-4aae53f9eb94",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "48d44140-ae45-4753-bcdd-4009b065cb0e",
"EffectiveDate": "2026-01-19T23:45:03.6974118-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "cc47e2c5-3196-47fb-bebe-c9d54b78fb36",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "10cf3aa4-ea5e-4c31-9d53-20f2c412db6c",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3dde18af-344a-436b-be94-e1a2eb7b1b83",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-19T23:45:03.6974118-08:00",
"MeasurementValueNeededDate": "2026-01-19T23:45:03.6974118-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5d521295-eacd-4df7-9bd2-047b5aa55feb",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "f37535ce-91cc-45cb-976c-945922d7c85a",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5f041423-118a-4d4a-9b1b-85081d9bde0f",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-19T23:45:03.6974118-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d3da660b-b4f0-462c-8db4-598cbd0dd78a",
"CreateDate": "2026-01-19T23:45:03.6974118-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T23:45:03.6974118-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": "f6a7ba0c-3b85-477a-b328-16c2a7d28718",
"Asset": {
"AssetId": "bf6aa53c-65a4-4115-a511-877050c2c63e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d2d9e12d-6f70-4091-80ae-fc50a7203fd8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0aba4d4c-e74d-4b76-a2db-7d7e7f224592",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "456ae5b6-74c6-423b-8923-8457a54b76d0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-01-19T23:45:03.7130992-08:00",
"MeasurementValueNeededDate": "2026-01-19T23:45:03.7130992-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "c8175dba-5ebf-4b49-9be4-0a4885d50356",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "edc64b8b-0429-4040-ac79-a1c835c61f4c",
"EffectiveDate": "2026-01-19T23:45:03.7130992-08:00",
"StateType": {
"StateTypeId": "d5ac1427-6823-4d9d-b270-8c6cb606b9c1",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d2d9e12d-6f70-4091-80ae-fc50a7203fd8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0aba4d4c-e74d-4b76-a2db-7d7e7f224592",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "bb77192a-636c-4962-a059-bdb918838d7b",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "dde5a70f-ae30-4e31-a3d7-076a8ac1d27c",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b125cd0e-474d-46c2-bd0c-304cb63edd9d",
"EffectiveDate": "2026-01-19T23:45:03.7130992-08:00",
"StatusType": {
"StatusTypeId": "4258bc1b-aac6-4c0b-85ac-18087cbcf329",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d2d9e12d-6f70-4091-80ae-fc50a7203fd8",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0aba4d4c-e74d-4b76-a2db-7d7e7f224592",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4a11f9b5-654b-457d-887c-45660d5edbd0",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1d7b0088-3ae9-4020-88d5-a65df4275282",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c7632597-eacb-4019-bae9-f3a9ddac6738",
"EffectiveDate": "2026-01-19T23:45:03.7130992-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "e8e97f93-6f10-49b9-a68d-4b50bf6c63de",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6b4f6b6b-e25e-48a7-aa04-f6f64a52bacb",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c04e53e8-1728-47f2-ad1c-a20c963d4161",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-01-19T23:45:03.7130992-08:00",
"MeasurementValueNeededDate": "2026-01-19T23:45:03.7130992-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "28911751-b7f2-4dc7-bd20-4b6c0d2abacb",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3082441f-7f3c-4489-9aa9-28d50acf7b76",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b0977151-2415-4396-8034-e1748137729d",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-01-19T23:45:03.7130992-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "43588c87-369a-485b-b914-6357c8485859",
"CreateDate": "2026-01-19T23:45:03.7130992-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-01-19T23:45:03.7130992-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}