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": "d83e0f3a-6cde-4d86-872d-7f774d7d0c09",
"Asset": {
"AssetId": "ddc76c7c-f77e-4f89-af1d-3190c7fcb827",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "05537f11-284d-497a-9a92-d53d6052fdaf",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "69d8451c-44c3-4b5c-8dd0-581d4e49b35a",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "018442e6-c72f-4cce-8cff-55f101258119",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"MeasurementValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "f11c3037-413b-4b3e-84c0-d93451e9e460",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"MeasurementValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2c5ffddd-7392-4ef2-8ea7-a01653a0fe8e",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "1fafa84e-2d28-4102-a2c2-d62ef7bf150e",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "bb2dffa5-2ed9-4eb2-868f-74acb58561a1",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-21T18:58:20.7124706-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "2ea41a1e-eb36-4a20-8c0b-5f80fe45eef0",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-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": "ea82f58c-1b8c-407c-9e8a-482b9168c7fd",
"Asset": {
"AssetId": "48d3d306-bb1f-45e3-9551-559a257bce01",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "8b24b16b-8cf6-442b-80d5-be2b249134bd",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "1681f136-ea6d-440e-b2f9-0989aaa24a2e",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "527f6a85-cc5f-41ca-81da-293b494c33e7",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"MeasurementValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "45451000-681c-4f41-80bc-dfdee5ece0fc",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"MeasurementValueNeededDate": "2024-12-21T18:58:20.7124706-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "79ef425d-c27a-4b66-a22c-9225e9edc581",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "cbab2412-5fdd-4b53-825b-945cdc728ead",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "832ac265-123f-418d-8721-667f9eb03e02",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-21T18:58:20.7124706-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "0c0c6a37-e3bf-49b0-b6ad-97066f2184db",
"CreateDate": "2024-12-21T18:58:20.7124706-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-21T18:58:20.7124706-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}