Skip to content

workspaces_activity_retrieve

GET
/api/workspaces/{id}/activity
curl --request GET \
--url https://example.com/api/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activity \
--header 'Authorization: Bearer <token>'

Return the members of a workspace, and what they added in the last days.

The activity is rebuilt from the creation of the objects: the nodes created, the data linked to a node, the samples added to a node, the submissions started, over the last period_days. It covers only the objects the user may see: the owner sees all of them, any other member the nodes they belong to, the data linked and the samples added to them, and the submissions they are a member of. The additions made by one author in a burst make a single event: the nodes, data and samples on one side, the submissions on the other.

id
required
string format: uuid

A UUID string identifying this workspace.

Media typeapplication/json

The team of a workspace, and what it added lately.

object
period_days
required

The events are the ones of the last days only.

integer
members
required

The owners first.

Array<object>

A member of a workspace, and their role.

object
id
required

The identifier of the user.

string format: uuid
name
required

The full name, or the username.

string
username
required
string
email
required
string format: email
role
required
string
current_user
required

Whether the member is the user reading the list.

boolean
invitation_pending
required

Invited, the member has not signed up yet.

boolean
events
required

The 15 last events, the most recent first.

Array<object>

The additions made by one author in a single burst.

object
object
required

What the targets are. The nodes, data and samples added in a burst make one event, whose targets are the nodes created, or the nodes the data were linked or the samples added to. The submissions make their own.

  • node - node
  • submission - submission
string
Allowed values: node submission
additions
required

One item per kind of addition, in the order of KINDS.

Array<object>

The objects of one kind added in a burst.

object
kind
required

Node_created: nodes created. data_linked: data linked to a node. sample_created: samples added to a node. submission_created: submissions started.

  • node_created - node_created
  • data_linked - data_linked
  • sample_created - sample_created
  • submission_created - submission_created
string
Allowed values: node_created data_linked sample_created submission_created
count
required

The number of nodes, data, samples or submissions.

integer
author
required

Null when the user was deleted since.

object
id
required
string format: uuid
name
required
string
time
required

The last addition of the burst.

string format: date-time
start_time
required

The first addition of the burst.

string format: date-time
target_count
required
integer
targets
required

The 3 most recent targets only.

Array<object>

An object an event leads to.

object
id
required
string format: uuid
title
required
string
nullable
last_addition
required

When no event falls in the period, the most recent addition before it. Null otherwise, or when nothing was ever added.

object
time
required
string format: date-time
author
required

Null when the user was deleted since.

object
id
required
string format: uuid
name
required
string

Example

{
"events": [
{
"object": "node",
"additions": [
{
"kind": "node_created"
}
]
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "forbidden",
"message": "You do not have permission to perform this operation. Check the `details` property for more details.",
"details": [
{
"parameter": "workspace",
"code": "not_allowed",
"message": "You are not a member of this workspace."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "object_not_found",
"message": "Object not found. Check the `details` property for more details.",
"details": [
{
"parameter": "<id>",
"code": "does_not_exist",
"message": "\"<id>\" does not exist."
}
]
}