Jump to

• Request
• Response

Run a Report

post

/api/restapi/action/report/run

Send a request to this endpoint to run a report. This endpoint returns a job ID upon execution of the request. Send a request to the View Job Status endpoint to monitor the status of scheduled jobs. Reports are user-defined synopses that contain detailed or summarized information about your projects. Reports may be output in a variety of file formats, including PDF, XLS, RTF, HTML, and XML.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityReportOverridesInput

Type: object

Title: ApiEntityReportOverridesInput

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

• reportId
• reportCode,workspaceId
• reportCode,workspaceCode

Show Source

• format: string
  Allowed Values: [ "PDF", "EXCEL", "XLSX", "HTML", "RTF", "XML" ]

  The default output format for the report. The valid values are HTML, Excel, PDF, RTF, and XML.
• includeDescendants: boolean
  Indicates whether or not the report includes its descendants.
• 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.
• orientation: string
  Allowed Values: [ "PORTRAIT", "LANDSCAPE" ]

  The page orientation of a report.
• portfolio: portfolio
  This field represents the portfolio in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.
• program: program
  This field represents the program in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.
• project: project
  This field represents the project in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.
• reportCode(required): string
  Maximum Length: 60

  The unique identifier for the report.
• reportId: integer (int64)
  The system-generated identifier of a report.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The system-generated identifier of a workspace.

{
    "title":"ApiEntityReportOverridesInput",
    "required":[
        "reportCode",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "format":{
            "type":"string",
            "description":"The default output format for the report. The valid values are HTML, Excel, PDF, RTF, and XML.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PDF",
                "EXCEL",
                "XLSX",
                "HTML",
                "RTF",
                "XML"
            ]
        },
        "project":{
            "description":"This field represents the project in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProjectIdentifier"
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-generated identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reportId":{
            "type":"integer",
            "description":"The system-generated identifier of a report.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "includeDescendants":{
            "type":"boolean",
            "description":"Indicates whether or not the report includes its descendants.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "portfolio":{
            "description":"This field represents the portfolio in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/PortfolioIdentifier"
                }
            ]
        },
        "program":{
            "description":"This field represents the program in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProgramIdentifier"
                }
            ]
        },
        "reportCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for the report.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "orientation":{
            "type":"string",
            "description":"The page orientation of a report.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PORTRAIT",
                "LANDSCAPE"
            ]
        }
    },
    "description":"This entity represents a ReportOverrides object, a unique ReportOverrides object can be identified by the following combinations of the fields.<ul><li>reportId</li><li>reportCode,workspaceId</li><li>reportCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : portfolio

This field represents the portfolio in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.

Match All

Show Source

• object PortfolioIdentifier
  Title: PortfolioIdentifier

{
    "description":"This field represents the portfolio in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/PortfolioIdentifier"
        }
    ]
}

Nested Schema : program

This field represents the program in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.

Match All

Show Source

• object ProgramIdentifier
  Title: ProgramIdentifier

{
    "description":"This field represents the program in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ProgramIdentifier"
        }
    ]
}

Nested Schema : project

This field represents the project in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.

Match All

Show Source

• object ProjectIdentifier
  Title: ProjectIdentifier

{
    "description":"This field represents the project in which the program runs on. Fields program, portfolio and project are mutually exclusive and should not be provided as a combination in the payload. If given, the report runs for the workspace.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ProjectIdentifier"
        }
    ]
}

Nested Schema : PortfolioIdentifier

Type: object

Title: PortfolioIdentifier

Show Source

• name: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the portfolio.
• portfolioId: integer (int64)
  The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"PortfolioIdentifier",
    "type":"object",
    "properties":{
        "name":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the portfolio.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "portfolioId":{
            "type":"integer",
            "description":"The system-generated identifier of a portfolio. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramIdentifier

Type: object

Title: ProgramIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramIdentifier",
    "type":"object",
    "properties":{
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Run a Report

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityScheduleJob

Type: object

Title: ApiEntityScheduleJob

Show Source

• jobId: integer (int64)
  The unique identifier for the background service.
• jobKey: integer (int64)
  The unique identifier for a job.
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the background service.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScheduleJob",
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobKey":{
            "type":"integer",
            "description":"The unique identifier for a job.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

Back to Top