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": "f1941eab-fe86-4b19-9067-18f173900b8f",
"Asset": {
"AssetId": "017d9f29-d860-49d5-b6a7-eca002491198",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2d348204-23a9-4f9b-936e-d28d487ef4e5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08f9616c-a472-4041-b02c-7320226715b4",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4ff771f4-6fe8-4128-8277-3543b6c0071d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"MeasurementValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9e93021a-c697-4028-b4e6-c7a6fc9272b4",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "ba6756c1-c46a-4615-ba56-b08cecad0156",
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"StateType": {
"StateTypeId": "3c41c08e-35a3-45c5-8e4d-d82514847246",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2d348204-23a9-4f9b-936e-d28d487ef4e5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08f9616c-a472-4041-b02c-7320226715b4",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "294ba399-9bd0-4f32-8943-211041f24965",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3e08f86e-cd68-4cc9-8379-e38ba1b4c657",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "d6b92511-4bdf-4c8d-8129-9c6bf534d75f",
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"StatusType": {
"StatusTypeId": "92f5915f-ac91-4c55-b343-35a9e6202134",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2d348204-23a9-4f9b-936e-d28d487ef4e5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "08f9616c-a472-4041-b02c-7320226715b4",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "c738e04a-8721-433d-b898-6aa11372191f",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "733ca7bd-146b-4195-aa4c-cc96932ee291",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5f401945-2d4f-45ea-b048-6426b9e7c054",
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "eaf96c89-4592-4c46-8ad9-0504dae014f2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d9029e81-4bcf-4815-8344-49c8c8df2b52",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8a436d95-2814-4367-9238-7b8d1acda327",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"MeasurementValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4f086c6b-568c-46d4-b6e4-0d807d77c4be",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "3e258b9a-7896-442e-a82e-61daff2d1ec9",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "98f157b0-907f-4a1d-9fc6-e12af275ec11",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "968dcbc0-809c-4560-8588-f8c01e5afac0",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T08:41:19.21788-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": "cca7d802-5082-4404-a6ec-70f34052fb3e",
"Asset": {
"AssetId": "1c04b467-2c18-4031-8e06-87d8637c25e9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "27a26745-ed1a-4c7a-8b12-c4924e1b5b10",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "df15b17e-94e6-4a70-9916-451d6e326c0c",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6cdd6317-fd58-4612-b13b-0a11ed0651df",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"MeasurementValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6180246c-819c-403d-99ae-37cf000dd27f",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "f99457e4-4c27-45c0-8d69-62eee806e147",
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"StateType": {
"StateTypeId": "861c2dfd-0924-4406-906e-048c66e9daa6",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "27a26745-ed1a-4c7a-8b12-c4924e1b5b10",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "df15b17e-94e6-4a70-9916-451d6e326c0c",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5856c918-55b2-45a6-a687-fea7cc96a87e",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "46b2ef5a-6688-4059-8a4e-d7b356a01fe8",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "95590c0e-39da-4dbb-a9e9-8c0fd37e5e8f",
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"StatusType": {
"StatusTypeId": "ca35b069-5a17-40e4-995a-867fffbdfa83",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "27a26745-ed1a-4c7a-8b12-c4924e1b5b10",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "df15b17e-94e6-4a70-9916-451d6e326c0c",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "cfeef3d7-b5d1-4253-8f5a-6456bea5af84",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7264c637-ee11-425b-80f4-a8d4b7642eda",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9aa34287-727f-40d4-ba65-7d3d991599b2",
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "a9f0db50-ec2f-4d69-b647-40b26dfd45d2",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "dee51a85-c539-41f9-a424-17a17e95f83d",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a5f29536-d595-4695-8a1d-af68b89048d0",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"MeasurementValueNeededDate": "2025-03-09T08:41:19.21788-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "68c82369-c756-4dac-a91d-5ecd1cbc001e",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "de9c5c3d-11b6-4272-9468-12608243ceda",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "9b140488-a697-42eb-a770-a691e15372a3",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-03-09T08:41:19.21788-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "12b643ae-e927-44e9-aa9d-89d0cd65db59",
"CreateDate": "2025-03-09T08:41:19.21788-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-03-09T08:41:19.21788-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}