View Workspace Resources or Roles by Workspace and Resource Class
get
/primeapi/restapi/resource/workspaceResource/workspace/{workspaceId}?type={type}
This endpoint returns workspace resources that meet the following requirements:
- The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
workspaceId: integer(int64)
The system-generated identifier of a workspace.
Query Parameters
-
type: string
The type of a resource.Allowed Values:
[ "resource", "role" ]
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityWorkspaceResource
Type:
Show Source
object
-
associationType(optional):
string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the resource and the workspace. Possible values are Owned and Inherited. -
isRoot(optional):
boolean
Indicates whether the resource belongs to the root level of the child workspace.
-
link(optional):
string(url)
Read Only:
true
-
resourceId:
integer(int64)
The unique identifier for the resource.
-
sequenceNumber(optional):
integer(int32)
Determines the order of appearance of the workspace resource.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The identifier of the workspace.
-
workspaceResourceId:
integer(int64)
The unique identifier of the workspace-level resource.
204 Response
Successful operation with no content.
404 Response
The requested resource does not exist, or you do not have access to it.