Notes can be read, created, updated and deleted at the Account, Portfolio and Team level using below endpoints. Notes can be viewed on the Account, Portfolio and Orders grids, Account and Portfolio Details pages, and within the Tactical Tool.
Get list of notes applicable to entity provided in query
GET https://baseurl/api/v2/notes?relatedId=<relatedId>&relatedType=<relatedType>
| property | description | required | datatype |
| <relatedId> | Id of the primary entity | Yes | Integer |
| <relatedType> | Numeric representation of entity type (Team=4, Portfolio=16, Account=32, etc.) | Yes | Integer |
Sample Request
GET https://baseurl/api/v2/notes?relatedId=1&relatedType=4
Sample Response
[
{
"id": 23,
"relatedType": 4,
"relatedId": 1,
"entityName": "Default Team",
"notes": "Team Note text here",
"startDate": "2023-05-01T00:00:00",
"endDate": null,
"displayNote": true,
"createdDate": "2023-07-31T14:25:41",
"createdBy": 7264,
"editedDate": "2023-07-31T14:25:41",
"editedBy": 7264,
"reviewedBy": null,
"reviewDate": null,
"createdByUser": "User.Name",
"editedByUser": "User.Name",
"orionConnectNote": false,
"isDeleted": false
}
]Create note
POST https://baseurl/api/v2/notes
BODY
Sample Request
{
"relatedType": 16,
"relatedId": 71009,
"startDate": "2023-11-03T18:18:16.859Z",
"endDate": null,
"notes": "Non expiring display note for portfolio",
"displayNote": true
}| property | description | required | datatype |
| relatedType | Specifies what the note is for. Team=4, Portfolio=16, Account=32. | Yes | Integer |
| relatedId | Specifies id of related Type. If related type is 16 related id would be portfolio id. If related type is 32, related id would be the Eclipse account id, not the Orion Connect account id. | Yes | Integer |
| startDate | Specifies when note starts. | Yes | Date |
| endDate | Specifies when note expires. If not provided it will be none expiring note. If provided it should be after start date. | No | Date |
| displayNote | Indicates if note is display note. If displayNote is True, then the will show on Account, Portfolio and Orders grids, and in the Tactical Tool. Up to 100 characters per note, 500 characters in total, will be displayed. | No, Default=false | Boolean |
Sample Response
{
"id": 395,
"relatedType": 16,
"relatedId": 71009,
"notes": "Non expiring display note for portfolio",
"startDate": "2023-11-03T18:18:16.859Z",
"endDate": null,
"displayNote": true,
"createdDate": "2023-11-03T18:19:18.6536809+00:00",
"createdBy": 1032092,
"editedDate": "2023-11-03T18:19:18.6536812+00:00",
"editedBy": 1032092,
"reviewedBy": null,
"reviewDate": null,
"orionConnectNote": false,
"isDeleted": false
}Create list of notes
POST https://baseurl/api/v2/notes/addList
BODY
Sample Request
[
{
"relatedType":16,
"relatedId":71009,
"startDate":"2023-11-03T18:18:16.859Z",
"endDate":null,
"notes":"Non expiring display note for portfolio",
"displayNote":true
}
]| property | description | required | datatype |
| relatedType | Specifies what the note is for. Team=4, Portfolio=16, Account=32. | Yes | Integer |
| relatedId | Specifies id of related Type. If related type is 16 related id would be portfolio id. | Yes | Integer |
| startDate | Specifies when note starts. | Yes | Date |
| endDate | Specifies when note expires. If not provided it will be none expiring note. If provided it should be after start date. | No | Date |
| displayNote | Indicates if note is display note. If displayNote is True, then the will show on Account, Portfolio and Orders grids, and in the Tactical Tool. Up to 100 characters per note, 500 characters in total, will be displayed. | No, Default=false | Boolean |
Sample Response
[
{
"id": 395,
"relatedType": 16,
"relatedId": 71009,
"notes": "Non expiring display note for portfolio",
"startDate": "2023-11-03T18:18:16.859Z",
"endDate": null,
"displayNote": true,
"createdDate": "2023-11-03T18:19:18.6536809+00:00",
"createdBy": 1032092,
"editedDate": "2023-11-03T18:19:18.6536812+00:00",
"editedBy": 1032092,
"reviewedBy": null,
"reviewDate": null,
"orionConnectNote": false,
"isDeleted": false
}
]Edit Note
PUT https://baseurl/api/v2/notes/<id>
BODY
Sample Request
PUT https://baseurl/api/v2/notes/356
{
"id":356,
"relatedType":16,
"relatedId":71009,
"startDate":"2023-11-03T18:18:16.859Z",
"endDate":"2023-11-30T06:00:00.000Z",
"notes":"Expiring non display note for portfolio",
"displayNote":false
}| property | description | required | datatype |
| id | Note ID | Yes | Integer |
| relatedType | Specifies what the note is for. Team=4, Portfolio=16, Account=32. | Yes | Integer |
| relatedId | Specifies id of related Type. If related type is 16 related id would be portfolio id. | Yes | Integer |
| startDate | Specifies when note starts. | Yes | Date |
| endDate | Specifies when note expires. If not provided it will be none expiring note. If provided it should be after start date. | No | Date |
| displayNote | Indicates if note is display note. If displayNote is True, then the will show on Account, Portfolio and Orders grids, and in the Tactical Tool. Up to 100 characters per note, 500 characters in total, will be displayed. | No, Default=false | Boolean |
Sample Response
{
"id": 395,
"relatedType": 16,
"relatedId": 71009,
"notes": "Expiring non display note for portfolio",
"startDate": "2023-11-03T18:18:16.859Z",
"endDate": "2023-11-30T06:00:00.000Z",
"displayNote": false,
"createdDate": "2023-11-03T18:19:18.6536809+00:00",
"createdBy": 1032092,
"editedDate": "2023-11-03T19:28:02.8189305+00:00",
"editedBy": 1032092,
"reviewedBy": null,
"reviewDate": null,
"orionConnectNote": false,
"isDeleted": false
}Edit list of notes
POST https://baseurl/api/v2/notes/updateList
BODY
Sample Request
[
{
"id":356,
"relatedType":16,
"relatedId":71009,
"startDate":"2023-11-03T18:18:16.859Z",
"endDate":"2023-11-30T06:00:00.000Z",
"notes":"Expiring non display note for portfolio",
"displayNote":false
}
]| property | description | required | datatype |
| id | Note ID | Yes | Integer |
| relatedType | Specifies what level the note is for. Team=4, Portfolio=16, Account=32. | Yes | Integer |
| relatedId | Specifies id of related Type, if the related type is 16, the related id would be portfolio id. | Yes | Integer |
| startDate | Specifies when note starts. | Yes | Date |
| endDate | Specifies when note expires. If not provided it will be none expiring note. If provided it should be after start date. | No | Date |
| displayNote | Indicates if note is display note. If displayNote is True, then the will show on Account, Portfolio and Orders grids, and in the Tactical Tool. Up to 100 characters per note, 500 characters in total, will be displayed. | No, Default=false | Boolean |
Sample Response
[
{
"id": 395,
"relatedType": 16,
"relatedId": 71009,
"notes": "Expiring non display note for portfolio",
"startDate": "2023-11-03T18:18:16.859Z",
"endDate": "2023-11-30T06:00:00.000Z",
"displayNote": false,
"createdDate": "2023-11-03T18:19:18.6536809+00:00",
"createdBy": 1032092,
"editedDate": "2023-11-03T19:28:02.8189305+00:00",
"editedBy": 1032092,
"reviewedBy": null,
"reviewDate": null,
"orionConnectNote": false,
"isDeleted": false
}
]Delete note
DELETE https://baseurl/api/v2/notes/<id>
Sample Request
DELETE https://baseurl/api/v2/notes/396
Delete list of notes
POST https://baseurl/api/v2/notes/deleteList
BODY
Sample Request
provide list of note ids to delete
[396]Get entities related to primary entity for notes
GET https://baseurl/api/v2/notes/RelatedEntities?entityId=<entityId>&entityType=<entityType>
| property | description | required | datatype |
| <entityId> | Id of the primary entity | Yes | Integer |
| <entityType> | Numeric representation of entity type (Team=4, Portfolio=16, Account=32, etc.) | Yes | Integer |
Sample Request
https://baseurl/api/v2/notes/RelatedEntities?entityId=71009&entityType=16
Sample Response
[
{
"id":1,
"entityType":4,
"name":"Default Team"
},
{
"id":71009,
"entityType":16,
"name":"Sample103, Trade103"
},
{
"id":105239,
"entityType":32,
"name":"Sample103"
},
{
"id":105240,
"entityType":32,
"name":"Sample103"
}
]