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": "dd785a83-2d41-495d-8c7c-5761d2e4ff9c",
"Asset": {
"AssetId": "3d53597a-3f70-4007-ace3-4d22fd9bb66a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fb93b304-8aeb-4d91-87ee-82e1a48f8013",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f4030ab6-edd6-4e86-858f-3e2ad279aff6",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "b51cbd7f-fad3-4cc2-a9a4-b491e2ba98c8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"MeasurementValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6c9bb43c-4d43-4e5a-b119-6888f9c84a15",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f2fec058-95d6-4979-8218-8e371e8c96c0",
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"StateType": {
"StateTypeId": "33739067-ed79-4868-8d67-95a6b6014174",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "fb93b304-8aeb-4d91-87ee-82e1a48f8013",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f4030ab6-edd6-4e86-858f-3e2ad279aff6",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "b2ea7202-b7b7-44f1-bea1-d1380d06b917",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7b285813-cb93-4e4d-ba52-dd46772cb166",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "42a5cdda-61b6-4aeb-bbb4-b44b575452cd",
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"StatusType": {
"StatusTypeId": "e8e779cb-a4d8-4baf-86aa-40c99d4737bc",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "fb93b304-8aeb-4d91-87ee-82e1a48f8013",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f4030ab6-edd6-4e86-858f-3e2ad279aff6",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "da1fa0ba-fcd0-4a07-b15e-4c32f6a1cd52",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9472ec4f-ff1a-4a91-8eeb-f668f4e8de8e",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "d6a9fa84-3c6c-415f-b12b-d23a034ed7e0",
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "d9f262b0-605a-4694-b152-cb30c6a09434",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "2b875e15-309c-463b-8bd2-1d76c1408270",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3047ef96-506e-48d5-885f-9fb5846fbf17",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"MeasurementValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "55a19a4e-1e42-4239-b436-3d228ae2f0a2",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "e724c3eb-9f4b-4fcd-9411-70f45ab60666",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "96a268c8-7b4b-4da8-91d8-92bd19d2b1a2",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5f08b463-2ac2-4fe6-8f8a-8c4594d3cf37",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-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": "3a3ccc65-b2b3-41b3-bbc7-0a6f8f25dcb6",
"Asset": {
"AssetId": "30a09959-7f9c-4787-b273-e2fad61b12fc",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "14cd7530-1078-4e3f-9c56-a29552390bd7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9aa9a3f9-242d-403c-9709-2224050b7fb1",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "38eebb5f-8043-42ec-9152-25a542fdfecb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"MeasurementValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "66106a89-ac9c-49fa-b7fa-44288ded2def",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "698cd4c1-2e1b-439f-b45e-2c90df2cd7ab",
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"StateType": {
"StateTypeId": "6b4d7ee0-392d-408e-b0f1-a42575e99cb8",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "14cd7530-1078-4e3f-9c56-a29552390bd7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9aa9a3f9-242d-403c-9709-2224050b7fb1",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "735078dc-ef52-4184-a428-626a2694957d",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "550da9c8-65e6-45b5-94bd-2f9370c23650",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d8c55470-cc12-4864-a398-142c2a9c2981",
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"StatusType": {
"StatusTypeId": "584356e3-82e5-4471-8c8d-694b33f54ede",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "14cd7530-1078-4e3f-9c56-a29552390bd7",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9aa9a3f9-242d-403c-9709-2224050b7fb1",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "aecc34bd-e329-4d40-bfad-d18934f9dfae",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5229de64-b56d-4d0d-a858-2d5df6dfef28",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "6485484c-5fe1-4570-9160-ee967557af16",
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "0ae645a9-8f75-4486-a6c7-923cf032a004",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0bbf63d9-77c8-40a4-9d9a-fcbec74d0991",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ef1f7641-5608-44fb-8494-af6a48f0b62d",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"MeasurementValueNeededDate": "2025-04-25T13:31:07.3614127-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b9153408-2f61-4e7d-ac96-6890ca320409",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9563df92-645c-4e2e-8c06-a12c4e38c822",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b8e3e5d1-f9fa-419a-b3e8-ff0750283bf2",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-25T13:31:07.3614127-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "7dd8f5d1-8b7c-430a-a50f-9844481f8486",
"CreateDate": "2025-04-25T13:31:07.3614127-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T13:31:07.3614127-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}