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": "4c13124a-b901-4311-b1c9-1bafc7f2d59b",
"Asset": {
"AssetId": "e91d3275-35aa-42f9-8276-771ac7ed251a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8193e719-5293-40ac-ba26-106b700daeaf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "6748c539-d359-46bd-a595-6ac2342d3caf",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3624ffd7-00d2-483a-a0a8-e54d76a64b32",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"MeasurementValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "d5623525-a6b9-4e5c-ace2-ef4c8e4f01ee",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"MeasurementValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2bc3cedb-42a6-4463-9ece-c2abe49de9ca",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e7ea9298-3771-4988-9d37-e69090782e90",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "da93d9a5-3c38-434e-a822-2e9112a4075c",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-01T01:31:56.7189479-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "3a50367a-7df6-4227-b962-eb584faca86f",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-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": "c7ce2f0b-490b-46ea-90a3-3ae6118f031d",
"Asset": {
"AssetId": "beb30086-1354-4f17-bc3c-03d6a6a9e9af",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "f36dcfbf-a879-4e6c-818d-6578b72c52f8",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "96f5b450-9ea9-485f-aa01-eae0a7deb4bf",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "3a3a8079-e313-4c82-b152-906b4e7f4c58",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"MeasurementValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "2de4bf40-372e-4267-82ac-222d512fbc26",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"MeasurementValueNeededDate": "2026-04-01T01:31:56.7189479-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "83898b84-538f-49bd-b9c3-4d815cb913a6",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "35375e73-2d44-47b6-825a-d58fa18d8a76",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "8c5a0e01-1d71-42fb-b6d1-0439e2876995",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2026-04-01T01:31:56.7189479-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f4a10f06-a2e8-428b-80a5-5226fc2e92f6",
"CreateDate": "2026-04-01T01:31:56.7189479-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2026-04-01T01:31:56.7189479-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}