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": "eef61ea6-79fd-4a79-ad6e-87a63f39ef5a",
"Asset": {
"AssetId": "62ed84f7-0cf0-402d-8201-07000375cced",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "193bb275-dd7c-4311-8152-74ed97b4e58f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "779b3a05-533b-4208-8734-a09979010d00",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a393df96-6ea4-4243-b516-41b2ca7a18b4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:50:26.6828991-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:50:26.6828991-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "09095d79-e51b-47ae-874e-19292e7b3941",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "3e080808-cab3-46c4-afd4-e93233ccd082",
"EffectiveDate": "2025-04-17T03:50:26.6828991-07:00",
"StateType": {
"StateTypeId": "2f5e0530-fa09-4401-b3e3-af3bc4497d16",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "193bb275-dd7c-4311-8152-74ed97b4e58f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "779b3a05-533b-4208-8734-a09979010d00",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "94478c50-214a-499d-a6ba-3c6a8b4559fa",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4b8c5f4b-04f8-4a5b-883e-5674d94b342f",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "693f6a29-9bd0-4e0d-a6b5-3b19900741aa",
"EffectiveDate": "2025-04-17T03:50:26.6828991-07:00",
"StatusType": {
"StatusTypeId": "d7d7119a-514e-4f98-85ea-7d52a4d552fc",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "193bb275-dd7c-4311-8152-74ed97b4e58f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "779b3a05-533b-4208-8734-a09979010d00",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "1a216207-7caf-4e3c-93ae-91f9eadb8bce",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "80d6aa83-dcdc-4633-bfe3-63a65ee9c7a6",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "0111fe48-ec0d-4396-96bd-46f0eb58fdee",
"EffectiveDate": "2025-04-17T03:50:26.6828991-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "8b45833a-a8dd-45e2-bc89-41788e8907bb",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1d8f3755-47cf-45e1-aea9-78d919d8183a",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "1c470f07-a29c-4e48-a31a-f33a15a20fc9",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:50:26.6828991-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:50:26.6828991-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "88f267a3-8841-4538-b772-18ed456c07b4",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "405ef4b4-8fa5-472f-ac3c-d8f19da87bfd",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "7150d8bc-3f81-4234-9195-49b3984b2f98",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-17T03:50:26.6828991-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "10c0ae2e-30de-4c70-8c4b-015e9984892e",
"CreateDate": "2025-04-17T03:50:26.6828991-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:50:26.6828991-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": "2df7f74f-dcdd-4e68-b76e-11b37062d45f",
"Asset": {
"AssetId": "8b4ebe19-058c-4131-bc88-4b7d638dabe6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "16c61fb0-5baf-4248-9392-6516a8f84937",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "eb731fac-8383-42ef-b36f-e0f64f838ed0",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6650a39d-f8f7-4c3b-b120-fb611b5a3788",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-17T03:50:26.6985136-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:50:26.6985136-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "bc269db9-fd99-4be9-ab41-07e4b42e9f07",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "df3fb9cb-5552-45c4-896d-4d157e9e96a3",
"EffectiveDate": "2025-04-17T03:50:26.6985136-07:00",
"StateType": {
"StateTypeId": "70b81dbb-4046-44ed-b6d6-f7f1462918ea",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "16c61fb0-5baf-4248-9392-6516a8f84937",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "eb731fac-8383-42ef-b36f-e0f64f838ed0",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d813faab-0bd3-4cb6-ae2d-6ce78b623a17",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b873764e-dade-4ef3-bf2d-a4edf13ef497",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "5ebe02b9-c75c-4095-bac9-a8c4e764558e",
"EffectiveDate": "2025-04-17T03:50:26.6985136-07:00",
"StatusType": {
"StatusTypeId": "5366ce9e-c389-4718-89b4-7288f4ae7e9d",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "16c61fb0-5baf-4248-9392-6516a8f84937",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "eb731fac-8383-42ef-b36f-e0f64f838ed0",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "dcacc7cf-18cd-47c5-9e1f-8f3142a4f80e",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7e52cf23-f4f3-4273-a288-a1d302986995",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "814ec618-e2bf-41b3-884c-92eba90b1975",
"EffectiveDate": "2025-04-17T03:50:26.6985136-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "42fa0da5-2f73-44b7-a58a-25def43694ef",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "97dfa1ad-901a-4b76-a3e8-6682859986da",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3543a38f-e325-4389-b478-4330eb2b0958",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-17T03:50:26.6985136-07:00",
"MeasurementValueNeededDate": "2025-04-17T03:50:26.6985136-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "fc4bc666-0573-4e24-b55c-6d30e834b119",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "915d2b83-80ac-4036-839d-fcf895c96141",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "fa7b5881-3beb-432f-85e9-bc26139667cd",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-04-17T03:50:26.6985136-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f3c22cd3-58d7-4096-b0a1-189c14c022b1",
"CreateDate": "2025-04-17T03:50:26.6985136-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-17T03:50:26.6985136-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}