Update a Report Cycle
put
/api/restapi/reportCycle
Send a request to this endpoint to update a report cycle.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityReportCycleInput
Type:
object
Title:
ApiEntityReportCycleInput
This entity represents a ReportCycle object, a unique ReportCycle object can be identified by the following combinations of the fields.
Show Source
- reportCycleId
- cycleName,workspaceId
- cycleName,workspaceCode
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 24.4.The type of association in the relationship between the report cycle and the workspace. Possible values are Owned and Inherited. -
baseDate(required): string
(date-time)
The date used as the starting point for generating the period start and end dates in a reporting cycle.
-
cycleName(required): string
Minimum Length:
1
Maximum Length:255
The name of the reporting cycle. -
granularity(required): string
Allowed Values:
[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
The level of granularity for the workspace report. -
link: string(url)Read Only:true
Deprecated. As of 24.4.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(required): 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(required): 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)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the Report Cycle service.