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": "262236b8-db82-4926-b7e5-74921db3e1ba",
"Asset": {
"AssetId": "8b130ebd-da15-4da5-8e6c-54d8763e0361",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7c4e5576-6d44-4260-97ef-cb5d21cbd619",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "33cf2221-5316-4218-9cfa-f4b5b2a40d43",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e8555049-2fe7-481c-a32f-30ca6e16b116",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"MeasurementValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cf193de0-a61c-4b83-8aa9-885060056960",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "05fdbbe4-c794-4b6a-8bfc-2058f716752c",
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"StateType": {
"StateTypeId": "49f7b3d8-91f0-4f84-9da6-d406de869d83",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7c4e5576-6d44-4260-97ef-cb5d21cbd619",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "33cf2221-5316-4218-9cfa-f4b5b2a40d43",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "53850b12-5c15-4903-8cfd-42da2fdc83d3",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5be476e9-4844-4312-905f-4314ddca7986",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d6337569-a18a-4914-a163-75d95207f6db",
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"StatusType": {
"StatusTypeId": "f54d307f-77f2-40ad-b7f2-54fba66adad1",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7c4e5576-6d44-4260-97ef-cb5d21cbd619",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "33cf2221-5316-4218-9cfa-f4b5b2a40d43",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "f542aace-86d1-4258-abbb-ab8d073a4e1e",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0a14c75b-2bab-409b-a2f8-db5d29e872cf",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "54142077-4771-441e-a8e4-0dc94d5d0547",
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "90de246c-0090-4b5f-9bd2-d31cc7f603e8",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f856851d-2fcb-43cd-bdde-a9a1155b4513",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3a8af517-466a-446e-ae35-e0cf7af24d1c",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"MeasurementValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "917143c8-e469-4931-b9a2-234356e22bb7",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6bcb8be4-f327-4be5-b6ab-15c9bc0544f4",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "baf37e97-ee7e-4697-bfae-670f20fe02b0",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f9e7d331-e5d6-48e0-ae28-86e813f1eec4",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-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": "9b7a90e1-804c-4d38-9bfb-325e9932d072",
"Asset": {
"AssetId": "b507f752-c60f-46d2-85bb-d2da1e617e67",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "efba867e-af87-44dc-8646-2d6fc0bbdbce",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e29a7f7-afa8-4036-b629-e0c2ba8b138b",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "ec1904d6-39a5-4962-8933-023e2e658c63",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"MeasurementValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "36272593-39ec-4685-85b3-4066e337af5f",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "61c14637-bb27-438e-8614-49dce46ecd43",
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"StateType": {
"StateTypeId": "77bcad10-62d2-4b6f-8e4d-3a9fe73e3ff9",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "efba867e-af87-44dc-8646-2d6fc0bbdbce",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e29a7f7-afa8-4036-b629-e0c2ba8b138b",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e07c1d0-2acc-49ae-817d-820f59aa80a3",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9a098912-ce25-4c52-af35-4d778a913caf",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e8110426-e05e-460a-9d9e-881d99a28bdc",
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"StatusType": {
"StatusTypeId": "6a4d6421-b198-4585-b474-96fb06b9c012",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "efba867e-af87-44dc-8646-2d6fc0bbdbce",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "1e29a7f7-afa8-4036-b629-e0c2ba8b138b",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "eab1a260-9c4d-41fd-b07d-4d78d8bc184c",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b6704314-2de7-4a97-8b32-466ac8c3e4ac",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "137b27ff-371b-443f-a0e1-7a2c1515e4e8",
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d7d7fab9-d414-4570-9d57-922e5a650163",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2f2dbb86-c405-4d24-bc5b-51c2afc3fbf2",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "84df0836-a553-4ffe-a3ab-92494ebd13ad",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"MeasurementValueNeededDate": "2026-10-04T02:39:19.7512866-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "476c0aba-c920-4879-a8ca-00e3d617f894",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "56cdd94f-6fb2-4f01-bd9c-753192815202",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "06518e13-e6cb-4b98-8315-cbf05c697ac2",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-10-04T02:39:19.7512866-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "baeb3922-07ed-486e-ba0e-ce60434ffe03",
"CreateDate": "2026-10-04T02:39:19.7512866-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-10-04T02:39:19.7512866-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}