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": "136e92d0-8268-4c86-a732-f0f4c5f02027",
"Asset": {
"AssetId": "e4e18133-143d-4012-9ddd-6a5cd0828c7d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "0a597d82-e980-47bc-b78d-3bc31fe3a852",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "51b3fa2a-1c14-4573-9d2a-8aca961429ab",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "7a2edaa1-081d-42be-97b9-67ca6a5da34a",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"MeasurementValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "ef2df9fa-d423-4a94-8280-e42b8564991b",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"MeasurementValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "dcb5c10b-63e4-4673-9b37-49e7bbe3cf79",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "e2f636fa-3968-4913-8df5-649963073b24",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "dbaba2fc-84bc-483a-8aa2-328fd9f05879",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-08T22:12:50.4441663-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "53208814-946d-4f13-8370-a3332d2fc8f1",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-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": "6567cf8c-3de4-4da5-a1d9-692783ba955a",
"Asset": {
"AssetId": "ffde727c-89b6-46d0-b440-40ac71e10975",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "560bd106-cd54-48b8-a8d5-920c7bf57dca",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "5fe884c2-fa03-4f75-af3b-7dfcb91f970b",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "c07c9881-f6bd-4d3b-b423-068110dce20f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"MeasurementValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "6c383c96-7d62-4526-84d7-a831c3b444a8",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"MeasurementValueNeededDate": "2025-05-08T22:12:50.4441663-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "d9d6418e-6bbe-4071-b5cd-01e28990e2b4",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "6a5b8968-e410-44d7-b13a-3ac44643c935",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "e7c68704-a2fd-4f88-8ec4-c88e39a0712f",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2025-05-08T22:12:50.4441663-07:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2478a540-fbc3-43cf-89c7-f9d06729ee44",
"CreateDate": "2025-05-08T22:12:50.4441663-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-05-08T22:12:50.4441663-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}