List all Entity Events

URL

GET https://<tenant>.bubbleppm.com/api/v3/entities/<entity_id>/events/

GET https://<tenant>.bubbleppm.com/api/v3/entities/<entity_external_ref>/events/?use_external_refs

External Refs

This endpoint supports External Refs. For more information please refer to the documentation here.

This endpoint supports pagination. For more information please refer to the documentation here.

Attributes

	Name	Type	Value always returned	Description
1	`id`	PK	Yes	The unique ID for the Event
2	`name`	string	Yes	The Events name
3	`description`	string	No	A free text description of the Event
4	`short_code`	string	No	The short code representation of this Events name
5	`entity`	Object<Entity>	Yes	An object containing the ID and Name of the Entity this Event belongs to
6	`start_date`	date	No	A date representing the start date of the Event in the plan
7	`end_date`	date	No	A date representing the end date of the Event in the plan
8	`created_at`	datetime	Yes	Datetime of the Events creation
9	`completed_at`	datetime	Yes	Datetime of the Event progressing into completed state
10	`due_date`	datetime	Yes	Datetime of the Event due date
11	`type`	FK<EventType>	Yes	The EventType ID for the Events Type
12	`progress`	FK<EventProgress>	No	The EventProgress ID for the Events Progress
13	`status`	FK<EventStatus>	No	The EventStatus ID for the Events Status
14	`workstream`	FK<EventWorkstream>	No	The EventWorkstream ID for the Events Workstream
15	`template_event`	FK<Event>	No	The Event from this this Event was copied in the template
16	`parent`	FK<Event>	No	The Event ID of the parent of this Event
17	`children`	array<Event>	No	An array of Event ID’s whose parent is this Event
18	`predecessors`	array<Event>	No	An array of Event ID’s with Date Links to this Event
19	`successors`	array<Event>	No	An array of Event ID’s with Date Links this Event links to
20	`ancestors`	array<Event>	No	An array of Event ID’s on the path from the root to this Event in the tree
21	`descendants`	array<Event>	No	An array of Event ID’s that are a related to the Events children
22	`assignees`	array<Person>	No	An array of Person ID’s assigned to this Event
23	`documents`	array<Document>	No	An array of Document Id’s
24	`progress_changed`	array<EventProgressLog>	No	An array of EventProgressLog objects that record historic changes to this Events progress
25	`active`	boolean	Yes	Denotes where the Event is currently active and visible in the plan
26	`completed`	boolean	Yes	Denotes whether the Event is complete
27	`deletable`	boolean	Yes	Denotes whether the Event can be deleted from the plan
28	`fixed_duration`	boolean	Yes	Denotes whether the Events duration if fixed against the duration value defined
29	`locked`	boolean	Yes	Denotes whether the Event cannot be modified
30	`mandatory`	boolean	Yes	Denotes whether the Event must be set to the completed Progress before its parent can be completed
31	`complete`	integer	Yes	A percentage of the Events completion
32	`criticality`	integer	Yes	Denotes the importance of the Event (mix/max not enforced)
33	`duration`	integer	Yes	An numeric value representing the number of full days between the start and end date of the Event
34	`effort`	integer	Yes	Denotes the effort to complete of the Event (mix/max not enforced)
35	`minimum_duration`	integer	No	The minimum duration for the Event, its duration cannot be less than this value

Filter Parameters

API Requests | Search-&-Parameters

Name	Type
`created_at_lte`	Date `YYYY-MM-DD`
`created_at_gte`	Date `YYYY-MM-DD`
`created_at`	Date `YYYY-MM-DD`
`updated_at_lte`	Date `YYYY-MM-DD`
`updated_at_gte`	Date `YYYY-MM-DD`
`updated_at`	Date `YYYY-MM-DD`
`name`	String
`in_same_tree`	Integer
`entity_model`	Integer
`type`	Integer

Example Response

CODE

[
  {
            "id":871385,
            "name":"What is the initial Technical Complexity / Regulation?",
            "description":"Define Tech Complexity classification (Major, Medium, Minor, Minimal)",
            "short_code":"G2",
            "template_event":366610,
            "entity":{
                "id":23448,
                "name":"DILLARDS SUPREME+ & LIP MAKEUP GWP",
                "model": "Makeup",
                "type": "Product",
                "external_ref": "5bba289d-e650-4ce3-b340-de3d72b826af"
            },
            "start_date":"2022-05-02",
            "end_date":"2022-05-02",
            "created_at":"2022-06-21T16:32:51.151924Z",
            "due_date":"2022-06-25T16:32:51.151924Z",
            "completed_at":"2022-06-25T16:32:51.151924Z",
            "type":{
                "id":1,
                "name":"Gate",
                "progress_options": [1,4,5],
                "status_options": [1,2]
            }
            "progress":{
                "id":1,
                "name":"Not started",
                "icon": "square",
                "color": "#333333"
            },
            "status":{
                "id":1,
                "name":"At risk",
                "icon": "circle",
                "color": "#ff0000"
            },
            "workstream":{
                "id":1,
                "name":"Documentation"
            },
            "parent":871382,
            "children":[871386, 871387],
            "predecessors":[817131],
            "successors":[817422],
            "ancestors":[871382, 871383],
            "descendants":[871386, 871387],
            "assignees":[426,507],
            "documents":[],
            "progress_changed":{
                "event":871385,
                "person":1,
                "created_at":"2022-06-21T16:32:51.151924Z",
                "from_progress": null,
                "to_progress": 1
            },
            "active":true,
            "completed":false,
            "deletable":false,
            "fixed_duration":true,
            "locked":false,
            "mandatory":false,
            "complete":false,

            "criticality":0,
            "duration":0,
            "effort":0,
            "minimum_duration":0
        }
]

URL

External Refs

Pagination

Attributes

Filter Parameters

Example Response