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": "d3850c4b-b2a1-4e91-9b04-5bc6219457e4",
"Asset": {
"AssetId": "a4181b02-add0-4e04-bf15-419b3fa887d6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4fa66000-6435-41d7-9ef8-3c4b9db61f5b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "0de4fb10-479f-43f3-b26d-cae23ec215c9",
"CreateDate": "2023-12-01T12:29:51.9129054-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-12-01T12:29:51.9129054-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d855d565-8b1b-4d86-a6fb-1beac7497e2b",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-12-01T12:29:51.9129054-08:00",
"MeasurementValueNeededDate": "2023-12-01T12:29:51.9129054-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "a57a5308-5e74-41b0-be56-3a8c2098c03e",
"CreateDate": "2023-12-01T12:29:51.9129054-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-12-01T12:29:51.9129054-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2023-12-01T12:29:51.9129054-08:00",
"MeasurementValueNeededDate": "2023-12-01T12:29:51.9129054-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "861dc74e-5f15-48d6-85a3-ace0ed19f8a0",
"CreateDate": "2023-12-01T12:29:51.9129054-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-12-01T12:29:51.9129054-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "274fea2e-c047-4b95-86fa-b764ff906a53",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0c8f2570-8df5-4c5f-a493-c41d60815fb8",
"CreateDate": "2023-12-01T12:29:51.9129054-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-12-01T12:29:51.9129054-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2023-12-01T12:29:51.9129054-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2795372a-b856-4afa-b2bc-e28b0ec92944",
"CreateDate": "2023-12-01T12:29:51.9129054-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-12-01T12:29:51.9129054-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": "41b86888-6932-4c6a-92d4-95680ec3c708",
"Asset": {
"AssetId": "a573fbd3-f02b-425b-8181-70e8b86559f7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "1e7f57a3-a4e9-4e46-8f70-77f1c6a3961e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "15668099-b6e8-4d00-836c-705a9f16a459",
"CreateDate": "2023-12-01T12:29:51.9285378-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2023-12-01T12:29:51.9285378-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "15467607-c7b5-48ae-8a7b-5f03c34ff5f5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2023-12-01T12:29:51.9285378-08:00",
"MeasurementValueNeededDate": "2023-12-01T12:29:51.9285378-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "5449967e-7211-4947-9bec-cdeacc106b5b",
"CreateDate": "2023-12-01T12:29:51.9285378-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2023-12-01T12:29:51.9285378-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2023-12-01T12:29:51.9285378-08:00",
"MeasurementValueNeededDate": "2023-12-01T12:29:51.9285378-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "77061fca-4645-43ec-90b4-a2d806a8feb4",
"CreateDate": "2023-12-01T12:29:51.9285378-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2023-12-01T12:29:51.9285378-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "f6e90f32-cffb-4e8e-b4fb-b2daf3fc338f",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2a4a795b-0975-4ec8-83ee-e2a72198482d",
"CreateDate": "2023-12-01T12:29:51.9285378-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-12-01T12:29:51.9285378-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2023-12-01T12:29:51.9285378-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5daf17e1-b1bb-471a-8e84-ad68deae10c3",
"CreateDate": "2023-12-01T12:29:51.9285378-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2023-12-01T12:29:51.9285378-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}