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": "4fb97b23-ab4a-4719-9439-81aa6fd9d76f",
"Asset": {
"AssetId": "7709e7af-c924-4be8-b9d1-8644550c2efb",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "a804c56a-5211-4a60-9bbb-76a58d7fd3f5",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "da627a00-dafd-4747-b35e-131f0e919517",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "0f9e25cb-5c30-4040-be11-667e4ba0cad6",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"MeasurementValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "666c4fbb-f40f-4537-a671-49184275c5b7",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"MeasurementValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "3803af1f-f477-44df-895f-c4e843bd4928",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "08696750-faee-43f1-bb6b-0079295313a1",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "c527b1ec-d840-4e82-bec4-82bc03e393cb",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-22T02:47:53.8740337-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "f53eb55f-66f9-454d-9f22-00cb1eb55316",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-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": "9438d7cb-8a99-4d3c-823a-693537647551",
"Asset": {
"AssetId": "269f4372-2a50-4fe5-88e5-d514fcb12c1e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "b7752d8f-b58d-4e5d-9539-259d29d6940e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "c861d391-cd1f-4d87-b0bc-c4f833580134",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "d367fd68-cd4d-488d-a744-cbeca6f8ae1f",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"MeasurementValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e22642a0-b17b-4b2d-bcd8-ec32f05a9d47",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"MeasurementValueNeededDate": "2024-12-22T02:47:53.8740337-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "603927dc-0665-408f-a61d-e2a4b26bfa08",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 8"
},
"NoteCategory": {
"NoteCategoryId": "769b6de6-3e4f-4006-96ee-263c83159911",
"Name": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "54722edd-bb05-4ef5-b2c7-8276de72f50c",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 5"
},
"EffectiveDate": "2024-12-22T02:47:53.8740337-08:00",
"NoteHTML": "sample string 1",
"SourceSystemId": "sample string 2",
"CompanyId": "edb876fd-405c-41b8-b35a-fd2bb10701fb",
"CreateDate": "2024-12-22T02:47:53.8740337-08:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2024-12-22T02:47:53.8740337-08:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}