Deletion impact

GET

https://api.sureshake.com/v2/entities/{entityId}/viewer-groups/{groupId}/deletion-impact

Path parameters

entityId
string
required
format: uuid

groupId
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- groupId
  string
  required
  format: uuid
- groupName
  string
  required
- memberCount
  integer
  required
  minimum: 0
- affectedTabs
  array of
  object
  required
  id
  string
  required
  format: uuid
  key
  string
  required
  label
  string
  required
- confirmation
  string
  required
- affectedReports
  optional
  array of
  object
  default: []
  id
  string
  required
  format: uuid
  title
  string
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "data": { "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55", "groupName": "string", "memberCount": 0, "affectedTabs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "label": "string" } ], "affectedReports": [], "confirmation": "string" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }