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": "26f644f5-df62-47d7-8dd7-3083fa234716",
"Asset": {
"AssetId": "c134a647-3ed6-4701-ada3-a87544660685",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b95bc692-2050-4079-9e60-4a6a13234427",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18e6aabe-ce2d-4975-9e37-79f0986286bc",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a32cbd6c-cbbe-4ddc-9a66-d34b05b5db95",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"MeasurementValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5a14ac47-227d-4db7-8cd0-bdc3f6217b34",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "096a2b9e-8124-4ab2-af01-2beb086dc720",
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"StateType": {
"StateTypeId": "262432e9-5776-472f-9d4e-06b8ec1cdf23",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "b95bc692-2050-4079-9e60-4a6a13234427",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18e6aabe-ce2d-4975-9e37-79f0986286bc",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "462bcc0d-39c8-4d04-8891-f9476e7c07df",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f77b2633-e406-40c6-aa5d-9e143ba8e1c3",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "f354e80a-0ff6-4388-adbb-142e9340658d",
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"StatusType": {
"StatusTypeId": "bde20b76-45fe-410c-8d85-25f99c546420",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "b95bc692-2050-4079-9e60-4a6a13234427",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18e6aabe-ce2d-4975-9e37-79f0986286bc",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a6af6219-d52e-40b8-b652-d52ce255d8d0",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "de592b6b-a0e3-4074-a057-ac845251f514",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "2e28e6d8-5982-4529-b1c7-e0d1986d42b3",
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "112fcdfd-372d-4241-bd75-b12fbdbb9a97",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c3bbfad6-6dd7-49f0-9bfd-5ec315e899d2",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ee2cbe83-a03a-44e2-b310-0cd31098b74c",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"MeasurementValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "52c227f8-9f52-441a-adc1-c741ea475258",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2c485509-0b1a-4aaa-aea1-64a8cf11a7ef",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8e562d59-671b-4db8-84ea-da732409b904",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6d9ea2f9-25d2-4105-a780-b433a713b567",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-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": "ac796475-3965-486f-be04-69d76bbf486a",
"Asset": {
"AssetId": "e1ba9ea2-cc78-4e1a-9b2e-f0c8f3465cfc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2ba2d430-9c2f-4357-a53f-535ceffd15fa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "65242e23-8779-4580-a53f-70c9f6f9b3f8",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "919e5c9a-fd9c-4de4-9e58-cc1dd0dde03c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"MeasurementValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "cb0b486d-9a72-4b40-b6f5-3ba3f747cd7b",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "659182fc-4a7c-4366-9fe3-cccee6078640",
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"StateType": {
"StateTypeId": "a0ba5699-1eaf-4732-aa9f-b2f0bb5c40b3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2ba2d430-9c2f-4357-a53f-535ceffd15fa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "65242e23-8779-4580-a53f-70c9f6f9b3f8",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "baf019f2-cb59-4ec4-a03c-f85de47e8eb0",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a7883f2b-8cb4-4c6a-aabc-4b51c0acf6e8",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "40a66705-2de4-4d3d-8302-443d796d9e77",
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"StatusType": {
"StatusTypeId": "df7f067b-d452-470c-a622-27fc6c4c8f5a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2ba2d430-9c2f-4357-a53f-535ceffd15fa",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "65242e23-8779-4580-a53f-70c9f6f9b3f8",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "b21cf264-e820-4b57-b4a1-3d4e23d7fa85",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "229fad3a-9d62-4514-b406-99756dfc6541",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "78c1fbba-5fd3-49bf-8351-79b4c993274a",
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c15c9463-1951-4cd2-85fc-e74bd2cf196b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "46692dd0-557b-4881-b93f-f10f8cc65810",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "36785f8c-0e57-4c68-a420-41d6e4256a1b",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"MeasurementValueNeededDate": "2025-05-08T13:46:42.7862017-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fdd882b4-dd9d-45d0-a484-0d3ee98fdb68",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "c2844f62-465b-4d25-8d26-f5bc3cf950c9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "ffa4f7cd-f260-4b8b-a70d-c98c7c527898",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-08T13:46:42.7862017-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "52b7dd2a-0eed-40df-af87-f689267e42cb",
"CreateDate": "2025-05-08T13:46:42.7862017-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T13:46:42.7862017-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}