POST Notes
Creates a new note.
Request Information
URI Parameters
None.
Body Parameters
The note to create. NoteId should not be filled in.
NoteName | Description | Type | Additional information |
---|---|---|---|
NoteId | globally unique identifier |
None. |
|
Asset | Asset |
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": "c6fb0280-e3c4-4c4a-bd4a-c53a5690b039", "Asset": { "AssetId": "1df3343f-ac1f-4e54-9047-696d4cd3c11d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4b1d69cc-1898-4375-8669-3bef5e2f1a48", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9a295dea-9637-45f6-b818-5ac33675bcf6", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "f89b195b-e010-4d8e-af59-2d65f19febf0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T04:13:06.88887-07:00", "MeasurementValueNeededDate": "2024-03-29T04:13:06.88887-07:00", "SourceSystemId": "sample string 3", "CompanyId": "aec39bbe-5729-417b-b9ba-8043082255f6", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "e887fc34-200e-4449-af03-73dd95129aa9", "EffectiveDate": "2024-03-29T04:13:06.88887-07:00", "StateType": { "StateTypeId": "5bfcf15e-0d0f-4328-b038-7a9d81562e7c", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "4b1d69cc-1898-4375-8669-3bef5e2f1a48", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9a295dea-9637-45f6-b818-5ac33675bcf6", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "bbb7b858-9d3a-460b-8c50-7b7645be2a8f", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "e5f66f80-8c9d-4190-9b82-c761e12e9c2d", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "47885bcb-2e65-4295-94be-bdae1557856a", "EffectiveDate": "2024-03-29T04:13:06.88887-07:00", "StatusType": { "StatusTypeId": "d068aa94-5866-46a7-9a84-76356c25f090", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "4b1d69cc-1898-4375-8669-3bef5e2f1a48", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "9a295dea-9637-45f6-b818-5ac33675bcf6", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1e2b5bbd-efda-4d0e-b622-bbf89f5e8610", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "a2ce8fbf-b734-4495-ab95-0e1f3a587915", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "699e777a-02b1-481a-a431-52d8acbbdc8c", "EffectiveDate": "2024-03-29T04:13:06.88887-07:00", "WellPurposeType": { "WellPurposeTypeId": "e8e5c950-339f-48a2-af89-d5d20d9faa88", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "440bd950-3c64-4d2a-b531-d801344d8ef1", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f751a7f5-9116-4dda-bddc-572388007915", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-03-29T04:13:06.88887-07:00", "MeasurementValueNeededDate": "2024-03-29T04:13:06.88887-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "841262d5-c4b8-458d-8497-587e8b331dba", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "acc8f05a-d34d-42a9-8fb8-43f8353d6563", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "f4918792-8fdf-4170-a07e-eb395cb30022", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-03-29T04:13:06.88887-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "6c0dbcc6-18d4-47fd-82e7-9be1897699ec", "CreateDate": "2024-03-29T04:13:06.88887-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T04:13:06.88887-07:00", "LastModifiedUser": "sample string 5" }
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": "fae36081-12a5-424a-8ee8-d0b7f3d3af14", "Asset": { "AssetId": "6da3ce62-588f-44da-af12-77e720639198", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6e57864b-03a5-4409-9759-9c1bc5c20d92", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e568046-bf1f-4c31-8126-f52311b6324a", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "140b2f67-2da4-445f-a8cf-5274284ae357", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T04:13:06.9045376-07:00", "MeasurementValueNeededDate": "2024-03-29T04:13:06.9045376-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8017a81a-921e-4a96-95c9-7e448428ffb3", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "88eb02a1-ef90-4fb3-a724-a8587b8d54b9", "EffectiveDate": "2024-03-29T04:13:06.9045376-07:00", "StateType": { "StateTypeId": "7bc7074a-f720-4fd9-99af-bce5abb83dae", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "6e57864b-03a5-4409-9759-9c1bc5c20d92", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e568046-bf1f-4c31-8126-f52311b6324a", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "d92163ab-0719-49de-8b15-8f0a85424bb4", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "39aadf17-439d-42f0-b4a9-7a212ca253a1", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "80529e52-6aa5-4d5e-a8ed-bd3b8bced9ee", "EffectiveDate": "2024-03-29T04:13:06.9045376-07:00", "StatusType": { "StatusTypeId": "51ffc56e-ebbe-4c72-a6e9-2789e4eb445a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "6e57864b-03a5-4409-9759-9c1bc5c20d92", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6e568046-bf1f-4c31-8126-f52311b6324a", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "0f9c06e0-0398-486e-b83d-3c2a688477f7", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "f43679e6-f699-4525-b811-216f9d4498e7", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "b1528dd7-8b4d-46bf-a6f9-c6b9b8b9dfb3", "EffectiveDate": "2024-03-29T04:13:06.9045376-07:00", "WellPurposeType": { "WellPurposeTypeId": "a1aee95f-8986-4ea0-bc1e-a6c2ad08639b", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "55467058-5059-426d-9266-86bad3ab5085", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "6e645fdc-bb23-4b36-b08a-6e34030a7931", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-03-29T04:13:06.9045376-07:00", "MeasurementValueNeededDate": "2024-03-29T04:13:06.9045376-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f3e63538-9f76-43d0-88bd-043d5bfd91ea", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "7d25dcbd-7f14-4047-a1ed-fe28737751f7", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3889a043-41ee-4c51-a5a9-880a7d9cc2ac", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-03-29T04:13:06.9045376-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "b1120046-346a-46cf-8f73-8c26a1ca63c5", "CreateDate": "2024-03-29T04:13:06.9045376-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T04:13:06.9045376-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }