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": "80d39e52-a25c-48c3-b891-6560bc24c04a",
"Asset": {
"AssetId": "b3eac901-352b-40ac-98dd-caec78e1f6b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "00098d44-6fbb-4dc3-926b-d0fe70c4887e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "10746a61-07c6-40ad-89cb-8dff54db846f",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "28a4c05d-f284-4528-9f90-509bab3ac326",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "fed1c0a9-3604-4563-9619-5a37499cb8c2",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6045e702-392b-417e-8a4b-d828ed252693",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "4d651f7b-4780-48a9-a147-355d557c6c09",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "15d94dc4-9eeb-4c80-a469-43205fe9d040",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-21T05:07:50.8369796-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f81aceaa-cd88-4f18-a756-6b0c4c598074",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-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": "68731871-2a47-42a6-ac3f-296f42d50a87",
"Asset": {
"AssetId": "80bf1e34-b6ec-44a8-a37b-da162dfacb03",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "cc83ac43-764d-414a-9858-361c7f441620",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4ef89fcc-81e9-443e-82a7-b49754efe27f",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "1aa7d996-4e6f-4c7f-8feb-2f48539eee64",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "4ef6985a-08f7-46fa-93ba-b627f1507b48",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"MeasurementValueNeededDate": "2024-11-21T05:07:50.8369796-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "e7f627a2-fee9-4fda-910f-6b64007adcb2",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "0c5ba384-50c0-47a7-a867-d6805ed5b15d",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "5f7a4ad5-3e50-4325-aa83-9f1a65ae7afc",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-11-21T05:07:50.8369796-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "934a6702-743e-49f7-9ebe-1e44ab0106e8",
"CreateDate": "2024-11-21T05:07:50.8369796-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-11-21T05:07:50.8369796-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}