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": "676299c4-853d-4e65-9398-2e4e0e32ce75",
"Asset": {
"AssetId": "b85cb7e3-6bfc-434f-af69-86ff1910531f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c9b2a596-22b5-4cce-bdc1-69461a9d22d9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "61bde395-89b0-4239-8d9b-eb4e10efb899",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "e4e28854-a006-4262-be87-18891e8afa06",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"MeasurementValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "3a7f1b97-9184-4eee-8819-97b8ff2ceb1a",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "355b05e6-5634-4c9e-ba68-10e57b9c69ec",
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"StateType": {
"StateTypeId": "8517196c-bb9c-45a5-a315-5b7c8bac5ed8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "c9b2a596-22b5-4cce-bdc1-69461a9d22d9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "61bde395-89b0-4239-8d9b-eb4e10efb899",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0b0e9c94-3eb5-409e-b9a3-6fbd378d492e",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c2a9d54a-62d0-40e8-b595-fb7799c10b7a",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "494797ee-b270-4d79-9e4d-0ed8f897763d",
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"StatusType": {
"StatusTypeId": "badec75d-8601-4333-a828-940e1d5a92a9",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "c9b2a596-22b5-4cce-bdc1-69461a9d22d9",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "61bde395-89b0-4239-8d9b-eb4e10efb899",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a027731e-6a39-4f06-a22c-e54228fb0608",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "43d5ec04-c65f-44e2-b7df-c134cc682432",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2eb1ee68-faec-4e7c-92f4-2f05e1e7b4bc",
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "cdbe8009-9db4-4705-9784-abeedaa93773",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0a0db8fa-9141-4b59-bc16-8a62d6c3ee4b",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "19566d9b-49dc-4d50-99ff-b38061381d3e",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"MeasurementValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b44527ab-07c1-43f6-b80a-c5b8f8473ba4",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "bf888157-eed8-49c1-9956-306df50a72de",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "87b068ee-ad48-4fba-8a6b-b79da26fb07d",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "28efbb35-c933-4667-9891-8ee5bb274887",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-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": "2cf25cc4-dae8-4d18-bd8b-abb3a243c144",
"Asset": {
"AssetId": "28f8c788-c98f-4ca9-a07e-89f8bd677756",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9bdb5faf-2e28-4bc9-b6d7-a94045e32385",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "02c1545a-5d92-429d-bed6-0e42959c181b",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f2439522-90c1-469e-904d-4d5830a1914c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"MeasurementValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "204d162a-b604-4797-8854-7b22f157cc25",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3f741132-83d2-4b79-a568-5453ade93f25",
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"StateType": {
"StateTypeId": "ec89fc19-517e-4610-b405-0bd4a9444437",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9bdb5faf-2e28-4bc9-b6d7-a94045e32385",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "02c1545a-5d92-429d-bed6-0e42959c181b",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "46d449f7-fd32-4b8b-bdd7-3c3926257378",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d3d6ff0f-6091-43eb-ab83-0256454d5211",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f1fe6609-416e-48a4-9db5-97c820a48df3",
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"StatusType": {
"StatusTypeId": "8be020b7-6634-4b02-b3fb-49ecb725a1d5",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9bdb5faf-2e28-4bc9-b6d7-a94045e32385",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "02c1545a-5d92-429d-bed6-0e42959c181b",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "05b4f5cb-b01f-4c05-aa85-ea0790894653",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0b99c62f-7ad2-473b-8bce-4a347ef8d1f1",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d808e4fe-f961-4ccf-b505-69b465900110",
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "3e4efa18-2c40-4122-818c-5b86c589bb79",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0c2cc871-6fe7-48c8-9ad5-3fce1a9d0192",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b45d2b57-a47a-4ab5-9f8d-345a19af71f5",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"MeasurementValueNeededDate": "2026-03-15T17:58:45.0567286-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f8ce3f90-0081-4374-87ab-102cb115f80f",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "faf85e8b-8d0e-41f0-8929-d740781250a8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e0656dcd-086e-4722-9c19-707c85761b77",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-03-15T17:58:45.0567286-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "e8cae775-5e20-4f52-9b39-047f1c158c07",
"CreateDate": "2026-03-15T17:58:45.0567286-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-03-15T17:58:45.0567286-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}