Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

POST: Custom ID in Bulk

Avatar
Ingrid
Follow
Publication Date – January 28, 2022

⇤ Portfolio

https://api.bitsighttech.com/ratings/v1/portfolio/entity-custom-ids/bulk

Assign, edit, or delete up to 1000 company IDs.

Parameters

⌘ This must contain either the add or delete parameter.

Parameter Description Values 
add⌘
Data		 Assign or edit custom company IDs. [Array] Companies and their desired IDs. 
guid
Data		 Identify a company to assign a company ID. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
custom_id
Data		 Assign the custom company ID. [String] The identifier name.

This is case-sensitive.

 
delete⌘
Data		 Remove custom company IDs. [Array] Companies to un-assign IDs. 
guid
Data		 Identify a company to have the custom ID removed. [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/portfolio/entity-custom-ids/bulk'
-H 'Content-Type: application/json'
--data-binary '{
  "add":[
    {
      "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
         "custom_id":"abc123"
    },
    {
      "guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "custom_id":"newID"
    }
  ],
  "delete":[
    {
      "guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d"
    }
  ]
}'
--compressed 
-u api_token:

Example Response

{
  "added":[
    {
      "guid":"a940bb61-33c4-42c9-9231-c8194c305db3",
      "custom_id":"abc123"
    }
  ],
  "modified":[
    {
      "guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "custom_id":"newID"
    }
  ],
  "deleted":[
    {
      "guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d",
      "custom_id":"12345"
    }
  ]
}

Response Attributes

Field Description
Status [added, modified, deleted]
Array		 Modified company IDs.
  
guid
String [entity_guid]		 The unique identifier of this company. 
custom_id
String		 The assigned, modified, or removed ID of this company.

Errors and Status Codes

See the common errors and status codes.

Code Description
200 – Okay Everything worked as expected.
400 – Bad Request An error has occurred. Either:
  • Invalid company guid = The company unique identifier is incorrectly formatted.
  • Invalid field <field> in the request = The request body must contain either the add or delete parameter.
  • The request input cannot exceed 1000 custom id changes = You can only make up to 1000 changes.
  • Server could not process request = The changes could not be made. This can often be due to an incorrect or missing required parameter.

Related articles