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": "93ca35a8-23e0-42cc-96d7-a4ca28a69f89",
"Asset": {
"AssetId": "9b1d8fc5-d935-47d6-a657-86e6b6ad4586",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "684db243-f71f-4a15-aa6e-b18088ab63b4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "270e1822-a2f3-4432-8870-d03f70288f7a",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "476bbcb0-9cb4-4edf-bd49-2c651bc19555",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-13T18:26:53.8415416-07:00",
"MeasurementValueNeededDate": "2025-09-13T18:26:53.8415416-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e6b48194-733d-4990-b18a-3abcfe89f650",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "a1b26ad8-39d5-4452-9937-87100b2f84c8",
"EffectiveDate": "2025-09-13T18:26:53.8415416-07:00",
"StateType": {
"StateTypeId": "a098039b-9186-49a6-b293-bca177582d36",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "684db243-f71f-4a15-aa6e-b18088ab63b4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "270e1822-a2f3-4432-8870-d03f70288f7a",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "76bf6f51-274c-4f46-b862-95583577d9c9",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b6f58800-99a5-43f5-b503-bd260b80584c",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8cfef3a4-2a61-4c3e-99cf-620fadd11118",
"EffectiveDate": "2025-09-13T18:26:53.8415416-07:00",
"StatusType": {
"StatusTypeId": "6e2119a7-b8f7-422b-b1cf-6bec29225efe",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "684db243-f71f-4a15-aa6e-b18088ab63b4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "270e1822-a2f3-4432-8870-d03f70288f7a",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "d035ae0e-9926-483f-bcf7-f22b4da1dfcb",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "5a4b777c-66cc-4134-9718-0cb9f5dee096",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "f4e77309-7289-43d2-ba47-342b546a8ed8",
"EffectiveDate": "2025-09-13T18:26:53.8415416-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "2fa034f0-1933-4d62-b559-08d8df543b0e",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "87adc68c-d731-4b44-b4a7-3be2a0d96771",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ca8cc0e6-3fc8-4691-9254-fcbe307c6875",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-13T18:26:53.8415416-07:00",
"MeasurementValueNeededDate": "2025-09-13T18:26:53.8415416-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "727805a9-402e-479d-b9df-7f6dbe6636c9",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "71f2b214-1f57-4202-be10-52cec2862a9e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0dee690d-4ee3-4a15-9e18-03ff431cc616",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-13T18:26:53.8415416-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "b3b54473-0a7c-4a94-afe3-385b5227b232",
"CreateDate": "2025-09-13T18:26:53.8415416-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:26:53.8415416-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": "df926f72-2f25-4fcc-9f81-b5191dde4880",
"Asset": {
"AssetId": "6a92019e-9c6e-4927-b5be-e4afecc144bf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "61048532-1e63-4a3d-8ca5-29c601e7c5ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "59227970-569f-4d6e-b1b2-a8acc83d883b",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "6cd3be72-42bf-4d6b-8d0d-ceaab417d18d",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-09-13T18:26:53.857101-07:00",
"MeasurementValueNeededDate": "2025-09-13T18:26:53.857101-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f0c9e72e-c3f2-446b-baf3-fff7ce8407e6",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "735172a2-b1a9-4e84-b923-0caef38039a1",
"EffectiveDate": "2025-09-13T18:26:53.857101-07:00",
"StateType": {
"StateTypeId": "f54c5789-a587-48a7-b8da-096608604aa4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "61048532-1e63-4a3d-8ca5-29c601e7c5ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "59227970-569f-4d6e-b1b2-a8acc83d883b",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "27ff63eb-9984-4fc4-9cf6-5152870b43bd",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "3aa393c8-5b93-4941-b32e-91bbe44440d0",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "0e57a373-a257-4704-8eb2-ed3058ed8616",
"EffectiveDate": "2025-09-13T18:26:53.857101-07:00",
"StatusType": {
"StatusTypeId": "0b8af95d-9c8c-4a25-a183-a81d40ed321e",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "61048532-1e63-4a3d-8ca5-29c601e7c5ee",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "59227970-569f-4d6e-b1b2-a8acc83d883b",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "85d8cfbc-13e9-4956-bcbf-32bb4081230c",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "2b0b7ff4-235b-4add-921c-a9a485cd1e99",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "c879fc93-6bfc-4f36-967f-f1c66f56492e",
"EffectiveDate": "2025-09-13T18:26:53.857101-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "4eb1d9a0-cd6b-434a-a5d1-e7ddc1cf0ad3",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "efd9b86a-430c-4e2a-a47a-7dffaaddf55b",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "7b130000-27ec-4297-86a7-746351db68ba",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-09-13T18:26:53.857101-07:00",
"MeasurementValueNeededDate": "2025-09-13T18:26:53.857101-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "915f686a-00b6-4698-aa0f-94389f01ac49",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 8"
},
"OnBehalfOf": "sample string 1",
"NoteCategory": {
"NoteCategoryId": "9d8cb8e7-f2f2-4125-b970-6786f81f0aba",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c1ebf229-5d61-470a-b161-8ab5b53a480c",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-09-13T18:26:53.857101-07:00",
"NoteHTML": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "1ce2024f-77c0-49fc-bce4-3f6d54b6e70c",
"CreateDate": "2025-09-13T18:26:53.857101-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-09-13T18:26:53.857101-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}