Incidents Entities Endpoint

Introduction

The incident entities endpoint returns detailed entity information for an entity involved in an incident. Please note that there is a limit of up to 100 ACLs and the data is reflective of the last time we scanned the document (not when the incident was created).
Usage
The correct flow for usage of this endpoint is: First get an incident/incidents. Then take the id value from the entity object within the incident and call the incident_entities endpoint using that entitys id (not the incident id).
Example
You have an incident (which has an "id": 528815). Lookup the entity id for this incident: "entity": { "id": 497278 }
To use this entity id to get the entity information: https://callapi.cloudlock.com/incident_entities/497278

Entity Information for an Incident

[/incident_entities/{id}]
List incident entities [GET]

  • Parameters
    • id (required, integer, 513266) id of the entity in the incident.
Response 200 (application/json)
{
  "id": 513266,
  "name": "Logins for EC2 Instances.xlsx",
  "mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
  "user": "[email protected]",
  "owner_name": "Jimmy Jones",
  "owner_vendor_id": "832049419",
  "acl": [
    {
      "id": "2823",
      "value": "public_with_link",
      "role": "viewer",
      "type": "public_with_link",
      "status": "ACTIVE",
      "created_on": "2017-02-27 20:18:38.799158",
      "vendor": {
        "name": "box"
      },
      "origin_id": null
    },
    {
      "id": "2848",
      "value": "[email protected]",
      "role": "owner",
      "type": "user",
      "status": "ACTIVE",
      "created_on": "2017-02-25 13:58:38.409345",
      "vendor": {
        "name": "box"
      },
      "origin_id": "832049419"
    }
  ],
  "created_at": null,
  "updated_at": "2017-01-18T17:03:12+00:00",
  "entity_status": "VALID",
  "origin_id": "124496026820",
  "origin_type": "document",
  "origin_subtype": "Microsoft Office Excel",
  "viewed_at": null,
  "deleted_at": null,
  "direct_url": "https://box.com/master/content/832049419/0/0/124496026820",
  "vendor": {
    "name": "box"
  },
  "extra": {
    "origin_type_label": null,
    "origin_type_label_plural": null
  }
}

Updated 2 years ago

Incidents Entities Endpoint


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.