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": "e950a0be-d2c8-4eba-83c0-4be4481d17f9",
"Asset": {
"AssetId": "78b5324f-5e88-4fff-b99a-bff37b2e4c91",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "11e4fcd1-c152-43e5-9390-f38d0791f60c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18d8cae6-18b3-4b54-b2a2-9aa94cf5e8ae",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "a38340ce-ee43-468e-b5c3-879349d1a513",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-13T23:36:32.562663-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:36:32.562663-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e15b0e75-7beb-4954-b9f7-19c86e3a157d",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c6923db7-46a8-4fc9-bc38-c14a44d9623a",
"EffectiveDate": "2026-09-13T23:36:32.562663-07:00",
"StateType": {
"StateTypeId": "e3293c1e-af43-4549-8c44-01ff56621a7f",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "11e4fcd1-c152-43e5-9390-f38d0791f60c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18d8cae6-18b3-4b54-b2a2-9aa94cf5e8ae",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "0fb26727-ef19-4ce2-b283-772249d17787",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9d3e07c8-2473-48bf-b5f1-4f27624be22c",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "1abd8637-8038-4695-a422-a07cc24a622a",
"EffectiveDate": "2026-09-13T23:36:32.562663-07:00",
"StatusType": {
"StatusTypeId": "cc1ef766-5a21-4cee-8e70-8960504dbbfa",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "11e4fcd1-c152-43e5-9390-f38d0791f60c",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "18d8cae6-18b3-4b54-b2a2-9aa94cf5e8ae",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "12a6f7c7-c0ea-4277-b05f-e43f479a4d4e",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0867dd2f-dce5-4f82-91cb-da16cca5255d",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "103af2ae-8f39-499f-bf2c-cc2fbbaca34f",
"EffectiveDate": "2026-09-13T23:36:32.562663-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "51242e71-9441-4f69-9f50-1408fcc33451",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "97d57dcc-a750-41c7-a970-5693046d3b23",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d91dc322-adc3-4468-99e7-ac585ad4ec41",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-13T23:36:32.562663-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:36:32.562663-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e1699244-463b-4b8c-96de-9b251f42f890",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "5ddea761-3bd3-4612-98be-c2b32164b98e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "10fde394-3cad-47b1-91a9-6d1082d9b5fe",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-13T23:36:32.562663-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-13T23:36:32.562663-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6d9e4f3d-bb96-4d8a-9616-2114f483cc4b",
"CreateDate": "2026-09-13T23:36:32.562663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:36:32.562663-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": "dca6db94-0aaf-4499-b1da-92a90970c8dd",
"Asset": {
"AssetId": "4140faf5-0e9c-4b3a-a50e-531af73245d0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0f4e58f9-8e2f-4253-9051-5229d3939b02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c92203fc-f140-4ae4-b15e-8f287de51896",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c060973b-73d3-4513-8437-daa9207f567d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-09-13T23:36:32.5782332-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:36:32.5782332-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "03729c7e-f997-41d5-9acb-9bf1a8523d2d",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "72c58c7a-9990-4bbe-8df5-8c363156f36f",
"EffectiveDate": "2026-09-13T23:36:32.5782332-07:00",
"StateType": {
"StateTypeId": "e0691d1b-dc6b-47ce-9c49-43420e6243c4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "0f4e58f9-8e2f-4253-9051-5229d3939b02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c92203fc-f140-4ae4-b15e-8f287de51896",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d217253d-8d58-4d02-9e84-2f6b6d55ad65",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "f333f63a-6a1f-41f1-81b9-568a9a856ce8",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "9432991b-7862-4f0d-bd34-46395d2c7efe",
"EffectiveDate": "2026-09-13T23:36:32.5782332-07:00",
"StatusType": {
"StatusTypeId": "dd2140e2-bdf9-4686-b66d-3a1ac54eba3a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "0f4e58f9-8e2f-4253-9051-5229d3939b02",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "c92203fc-f140-4ae4-b15e-8f287de51896",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "63aba21e-2a2a-4519-b0cc-41b710848086",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9e701651-36f0-4f19-a6a9-3881b39fbe76",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f6e0432e-0393-41ab-91e9-f5ffea694c88",
"EffectiveDate": "2026-09-13T23:36:32.5782332-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "9a7d1aef-cbce-48c8-91a7-7560a4b0fd52",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "d93fa1e6-9754-472b-a114-e9310c4505c5",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "21b2a48e-a127-4665-9a45-e32d187d66fd",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2026-09-13T23:36:32.5782332-07:00",
"MeasurementValueNeededDate": "2026-09-13T23:36:32.5782332-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7fa70f94-29c6-43e7-9392-dc9055a8681a",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "45cbfc22-9918-43c6-b237-ca29bd6b576d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "b696a4f7-958f-4c4b-ad0f-292bd86a9f44",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-09-13T23:36:32.5782332-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bbde0235-ea90-45d2-b144-73181c817995",
"CreateDate": "2026-09-13T23:36:32.5782332-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-09-13T23:36:32.5782332-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}