View all Report Cycles by Workspace
get
/api/restapi/reportCycle/workspace/{workspaceId}
This endpoint returns report cycles 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(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityReportCycle>
Type:
array
Title:
Show Source
List<ApiEntityReportCycle>
-
Array of:
object ApiEntityReportCycle
Title:
ApiEntityReportCycle
Nested Schema : ApiEntityReportCycle
Type:
object
Title:
Show Source
ApiEntityReportCycle
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the report cycle and the workspace. Possible values are Owned and Inherited. -
baseDate: string
(date-time)
The date used as the starting point for generating the period start and end dates in a reporting cycle.
-
cycleName: string
Minimum Length:
1
Maximum Length:255
The name of the reporting cycle. -
granularity: string
Allowed Values:
[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
The level of granularity for the workspace report. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
periodId: integer
(int64)
The unique identifier of a period.
-
prefix: string
Maximum Length:
255
The prefix for the period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view. -
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace report. -
reportCycleId: integer
(int64)
The unique identifier of a report cycle.
-
suffix: integer
(int32)
The numerical suffix for the period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.
-
suffixIncrement: integer
(int32)
The number to increment the suffix by in each period naming convention label, which is used to distinguish individual time periods when viewing reporting cycles in a time phased view.
-
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.
204 Response
Successful operation with no content.
404 Response
The requested report cycle does not exist, or you do not have access to it.