https://api.bitsighttech.com/ratings/v1/folders/folder_guid/companies
Remove companies from a folder.
Companies cannot be removed from the “All Companies” folder.
Parameters
* Required.
| Parameter | Values |
|---|---|
folder_guid * [Path] Identify the folder to edit. |
[String] Folder unique identifier [folder_guid]. See GET: Folder Details. |
remove_companies * [Body] Identify companies to remove from the folder. |
[Array] Comma-separated company unique identifiers [entity_guid]. See GET: Portfolio Details. |
Example Request
Create a JSON object using the remove_companies parameter. Its value should be an array of unique identifiers (GUID) of the companies that you'd like to be removed from the folder.
cURL:
curl 'https://api.bitsighttech.com/ratings/v1/folders/fcc8b8c4-4fa3-4735-ac14-405ac7855d70/companies' -X PATCH -H 'Content-Type: application/json' --data-binary '{ "remove_companies":[ "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9", "a5e23bf0-38d4-4cea-aa50-19ee75da481d" ] }' --compressed -u api_token:
JSON:
{
"remove_companies":[
"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
"a5e23bf0-38d4-4cea-aa50-19ee75da481d"
]
}
Example Response
{
"removed":[
"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
"a5e23bf0-38d4-4cea-aa50-19ee75da481d"
]
}
Response Attributes
| Field | Description |
|---|---|
removedArray [ entity_guid] |
Companies that were removed from the folder. |
March 13, 2019: Published.
Feedback
3 comments
not what I was looking for
Hello Christopher. Can you clarify what you are looking for?
I'm trying to remove a company (and all of its assets/findings) from a ratings tree hierarchy. The logic in the support-ticket process forced me into a screen related to removing a company from a folder.
Please sign in to leave a comment.