https://api.bitsighttech.com/ratings/v1/tiers/tier_guid/companies
Tiers can be used as filters to drive alerts on security ratings or risk vector grades, just like the folder functionality. Use this endpoint to add companies to an existing tier or remove companies from an existing tier.
Parameters
* Required.
| Parameter | Values |
|---|---|
add_companies [Data] Identify companies in your portfolio to add to the tier. |
[Array] Comma-separated company unique identifiers [entity_guid]. See GET: Portfolio Details. |
remove_companies [Data] Identify the companies to remove from the tier. |
[Array] Comma-separated company unique identifiers [entity_guid]. See GET: Portfolio Details. |
tier_guid * [Path] Identify the tier to modify. |
[String] Tier unique identifier [tier_guid]. See GET: Tiers. |
Example Add Request
curl 'https://api.bitsighttech.com/ratings/v1/tiers/tier1234-tier-1234-tier-1234tier1234/companies' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"add_companies":["aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","1111111-2222-3333-4444-555555555555","12345678-1234-1234-1234-123456789012","87654321-4321-4321-4321-210987654321"]}' --compressed
Example Remove Request
curl 'https://api.bitsighttech.com/ratings/v1/tiers/tier1234-tier-1234-tier-1234tier1234/companies' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"remove_companies":["aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","1111111-2222-3333-4444-555555555555","12345678-1234-1234-1234-123456789012","87654321-4321-4321-4321-210987654321"]}' --compressed
- December 10, 2019: Published.
Feedback
0 comments
Please sign in to leave a comment.