View a Baseline Category
get
/api/restapi/baselineCategory/{baselineCategoryId}
This endpoint returns baseline categories that meet the following requirements:
- The object has an ID that matches the value of the {baselineCategoryId} path parameter.
Request
Path Parameters
-
baselineCategoryId(required): integer(int64)
The system-generated identifier of a baseline category.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityBaselineCategory
Type:
object
Title:
Show Source
ApiEntityBaselineCategory
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the baseline category and the workspace. -
baselineCategoryId: integer
(int64)
The system-generated unique identifier of a baseline category.
-
baselineCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the baseline category. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
404 Response
The requested baseline category does not exist, or you do not have access to it.