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": "c234f7fb-aa4c-4fed-8868-59146a4a8950",
"Asset": {
"AssetId": "3cf29146-e6fd-4bf4-9542-bc1b73ec915e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fea492a7-fdd1-4226-ad73-e701988e3107",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9df3a596-679e-4553-b700-3dc2b2313c6a",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0c7a15e0-c4a9-4ea4-99f0-1e7fdf0f6b0b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:17:42.917127-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:42.917127-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d3af0208-c939-47d9-bd1c-ac6da0189a05",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "62a3a9bc-9440-4bea-897b-08eaa7b5325f",
"EffectiveDate": "2025-10-13T15:17:42.917127-07:00",
"StateType": {
"StateTypeId": "718f2915-b767-482f-a2c7-e714f8b986a4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fea492a7-fdd1-4226-ad73-e701988e3107",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9df3a596-679e-4553-b700-3dc2b2313c6a",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "758b1b4b-6a0e-44ee-9b4f-3eaff68ed174",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "953cea71-e910-47d4-b0a8-9ba7fc357c28",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "98a5237e-cb30-4f7e-b415-aad77315c80f",
"EffectiveDate": "2025-10-13T15:17:42.917127-07:00",
"StatusType": {
"StatusTypeId": "fd288707-4cd1-434c-8c8d-6e013c78c158",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fea492a7-fdd1-4226-ad73-e701988e3107",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9df3a596-679e-4553-b700-3dc2b2313c6a",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8042fefa-3dcb-4528-943b-a8a135be9f46",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1858b731-5a82-483a-bdc4-045be1a27cdc",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "35bd5d62-e0f2-4162-aaad-75f4d1cff30b",
"EffectiveDate": "2025-10-13T15:17:42.917127-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c6d1e922-c58a-47f3-ae81-2968055be00d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ea7b0d87-5e23-457f-aa25-0b6bd6f25af5",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5f507a4f-6762-4be1-a842-750aa460eb5a",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:17:42.917127-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:42.917127-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "75161c07-b321-4818-a56d-a9b82adf15ca",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5905ae24-fc5c-40e0-9aa9-a195941363b6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f4243a94-5ddb-44d1-9a39-9310df0f7fb7",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T15:17:42.917127-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T15:17:42.917127-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f41a7bf5-eb29-4c7e-948c-d2231a43a91d",
"CreateDate": "2025-10-13T15:17:42.917127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:42.917127-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": "41391b44-6735-43f1-9a76-5197eaea5f51",
"Asset": {
"AssetId": "d1db3076-04e7-4363-8270-b9f6a001a712",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b185188e-46dd-4bd9-800e-4f3930b8028b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34dfa745-611a-46a2-8fde-bed06d05c86d",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b4d0b50e-2795-49a9-bbab-fb4de2c2ff21",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:17:42.9328166-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:42.9328166-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f7107e08-ddb0-4aef-b35b-d6515f98e538",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "60f918a3-18d2-4889-9f79-61673f9fbb6d",
"EffectiveDate": "2025-10-13T15:17:42.9328166-07:00",
"StateType": {
"StateTypeId": "e908c525-5672-4d99-ab59-c8cda428efd7",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b185188e-46dd-4bd9-800e-4f3930b8028b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34dfa745-611a-46a2-8fde-bed06d05c86d",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cc684bec-81b9-44f3-97e8-1873855ad3c1",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aeed96dc-ca26-48cd-b9cb-934e76b0c32e",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fff3493c-9750-4ce7-8a7d-2b11090a331a",
"EffectiveDate": "2025-10-13T15:17:42.9328166-07:00",
"StatusType": {
"StatusTypeId": "6678ee64-7e58-4006-9b18-6236699e1649",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b185188e-46dd-4bd9-800e-4f3930b8028b",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "34dfa745-611a-46a2-8fde-bed06d05c86d",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "06ba5f8d-ecba-474e-9eeb-4776254bfa74",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "75256c4d-dd09-4aa1-867e-a53147ea8af1",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "724fd3bd-7d19-4138-9f9f-8aca14283f3b",
"EffectiveDate": "2025-10-13T15:17:42.9328166-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3f49acea-1917-4a82-bf24-3796186acf8a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f2729153-3cf1-4151-948c-e39dc6bf4060",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7e78f96f-1ae1-4f51-bf2b-5ab6a22c5db5",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:17:42.9328166-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:17:42.9328166-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7475e56f-6400-4871-bc08-18e58abd455b",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "80e6b27c-136d-4faf-a33f-b87a82cbe288",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "eb771f9d-1d3a-4773-b3e1-8f837ca34bac",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-10-13T15:17:42.9328166-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "9934ad35-a80a-402f-96a4-803184aed0c2",
"CreateDate": "2025-10-13T15:17:42.9328166-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:17:42.9328166-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}