Jump to

• Request
• Response

View a Report Cycle

get

/api/restapi/reportCycle/{reportCycleId}

This endpoint returns report cycles that meet the following requirements:

• The object has an ID that matches the value of the {reportCycleId} path parameter.

Request

Path Parameters

• reportCycleId(required): integer(int64)
  The system-generated identifier of a report cycle.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityReportCycle

Type: object

Title: ApiEntityReportCycle

Show Source

• 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.

{
    "title":"ApiEntityReportCycle",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "prefix":{
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "granularity":{
            "type":"string",
            "description":"The level of granularity for the workspace report.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "REPORTING_PERIOD",
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "SEMIMONTHLY",
                "WEEKLY",
                "DAILY"
            ]
        },
        "suffix":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace report.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the report cycle and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "periodId":{
            "type":"integer",
            "description":"The unique identifier of a period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cycleName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the reporting cycle.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "suffixIncrement":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baseDate":{
            "type":"string",
            "description":"The date used as the starting point for generating the period start and end dates in a reporting cycle.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reportCycleId":{
            "type":"integer",
            "description":"The unique identifier of a report cycle.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested report cycle does not exist, or you do not have access to it.

Back to Top