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": "e5ddb4ca-0a0a-4e6c-903c-84a83a5ffc82",
"Asset": {
"AssetId": "62a81470-cd92-47f7-a5cc-eb5792cc1483",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9230c1b8-b75c-4e66-b93c-6a38ff93ea5a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f8736b67-f01d-4292-a019-97fedd27398d",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "7772b2ac-5b46-4cbd-a3e9-3fedbd76f49a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"MeasurementValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3aeb1db7-e6e7-426f-ab7e-299ef84956c0",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "2b976e25-a762-4d63-a62f-aae9c3ccaf0f",
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"StateType": {
"StateTypeId": "8d59b7f4-9848-4b92-a11b-b6b45e25a3a4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9230c1b8-b75c-4e66-b93c-6a38ff93ea5a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f8736b67-f01d-4292-a019-97fedd27398d",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3d57ad2e-81fc-4f7f-a33f-bc27948ff56e",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6742707e-31f2-4bd0-b88a-bf59a45424d4",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "557f5ef6-a480-446d-ba63-282b88c5984b",
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"StatusType": {
"StatusTypeId": "2628fef2-fd65-4fbc-9446-1dd8c0fdfe1d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9230c1b8-b75c-4e66-b93c-6a38ff93ea5a",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f8736b67-f01d-4292-a019-97fedd27398d",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d5357bea-45e6-4af5-a0e5-9195fc862e1a",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a84264ab-3333-4989-af8a-e6f80f7142d6",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "bbfc46a3-98c8-41a9-bc90-e65399f37581",
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "eebf57e6-0785-4d8b-b3d0-bfd1df082a8a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "859e6307-c6b0-4457-9360-18d8d01a1ef5",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4cedc236-dfc5-4777-a317-11a902eedbaf",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"MeasurementValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5df76389-fc08-4a42-9745-e681ec95c748",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "6aad51ee-602d-4a82-ace6-08da240f36e6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ce0880f3-480f-4c12-8dcb-b0643b9a64f8",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "07466d33-8a36-45c3-bbae-113ec9fae2c2",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-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": "399e622b-87f1-485e-8207-e1f93a91ee84",
"Asset": {
"AssetId": "41256d3c-ff6b-4201-bc5d-0aefbddd67ec",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d0219af7-2b0f-4096-9dee-b06c4fdd69dc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef29e82d-e892-4570-8ad3-fdba9f577f2d",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "d275b920-7bc1-462e-9165-f71e21008778",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"MeasurementValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "523ed004-aa2f-4868-8439-1195724c44b5",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "50777121-5ac2-413a-b20d-3d8327ca7515",
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"StateType": {
"StateTypeId": "85733287-d8e7-4ddf-9d48-425ea9a329df",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d0219af7-2b0f-4096-9dee-b06c4fdd69dc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef29e82d-e892-4570-8ad3-fdba9f577f2d",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "bba1a124-039b-42b9-8db6-3335bb8c227e",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2f4570b7-fe0f-42b9-80fe-0c3a3787822c",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "a82ad0f8-009c-445e-ac1c-69aad8eab77c",
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"StatusType": {
"StatusTypeId": "5875bfc7-f677-46a0-9c48-a0427f7d7bca",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d0219af7-2b0f-4096-9dee-b06c4fdd69dc",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ef29e82d-e892-4570-8ad3-fdba9f577f2d",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "958e3ba7-afee-4712-9421-b604b9cd5b5c",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aebaf49a-34a2-4007-b5df-6e15256155af",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "98197729-0933-45a1-8012-9e76a14f3dfb",
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "2f38efdf-2ede-40b6-9bd7-061d4ca2d2cf",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a9dd082f-094c-4382-bac3-038179121614",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "16e177f3-a8a0-4a7c-9d9c-602470717ab6",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"MeasurementValueNeededDate": "2026-02-23T12:08:32.3737238-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9e3d6701-15b0-4ca7-9684-1326cc24fec8",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "ab84ebb1-b93a-469f-9971-95e9e3bada82",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bc69a71f-4b9e-4478-ab37-b06c9d21b2ed",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-02-23T12:08:32.3737238-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e33e1b22-b223-4ab1-a996-cc997d93ea6f",
"CreateDate": "2026-02-23T12:08:32.3737238-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-02-23T12:08:32.3737238-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}