Show Source

• [0]: object ApiEntityReportCycle

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityReportCycle"
    }
}

Show Source

• 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
  The name of the reporting cycle.
• link(optional): string(url)
  Read Only: true
• periodId: integer(int64)
  The unique identifier of a period.
• prefix: string
  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(optional): 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.
• uniqueName(optional): string
• 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 unique identifier of a work space.

{
    "type":"object",
    "required":[
        "baseDate",
        "cycleName",
        "periodId",
        "prefix",
        "reportCycleId",
        "suffix",
        "suffixIncrement",
        "workspaceId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a work space."
        },
        "periodId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a period."
        },
        "prefix":{
            "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."
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace report.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "suffix":{
            "type":"integer",
            "format":"int32",
            "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."
        },
        "baseDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date used as the starting point for generating the period start and end dates in a reporting cycle."
        },
        "cycleName":{
            "type":"string",
            "description":"The name of the reporting cycle."
        },
        "reportCycleId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a report cycle."
        },
        "uniqueName":{
            "type":"string"
        },
        "suffixIncrement":{
            "type":"integer",
            "format":"int32",
            "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."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"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.",
            "readOnly":true
        }
    }
}