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": "1478e3c5-827f-4171-82cc-54bbca195341",
"Asset": {
"AssetId": "2431282a-994a-4e93-8675-32f8412c790f",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "07871562-86ca-4a0d-8a78-b66f6855455f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cff70441-aeb9-4913-9c4d-11fbf50689e4",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "de9032dd-46d0-4895-b09f-3616a9943bbb",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "137018b1-4125-45e9-a244-9b46e83c3823",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "be2746b5-d96c-41f7-9eab-198e3d824175",
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"StateType": {
"StateTypeId": "7fd6e9b6-25aa-4727-bb87-47cc8825446c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "07871562-86ca-4a0d-8a78-b66f6855455f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cff70441-aeb9-4913-9c4d-11fbf50689e4",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "1d955d2b-3c39-43fb-86a5-5b204dcae366",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "169fe5dd-a9b9-4467-a98d-4ee3a28ffcb2",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "e63e0181-7a51-401f-bc0b-750065fdaa15",
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"StatusType": {
"StatusTypeId": "df4ba4cb-0cbf-4d6d-a655-ed6addc61930",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "07871562-86ca-4a0d-8a78-b66f6855455f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cff70441-aeb9-4913-9c4d-11fbf50689e4",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "9f7ce62d-8ba4-4cde-b8b8-5e4ecdd251ec",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6d3678eb-7104-4048-9a91-82b4690c8fae",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "e24eb186-3727-483b-90ac-9bff186bb49e",
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "19c7103b-4035-4b55-81fb-e26f5f75314b",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1df503d3-c17e-4de2-951e-f7ff1b291a1a",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d15d7867-0b77-4c5d-bd87-dc93a65beb64",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f27df8ac-341d-42cb-bd5f-7955bdefaba6",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "4ca897b6-f03b-4d23-83ff-489a3358d284",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "1c612b83-52f6-4d97-bb7e-cfd26fe2196e",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4f6d2ec1-8f55-43be-9432-0ba1673cd1ae",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-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": "5864519d-927c-430a-83ff-b98668ed6d4c",
"Asset": {
"AssetId": "ebbf9703-a22a-4f40-8633-5155a56caefa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "047955f7-d8a6-488f-8788-42eddf5ba925",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d155edd5-b04a-471a-826a-e0d1d3e2a5b4",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "415a4775-998f-4a2d-b592-0c592db10765",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a595be6d-8a3f-43fa-9b21-da9f02f784a1",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "cd50d8fb-f63e-4095-a381-37fa1cd40673",
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"StateType": {
"StateTypeId": "9a9bcb65-5dfb-4088-ab6f-88fefe33f9f5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "047955f7-d8a6-488f-8788-42eddf5ba925",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d155edd5-b04a-471a-826a-e0d1d3e2a5b4",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "5b18cac9-1de8-42c5-9131-f4491edad12a",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0f4b72c9-d93e-45cd-8458-828c869c805f",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "50a08b11-0e39-4991-8503-c2597f119435",
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"StatusType": {
"StatusTypeId": "6ac96730-ca76-4ae8-80ee-547e27a36683",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "047955f7-d8a6-488f-8788-42eddf5ba925",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "d155edd5-b04a-471a-826a-e0d1d3e2a5b4",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "979963fc-dde0-4cd4-b8d3-e639f9019540",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "cafd204d-5b43-4e9f-8d32-ae591e0879cc",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "07a43624-815e-48be-964e-f8c919a822d0",
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "14b15ae6-9919-4ac2-a3dd-d3cc8f75d470",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "66c4c892-ffe4-4200-a70b-f879c7df6ec7",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "0b138ad5-a9b1-46f8-a653-cfa072dd7ab8",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"MeasurementValueNeededDate": "2025-06-27T06:30:40.7707191-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6e815752-86ec-4195-8546-606417dbabae",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "2dad6595-e570-4591-8c34-2bdb39a814a8",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "394a782a-4755-4bf4-a5ed-371f6c060c15",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-27T06:30:40.7707191-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "6d96b7e8-eaf9-4744-8699-ac30222fda86",
"CreateDate": "2025-06-27T06:30:40.7707191-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T06:30:40.7707191-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}