Jump to

• Request
• Response

Batch Create Report Cycles

post

/api/restapi/reportCycle/batch

Send a request to this endpoint to create one or more report cycles.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityReportCycleInput>

Type: array

Title: List<ApiEntityReportCycleInput>

Show Source

• Array of: object ApiEntityReportCycleInput
  Title: ApiEntityReportCycleInput

  This entity represents a ReportCycle object, a unique ReportCycle object can be identified by the following combinations of the fields.

  • reportCycleId
  • cycleName,workspaceId
  • cycleName,workspaceCode

{
    "title":"List<ApiEntityReportCycleInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityReportCycleInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

• reportCycleId
• cycleName,workspaceId
• cycleName,workspaceCode

Show Source

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

{
    "title":"ApiEntityReportCycleInput",
    "required":[
        "baseDate",
        "cycleName",
        "granularity",
        "suffix",
        "suffixIncrement",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "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"
            ]
        },
        "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"
            ]
        },
        "periodId":{
            "type":"integer",
            "description":"The unique identifier of a period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reportCycleId":{
            "type":"integer",
            "description":"The unique identifier of a report cycle.",
            "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"
            ]
        },
        "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"
            ]
        }
    },
    "description":"This entity represents a ReportCycle object, a unique ReportCycle object can be identified by the following combinations of the fields.<ul><li>reportCycleId</li><li>cycleName,workspaceId</li><li>cycleName,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Report Cycles

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityReportCycle>

Type: array

Title: List<ApiEntityReportCycle>

Show Source

• Array of: object ApiEntityReportCycle
  Title: ApiEntityReportCycle

{
    "title":"List<ApiEntityReportCycle>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityReportCycle",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested 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"
            ]
        },
        "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"
            ]
        },
        "reportCycleId":{
            "type":"integer",
            "description":"The unique identifier of a report cycle.",
            "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"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Report Cycle service.

Back to Top