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": "e1bda131-1c46-46de-92f4-c88bcb03afe6",
"Asset": {
"AssetId": "ad7230f6-5a74-4e15-830e-cd632c05ce1d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4e52b7ed-8bb6-4684-a270-04b527d3eb05",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63e6141c-6102-4dbf-9d6b-3fe4200ada38",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "841380b5-7aa1-4540-854f-5fd59561359b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"MeasurementValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5c2b3505-e2a4-4c16-8414-576dc2f44f2a",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "103e3373-806c-46f1-b788-b96fc03ad036",
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"StateType": {
"StateTypeId": "becc62f3-2a4a-45c3-9247-79ce006c1a59",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "4e52b7ed-8bb6-4684-a270-04b527d3eb05",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63e6141c-6102-4dbf-9d6b-3fe4200ada38",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "8aa40aa6-a587-4389-9f8b-9c0e16a71459",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "607a5a1d-abe1-4094-9713-8c3d7c095e43",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f080f7e3-2c92-4351-8192-e7d9a60a27bb",
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"StatusType": {
"StatusTypeId": "8aacfc5d-845e-42aa-98a9-45eb9f8da43d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "4e52b7ed-8bb6-4684-a270-04b527d3eb05",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "63e6141c-6102-4dbf-9d6b-3fe4200ada38",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c31abd3f-44c5-4efd-a6e9-ef38b108451d",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "fb4ad3a7-eb55-4d65-866b-6a5e0985794c",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e125a149-e305-46d3-8a59-d164f88b4912",
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4cfcce38-fe40-4969-a166-db4bafdc2a12",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "8edb3803-83f1-457d-8566-2f4a64fab9a1",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "bd691fe7-d0c5-4eae-8126-bd1cd92a185a",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"MeasurementValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "09476340-74f6-4ec6-971d-ab70f20f0652",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c286fc65-7c39-4772-9f42-0f47258a8012",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e3bcd491-80d9-41df-9027-88f8b9de1838",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "43ad424b-6dad-4617-9805-4beadfc9d4da",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-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": "3a521fef-806b-4c67-b109-65e39276f75e",
"Asset": {
"AssetId": "6e1e3623-7fe0-4b16-b657-32e72299b7e0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "969078f0-53dc-4380-8aef-edb3bde6f525",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9e7e61e6-7776-483a-ba5c-63ed8f471af6",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "f6963e90-c97c-4b18-a5d0-a4042200d097",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"MeasurementValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "55349b49-d7b5-4bd0-99fa-83883b3a48fb",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "468d08b4-4e8b-4eb1-a00a-e1b5fc5fe19f",
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"StateType": {
"StateTypeId": "fa1cace4-a253-471a-bc64-b16ad8a0dd97",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "969078f0-53dc-4380-8aef-edb3bde6f525",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9e7e61e6-7776-483a-ba5c-63ed8f471af6",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "7d8d70e4-b86b-48c1-8f5d-4942dd4fc600",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "41adbfc2-e0ae-4ae3-8447-f055297d00da",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f4947eee-a6c7-41cc-97d4-f68a3a2f98b9",
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"StatusType": {
"StatusTypeId": "e53ee545-b7e2-4a08-8ab8-1fb14cb81b2b",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "969078f0-53dc-4380-8aef-edb3bde6f525",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9e7e61e6-7776-483a-ba5c-63ed8f471af6",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "29826b71-c134-44d0-b7b7-06efdc88c9ee",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "54fa5ad8-1bcd-4251-81c1-2a81d2913755",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "724d85a0-ab82-4ad5-9e9c-6b7114c924b5",
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "67acc336-8e51-4a4e-adcc-80d866f8665d",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0262cd80-494e-49b4-83d5-8ee5268e2ed9",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9e9e6ba1-8314-4408-a095-496290e4ab30",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"MeasurementValueNeededDate": "2026-08-24T10:45:21.0511823-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "a135f0ee-4c51-433c-8354-1dadc316bbe6",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "75e8c1ea-6c8d-41c6-9b9a-d510be79861c",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dbe84399-1b06-4dc8-9347-4718176a3b0d",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-08-24T10:45:21.0511823-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "652071e9-8b1a-46f0-ac57-4a83e1403c95",
"CreateDate": "2026-08-24T10:45:21.0511823-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-24T10:45:21.0511823-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}