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": "6b0b3cd5-c447-404f-8f79-e58d5fd74d83",
"Asset": {
"AssetId": "ba6fa295-50ae-47ef-8486-31b7d7f545e6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "02777940-98ba-4c2c-b627-0c21775825c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e1d73f2-aea6-41d6-8455-fff365692fcb",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "df72c9a1-cf5f-42ef-8b80-603b4a06aabf",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "37b7085e-736b-4f31-b1c8-8d518cfe67bd",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "89380afb-8482-48a2-a8ec-7c4d10f6194f",
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"StateType": {
"StateTypeId": "2b76edf8-397e-417a-b5f5-4004390d6853",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "02777940-98ba-4c2c-b627-0c21775825c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e1d73f2-aea6-41d6-8455-fff365692fcb",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b9675741-6650-4dad-b97a-17ab479ac8eb",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2f7bc250-df05-4cac-8a9f-b0cb62d2b5d7",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "7762a168-d8dc-49ca-b64d-529858202503",
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"StatusType": {
"StatusTypeId": "2000ca66-3639-4673-93b0-37d01999385b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "02777940-98ba-4c2c-b627-0c21775825c1",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "5e1d73f2-aea6-41d6-8455-fff365692fcb",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "80c1da4b-cd89-43d5-83fb-92ff73f4912e",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "24bdbff2-8647-4ccf-ad77-a105bca34c14",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a5859a72-8298-4919-8025-4989c098b13d",
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "6f5e9ece-204f-4f1c-a49e-1dcc6fe571c7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "3d29a44e-4a2a-4346-b64e-102e531d080d",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2360e39c-1b04-4db7-9676-01b2493e7d50",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "0bbb7d83-1c38-405d-8d3c-c45c68cd7c6f",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "cf608990-a3b1-476b-b168-73febc724d9e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1ef7189e-8a24-46c3-a4ee-af0b821bf367",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5798f174-9365-4a97-9dea-0c8225c6b793",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-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": "fc1acf53-ece7-4664-88d6-6fbe77eb5930",
"Asset": {
"AssetId": "0e4894f3-afd7-4346-9077-f65e3cbc41e4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3854fcaf-914d-480a-a4ec-c1d82a49a39f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a4f1803a-026c-4c3c-a875-2e6a9eacef07",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a6d8870b-07d7-4cee-a64b-0c56c73731b9",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b793a1d-f414-4d68-a55d-c7b0425b715f",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "232d1659-55bc-49df-a622-491f2e83df3a",
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"StateType": {
"StateTypeId": "d5c561ec-4cde-491d-adc7-dc0a7bf4bc9c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "3854fcaf-914d-480a-a4ec-c1d82a49a39f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a4f1803a-026c-4c3c-a875-2e6a9eacef07",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "44816f57-0efe-4747-b1b0-925e72ea1a40",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca27cf5c-3546-4d29-8691-244f4dc8a720",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "3533c1ec-f416-4ac6-8c07-8a6c8f546d7f",
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"StatusType": {
"StatusTypeId": "eeafd85d-4648-48e7-b5a9-596383029f03",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "3854fcaf-914d-480a-a4ec-c1d82a49a39f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "a4f1803a-026c-4c3c-a875-2e6a9eacef07",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b38accec-fa41-4dcc-bd26-a56e3590e868",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1bdbde57-e84b-46c4-b1d4-822aad0587f6",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "fa8ee8e6-21f5-4e1c-bd24-7585da45c7ff",
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "5f7b689d-1986-4278-aa65-11b9658e5551",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a61df8af-8129-437e-8bec-f61368dfb055",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7d0244b9-0058-4b48-8865-96cb961516aa",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"MeasurementValueNeededDate": "2026-08-04T17:24:58.4189497-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "1e2583a0-a899-48f2-b5be-79d1ca42a259",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "feb7e582-921c-4896-b782-35d09d996733",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "93479807-f89d-41b2-bfe8-9df54605c4ee",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-04T17:24:58.4189497-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5771c3f7-7db6-41f3-adca-1f061c78acc8",
"CreateDate": "2026-08-04T17:24:58.4189497-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-04T17:24:58.4189497-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}