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": "d8a5b169-3e8a-4eb4-b800-916db3cae74b",
"Asset": {
"AssetId": "b10e7894-c971-4495-8d8f-cef1ec7ebb4c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "6fd5e48f-3bcb-462f-91b1-f3c29e03223d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "41f7b3f8-11ec-4aaa-bfe6-f4d74de1ed50",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2b9a9a86-2709-4d1e-8de6-672679bbed38",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "01933d4b-2bd7-43f2-bdb0-673868d6bee3",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "673b7b1e-bcd3-42bf-85ab-a88db658eee6",
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"StateType": {
"StateTypeId": "b1ff5426-ef5f-486a-9b8c-146fb3f19b14",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "6fd5e48f-3bcb-462f-91b1-f3c29e03223d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "41f7b3f8-11ec-4aaa-bfe6-f4d74de1ed50",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "4b65f525-f055-4b54-9157-92702e2a95d7",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b56fc2a1-eb9e-4db2-815c-3aefbddea7f1",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "b7d2cbb3-b6a0-4c1f-b868-1d7a8e07b2f0",
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"StatusType": {
"StatusTypeId": "7c58a42b-1678-4b66-8642-a214fbfffb01",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "6fd5e48f-3bcb-462f-91b1-f3c29e03223d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "41f7b3f8-11ec-4aaa-bfe6-f4d74de1ed50",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1cb5cfca-1342-4e57-849f-b76633adaec8",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5f8e11db-3541-4f7c-a56f-34f3b142f7a8",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "25084f5d-67e6-49c7-888b-8b62dfb8ca83",
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "75de563d-0722-4c1d-97a3-7ecdbf3b05d2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e5fd8cc0-71ba-4694-bd9d-21d545f1faa3",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "94d9d134-03d6-444e-bc1d-daa1c0aee64b",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "61e496bb-cd76-4c15-8721-dbb8caa2fd85",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "00e855e2-11b6-45a8-b2f0-7dde371927be",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d642d808-b31d-4153-9500-6e301379bb41",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "575d2019-9f52-4dca-ba0d-b910c67937d6",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08: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": "422f4b99-8b7e-42f1-abce-b4c725ad3641",
"Asset": {
"AssetId": "feda984f-9de1-4648-9db0-77554a069652",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d29c841e-7923-4361-987e-23a5527d046e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "408e6610-d207-4a49-ab7d-dcaae46776d6",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9fc625b8-92fc-4669-b1ab-ccdeb10818b2",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "643c5451-e7ff-4151-9e93-d7661c73e97a",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b44c1e3c-e68e-46fc-9cc0-5c4b62589c2a",
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"StateType": {
"StateTypeId": "3a152cfa-09d7-48b9-8deb-74c0d959d1a4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d29c841e-7923-4361-987e-23a5527d046e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "408e6610-d207-4a49-ab7d-dcaae46776d6",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d81f7f2b-4c58-4345-8641-4c33e0be0347",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5d61afa2-9fd6-4f54-90ab-f27b7745b5a6",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "fcfab65e-ff68-4de0-9dc2-b8c72330b8f4",
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"StatusType": {
"StatusTypeId": "efc62193-a807-4a83-883c-d4e84ff27783",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d29c841e-7923-4361-987e-23a5527d046e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "408e6610-d207-4a49-ab7d-dcaae46776d6",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "8d5e77f7-c2b0-4995-a51e-3a9b677426e3",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "82ab32e0-88cb-4aa8-aff3-f7ae9a4dfbfc",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "b396f6d4-094e-44df-a118-00252a693563",
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "26c4057d-be1f-4f06-89ef-fda3638b066e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "e906db34-93d8-4a6b-a986-d4def42e10b8",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6912b4f8-6919-4dc2-a5ef-72ff9f7a17ad",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"MeasurementValueNeededDate": "2026-11-01T08:53:14.0390158-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "bf20638c-921c-486d-87a9-56b62eff6461",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "b53255cc-7933-4186-ae23-5c2fcd6057f2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "77132375-e663-4d0c-ab51-2a5c00c72dc6",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-11-01T08:53:14.0390158-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "5cdd8402-fedc-477a-9bc4-a884fb73bf39",
"CreateDate": "2026-11-01T08:53:14.0390158-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-01T08:53:14.0390158-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}