GET api/consumer/v1/workspaces/{workspaceId}
Details of the workspace
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| workspaceId |
ID of the workspace |
integer |
Required |
Body Parameters
None
Response Information
Resource Description
workspace details
WorkspaceDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Owner |
Owner of element |
UserMinDto |
None |
| Logo |
Logo of element |
string |
None |
| BackGround |
Background color |
string |
None |
| IsArchived |
True if element is archived |
boolean |
None |
| Jobs |
Boards of element |
Collection of WorkspaceJobMinDto |
None |
| Team |
Team of element |
Collection of WorkspaceTeamMinDto |
None |
| CardsSummary |
Cards info |
WorkspaceJobCardSummaryDto |
None |
| JobsArchived |
Number of completed jobs |
integer |
None |
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Permissions |
Permissions |
PermissionDto |
None |
| CreationDate |
Creation |
date |
None |
| CreatedBy |
The user who has made the insert |
UserMinDto |
None |
| LastUpdateDate |
Date of the last update |
date |
None |
| LastUpdatedBy |
The user who has made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
{
"Owner": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Logo": "sample string 1",
"BackGround": "sample string 2",
"IsArchived": true,
"Jobs": [
{
"JobType": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"IsArchived": true,
"Code": "sample string 2",
"Description": "sample string 3",
"Id": 4
},
{
"JobType": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"IsArchived": true,
"Code": "sample string 2",
"Description": "sample string 3",
"Id": 4
}
],
"Team": [
{
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"User": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastAccess": "sample string 1"
},
{
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"User": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastAccess": "sample string 1"
}
],
"CardsSummary": {
"Total": 1,
"Archived": 2,
"Assigned": 3,
"Unassigned": 4,
"MyAssigned": 5
},
"JobsArchived": 2,
"Code": "sample string 4",
"Description": "sample string 5",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-01T19:35:08.3329638+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-01T19:35:08.3329638+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 7
}
application/xml, text/xml
Sample:
<WorkspaceDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<Id>7</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-01T19:35:08.3329638+01:00</CreationDate>
<LastUpdateDate>2024-11-01T19:35:08.3329638+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 4</Code>
<Description>sample string 5</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<BackGround>sample string 2</BackGround>
<CardsSummary>
<Archived>2</Archived>
<Assigned>3</Assigned>
<MyAssigned>5</MyAssigned>
<Total>1</Total>
<Unassigned>4</Unassigned>
</CardsSummary>
<IsArchived>true</IsArchived>
<Jobs>
<WorkspaceJobMinDto>
<Id>4</Id>
<Code>sample string 2</Code>
<Description>sample string 3</Description>
<IsArchived>true</IsArchived>
<JobType>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</JobType>
</WorkspaceJobMinDto>
<WorkspaceJobMinDto>
<Id>4</Id>
<Code>sample string 2</Code>
<Description>sample string 3</Description>
<IsArchived>true</IsArchived>
<JobType>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</JobType>
</WorkspaceJobMinDto>
</Jobs>
<Logo>sample string 1</Logo>
<Owner>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</Owner>
<Team>
<WorkspaceTeamMinDto>
<LastAccess>sample string 1</LastAccess>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<User>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</User>
</WorkspaceTeamMinDto>
<WorkspaceTeamMinDto>
<LastAccess>sample string 1</LastAccess>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<User>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</User>
</WorkspaceTeamMinDto>
</Team>
</WorkspaceDto>