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": "445d5e72-9413-4b64-a0cd-cc1bb9af341e",
"Asset": {
"AssetId": "c126c7b2-17b4-4fb8-8a1d-5d1cb7c556ae",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "570835d9-76ab-478d-805d-6b210c8ae1a3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "100c54ea-7731-4060-8a39-e48cf190f65b",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "dabedae1-0170-49ce-bf4a-c0369c28439c",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-05T10:43:37.326909-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:43:37.326909-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9467f991-e7b0-4f5a-986f-7749564b9c39",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "c7b91fc4-7564-4fb0-8510-f86ae8f01da2",
"EffectiveDate": "2025-08-05T10:43:37.326909-07:00",
"StateType": {
"StateTypeId": "160f311f-5f68-4108-9b1e-1b9b1b71f7e4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "570835d9-76ab-478d-805d-6b210c8ae1a3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "100c54ea-7731-4060-8a39-e48cf190f65b",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "d603b315-cf8e-4807-8bb1-99aeff5a64cb",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c0bd9d63-c83f-4492-84e1-9af65ef15b5c",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "594faa5f-1bf5-4f5a-b580-45e2e1c3a06f",
"EffectiveDate": "2025-08-05T10:43:37.326909-07:00",
"StatusType": {
"StatusTypeId": "7de7f127-489f-485d-9c87-cc593feda506",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "570835d9-76ab-478d-805d-6b210c8ae1a3",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "100c54ea-7731-4060-8a39-e48cf190f65b",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "93462f98-7ec9-42a3-8580-4002e1dc30f9",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "84b21f5d-c0ec-4855-ade2-82f1e8a73a9a",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8fe63bba-39ee-4d4d-b908-22b454ff8b54",
"EffectiveDate": "2025-08-05T10:43:37.326909-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "465e107f-9d3a-4b48-bbb3-d24021ae8ed7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "98dbb8dc-4d8b-4881-b227-524cd4318f6b",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3e591ab3-d398-4885-9c62-b22afe227ebe",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-05T10:43:37.326909-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:43:37.326909-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4f556b35-0398-477d-8f8c-5a810aa141a9",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "62d9e01b-25c5-464f-8a82-5db57e1ee83b",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "533b187f-2298-4f4d-a678-e1c1d2c7337a",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-05T10:43:37.326909-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-05T10:43:37.326909-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2f095e86-b682-43bd-b880-200df343bc55",
"CreateDate": "2025-08-05T10:43:37.326909-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:43:37.326909-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": "15d9a63c-8456-4b53-88cc-d54c0b449855",
"Asset": {
"AssetId": "684166dd-9d12-4f67-abf7-eab0afb1e3be",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "297f74ad-5767-4474-a7e0-d8c6d10c6fcf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9ce61596-3ddb-4a98-916d-d892e994f27e",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "04cff9ac-fb69-49c1-9ccb-02df88b5980a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-08-05T10:43:37.3425262-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:43:37.3425262-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5271313d-ad12-4e49-9679-69876e0faf64",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "b617e8e7-2123-4f65-8d04-c12571fb9a1e",
"EffectiveDate": "2025-08-05T10:43:37.3425262-07:00",
"StateType": {
"StateTypeId": "9e0763b4-bb05-49cf-8ec7-fb09ca43648e",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "297f74ad-5767-4474-a7e0-d8c6d10c6fcf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9ce61596-3ddb-4a98-916d-d892e994f27e",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "63718f10-8380-4813-b4ec-0d027a5220a8",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "91bf6b7f-6194-40ec-accc-61fdbb5a2c73",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "4aa3740b-39c4-4866-80bc-6e0d34fdd957",
"EffectiveDate": "2025-08-05T10:43:37.3425262-07:00",
"StatusType": {
"StatusTypeId": "ebd66270-ba7b-4c7e-b9a2-6e62b80b7517",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "297f74ad-5767-4474-a7e0-d8c6d10c6fcf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "9ce61596-3ddb-4a98-916d-d892e994f27e",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "32051e1d-cade-442a-b436-7fc4becc0049",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5534bb79-9cfb-4221-8474-5417c8af9089",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "26957a9a-19df-4ce6-8567-7cd151a2df8b",
"EffectiveDate": "2025-08-05T10:43:37.3425262-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4108ce75-6067-4f6b-b26b-7c13eecdcbf0",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "a3dedabf-0983-49a4-9844-95bd2488f96e",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "66512156-3df1-4d56-a535-1405bbd88fc0",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-08-05T10:43:37.3425262-07:00",
"MeasurementValueNeededDate": "2025-08-05T10:43:37.3425262-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "50722607-e6fd-436c-968d-08b687ebcce4",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "50b57dfe-1bfb-4baa-abb9-eac301f85de6",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "869160e3-03cf-4da1-8fc8-ab9f31617fa8",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-08-05T10:43:37.3425262-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bfc45b42-21f8-4a0b-8df5-5b5cc4bf3509",
"CreateDate": "2025-08-05T10:43:37.3425262-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-08-05T10:43:37.3425262-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}