Skip to content

workspaces_submissions_overview_retrieve

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

Return the submissions of a workspace that call for an action, and their breakdowns.

The owner of the workspace sees all its submissions; any other member sees the submissions they are a member of. A websocket message update about the model submission is sent to the workspace when one changes.

id
required
string format: uuid

A UUID string identifying this workspace.

Media typeapplication/json

The submissions of a workspace that the user may see.

object
submission_count
required
integer
deposited_count
required

Submitted, including the ones for which an update is available.

integer
in_error
required

The submissions in error.

object
count
required
integer
submissions
required

The last edited ones only.

Array<object>

A submission in error.

object
id
required
string format: uuid
title
required
string
status
required
string
last_edited_time
required
string format: date-time
reason
required

Submission_failed and metadata_generation_failed: the last deposit or metadata generation failed. blocking_errors: the submission holds data, but something keeps it from being ready.

  • submission_failed - submission_failed
  • metadata_generation_failed - metadata_generation_failed
  • blocking_errors - blocking_errors
string
Allowed values: submission_failed metadata_generation_failed blocking_errors
update_available
required

The ones in error are left out: they are listed with their error.

object
count
required
integer
submissions
required

The last edited ones only.

Array<object>

A submission that calls for an action.

object
id
required
string format: uuid
title
required
string
status
required
string
last_edited_time
required
string format: date-time
statuses
required

In the order a submission goes through them.

Array<object>

The submissions of one status.

object
status
required
string
count
required
integer
destinations
required
Array<object>

The submissions sent to one kind of repository.

object
plugin
required
string
name
required
string
logo
required
string format: uri
nullable
count
required
integer

Example

{
"in_error": {
"submissions": [
{
"reason": "submission_failed"
}
]
}
}
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."
}
]
}