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": "ac91af06-9b40-4405-b38e-37992487f4aa",
"Asset": {
"AssetId": "7035738c-9b43-459b-bb38-4384ba1a5b02",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "99e0c025-7d40-425d-b1a9-a3ec03e4854d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3bd6ebc6-0d01-472b-9ce1-49fc99109845",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "87a93935-c6f8-43d3-982b-83d77401283b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-01-02T11:30:03.7870417-08:00",
"MeasurementValueNeededDate": "2025-01-02T11:30:03.7870417-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "77a09434-9f5e-41bc-8aa6-f1856aa61a25",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "d33adc91-4248-4995-9910-11171e46eba2",
"EffectiveDate": "2025-01-02T11:30:03.7870417-08:00",
"StateType": {
"StateTypeId": "3b6f0746-193d-4731-8bf8-ccce06f15830",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "99e0c025-7d40-425d-b1a9-a3ec03e4854d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3bd6ebc6-0d01-472b-9ce1-49fc99109845",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "76f92998-3ef6-489c-9c6e-7b5da8fdd2dd",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "173b049c-a3be-4ab5-b111-fe3ef6483065",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "ede34bc6-e460-4e3e-95ce-29dc1b2af661",
"EffectiveDate": "2025-01-02T11:30:03.7870417-08:00",
"StatusType": {
"StatusTypeId": "820c264f-9800-4f0c-b4f8-d8b215fd2d2e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "99e0c025-7d40-425d-b1a9-a3ec03e4854d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "3bd6ebc6-0d01-472b-9ce1-49fc99109845",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "e610276f-5bb5-4be6-a1c7-a35ddd251776",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c0c87cf9-e981-4677-a7fc-4c98688022c9",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "a3a4420c-f645-4757-b9dd-8306f2e8ac46",
"EffectiveDate": "2025-01-02T11:30:03.7870417-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "742bbf4a-9d1c-416d-acce-707642ab0c4b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cadea16d-9925-4e4f-8aca-384a32cec78f",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ecd257cf-23a3-469d-847f-c9261b3dd9e8",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-01-02T11:30:03.7870417-08:00",
"MeasurementValueNeededDate": "2025-01-02T11:30:03.7870417-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "b7dcdbbd-6ddc-4f4f-949c-a008ed66f7d7",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "115850e7-90ad-42ed-b049-077d271c21f0",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9fab2aa4-0fa6-4e56-a1f7-45ff60aa259b",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-01-02T11:30:03.7870417-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d0113ce6-6a90-46b8-9311-badb56665247",
"CreateDate": "2025-01-02T11:30:03.7870417-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-02T11:30:03.7870417-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": "0e52a3d8-3623-4b46-aab4-6f41471b7506",
"Asset": {
"AssetId": "aff17a05-155e-412d-b60e-c4dea6d32403",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f9eb2f0c-dcb4-464d-b15c-46004299be53",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fa426df9-9f3f-4506-bd5d-c0ce547c5ec9",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "80a119d5-4648-42c6-950d-cbfd1c02299d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-01-02T11:30:03.8026716-08:00",
"MeasurementValueNeededDate": "2025-01-02T11:30:03.8026716-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bfe875bd-1d9b-4a8e-a78e-b84b4f8ffe3f",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "748de8c9-dc83-48aa-8f98-3185d9625e87",
"EffectiveDate": "2025-01-02T11:30:03.8026716-08:00",
"StateType": {
"StateTypeId": "d8125ef5-f66f-4e32-b3c9-6fb8b917795c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "f9eb2f0c-dcb4-464d-b15c-46004299be53",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fa426df9-9f3f-4506-bd5d-c0ce547c5ec9",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "c610f7b0-40fd-4cdf-ad79-b16c143941f8",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3d89c9ae-a39a-49db-8d79-3bcf630b3435",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "10379273-c1cb-486a-a9ed-82b364503bc0",
"EffectiveDate": "2025-01-02T11:30:03.8026716-08:00",
"StatusType": {
"StatusTypeId": "fd964615-e356-4cd2-b976-33e355d0db2d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "f9eb2f0c-dcb4-464d-b15c-46004299be53",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "fa426df9-9f3f-4506-bd5d-c0ce547c5ec9",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "6d7d07e3-f461-4672-9af4-6f2dbd071c45",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6c3825ce-0f4d-43e1-bc20-e1bc9e5b3417",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "68c871ac-2868-487d-b3d5-85a538e9ede7",
"EffectiveDate": "2025-01-02T11:30:03.8026716-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "382515e3-16a2-4be9-b851-3ab77431b079",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c61c0fe4-7e9c-409a-9d5c-d527fd4ceb88",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "18f6ecd7-7af1-4832-88a2-fd2ba82ed7c7",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-01-02T11:30:03.8026716-08:00",
"MeasurementValueNeededDate": "2025-01-02T11:30:03.8026716-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "9b74c4c6-8640-4b1c-8c25-54783b4a973d",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "70876ba5-4cd2-42e7-837f-bcc1994faac2",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9a482251-8bd9-462a-a8eb-825a0c0d32f6",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-01-02T11:30:03.8026716-08:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "51c091d1-6f20-45ef-8424-291349c78a1c",
"CreateDate": "2025-01-02T11:30:03.8026716-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-01-02T11:30:03.8026716-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}