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": "93e4aee4-f6b2-4caa-a65f-6122501aa16c",
"Asset": {
"AssetId": "450a3939-bc91-42f7-938c-75ae7cdaaa6e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "5ea93e6d-6f1a-47b7-af2c-92ede82c28c7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7966f756-3876-4b86-8df1-bb96be0b3a2d",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "9411bb3f-1be3-4049-a056-b60c0a64f237",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "566eaf96-a8d2-4dde-8d0b-8cf9fd2381ad",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7ba007e2-25a1-4bc3-8665-681b772532cb",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "ed01ed05-6b02-40f4-8dc2-fb3655eec56d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bb0f8471-1bcf-41b3-a761-f66fd7137f96",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T05:53:17.492596-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "364eadb2-4309-438d-9fb7-47c582fcc30b",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08: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": "9e77cbe6-5d52-466c-81c9-5c9a5cf7533d",
"Asset": {
"AssetId": "63255122-2a50-4ac9-a71b-6ec2800943a5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7d448790-2431-4060-b720-d70055167b67",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4073f68d-21b3-47b9-a5ea-083b851e972f",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "6bdfa1b7-8170-4066-a7f2-e91b1b27d86e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a93bd413-f0ca-4684-900c-3ee0d6d52f14",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"MeasurementValueNeededDate": "2025-02-05T05:53:17.492596-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "53489efc-498b-41c5-9607-c219224ead89",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "20194dab-4716-4d48-aa1e-14a3912aaac7",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "cc464b06-4b00-4302-b66c-34aa3aab0603",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-02-05T05:53:17.492596-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "904ffd3c-0b3e-4286-b4ba-b614f1b583ed",
"CreateDate": "2025-02-05T05:53:17.492596-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-02-05T05:53:17.492596-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}