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. |
|
| 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": "487f67b4-5002-4e8e-890e-d7f697a4e9f9",
"Asset": {
"AssetId": "89b6b127-d200-43eb-b757-08f31b00f96a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "fbd90734-49b4-4963-bc3b-70feade23f2e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0a231a59-5980-4484-948f-1eb37a05f1e5",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1fdcded3-18fe-4c80-9569-fb94d9103ad1",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0b89796e-e7e5-41b1-8ca6-d8c718d77e87",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6d1256f5-6d8b-4a44-90fa-3bef6402bbba",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e4f10811-9c2e-4759-acf6-9995cbad7cff",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "a7a715bd-b315-450a-b7a4-ce12b7b3f1a2",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T20:38:37.6729677-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "17790807-f25b-4ade-a0ab-d1709ce341c3",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-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": "f5ac1b42-0845-4c9c-96f8-b4b306d52daa",
"Asset": {
"AssetId": "e8493ce3-b75d-4f9d-b687-e373d46ceeb5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "c66a7008-77b0-49c2-8ec1-64306813a5aa",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "de602808-f467-4183-bca7-539bf5456318",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "fb99ea2e-3466-4eaf-a448-36047e38fc18",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "7b76dc1d-0146-46e5-bfaa-3cfcf57cfb83",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"MeasurementValueNeededDate": "2025-06-30T20:38:37.6729677-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "5c153f22-67ac-4c7a-a1ca-fa0b8537ccca",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "04e7d879-f215-4569-b5d1-db6832df2262",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f7414305-89b8-4b4d-b21d-86204b22fce7",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-06-30T20:38:37.6729677-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "d41bf549-d003-49e8-b159-5aa7bd738e17",
"CreateDate": "2025-06-30T20:38:37.6729677-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-30T20:38:37.6729677-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}