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": "be94e1a2-77dc-4975-b66e-e2d9202200fe", "Asset": { "AssetId": "1e77c032-ebcf-4f4d-9a69-abd56c71ecf2", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "116f148e-9a93-4419-af16-75b6618d7098", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e72f83fe-2a0a-4dce-b986-3bc4f3061306", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "5f701eb0-9a44-4925-9991-3642a2d6a600", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "MeasurementValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2ff97c43-c449-409e-b9e0-da27b88bfbec", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "39be8473-05bb-401e-aa34-3f8d19e817ea", "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "StateType": { "StateTypeId": "050053d9-4146-48d4-9e11-cf7040ca831a", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "116f148e-9a93-4419-af16-75b6618d7098", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e72f83fe-2a0a-4dce-b986-3bc4f3061306", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "8cec89ac-f9ee-486d-bea6-ff868d49fdbe", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "610c3503-6e96-43cf-999e-09a91a7588e7", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "0a8a080b-a33b-4d38-9f95-9b75faef2fb0", "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "StatusType": { "StatusTypeId": "77ca5c32-e234-4f6f-ada6-2bebd579c9c8", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "116f148e-9a93-4419-af16-75b6618d7098", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "e72f83fe-2a0a-4dce-b986-3bc4f3061306", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "1311212c-b3bb-4a9d-8b60-007a54498620", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "34373eda-f6c6-4ec8-9b49-ea5ff91c68a9", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "fe0078ea-201f-4679-ad9e-dbbe1954988f", "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "WellPurposeType": { "WellPurposeTypeId": "d8e23aaf-b8ed-4dff-ae34-67a22fbfcc46", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dfc1f4ae-8eba-4a8e-894f-e131021bfa28", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "ff9ef76f-ef77-40b7-82b8-55c2e24eedc7", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "MeasurementValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "8ea829a0-26ce-43c3-b127-debcd9125709", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "e51b0783-bf74-4749-93c7-931ed2bdc58e", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "3ecf19c6-3102-467d-a9ac-2c33c8938fa3", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "31f5c22a-8ba2-46d4-a001-ef26737076d3", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T21:20:11.4815909-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": "248cc5d3-5a48-4b61-98fa-e6ffecd55adc", "Asset": { "AssetId": "c577fc8c-cef3-4733-b76b-cac3740d408c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c8ce991e-33bc-45dd-8a68-a541abdd9d02", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cab97f25-8ce5-4589-8d74-f1b7d19ef88f", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "fe328ba0-8d23-48d9-ae99-4f4406adcb79", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "MeasurementValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "SourceSystemId": "sample string 3", "CompanyId": "83f54dbd-3682-435f-b204-b07e4c151dbc", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "8ecba5f6-ff7c-4c07-8926-f2fd809b282e", "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "StateType": { "StateTypeId": "3e8ae89e-0711-49d1-9eff-db8bcbfd4014", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "c8ce991e-33bc-45dd-8a68-a541abdd9d02", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cab97f25-8ce5-4589-8d74-f1b7d19ef88f", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "f5a8bf49-e43a-424c-b4c4-e612f0f1fee2", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "1ce68187-d560-46c0-a36d-403b7dd57951", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "3a684689-0d8a-438f-954e-1f44474fc59f", "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "StatusType": { "StatusTypeId": "4bb8206d-4f67-4388-b522-11e7a840fc3a", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "c8ce991e-33bc-45dd-8a68-a541abdd9d02", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cab97f25-8ce5-4589-8d74-f1b7d19ef88f", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "6d524249-f40a-4205-b6e7-369b1a690e93", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "b73cbef3-9c4c-40e0-98d1-ff66a1b9374a", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "bff37de3-9ce6-4f9e-9512-5d10260ef7ed", "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "WellPurposeType": { "WellPurposeTypeId": "b2311a9a-a8c0-49ba-a63d-9eefbc58f0a2", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "2e76331b-ba96-4065-aef6-35064f03ffff", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "9a4c82e5-f492-4c71-87ff-027f2ed3c5cd", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "MeasurementValueNeededDate": "2024-04-28T21:20:11.4815909-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "8287e1c1-7654-4661-b974-9587d8e48698", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "475d60de-848c-4e14-a2cf-51d845b1d19c", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "c81bcf4e-31bb-4a75-a01f-30ca4c33120a", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-04-28T21:20:11.4815909-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "52aa75c1-55f9-42f2-862b-1f5ecdb47666", "CreateDate": "2024-04-28T21:20:11.4815909-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-28T21:20:11.4815909-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }