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
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.
Show Source
- reportId
- reportCode,workspaceId
- reportCode,workspaceCode
-
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.
-
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.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The system-generated identifier of a workspace.
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
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.
Show Source
-
object
PortfolioIdentifier
Title:
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
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.
Show Source
-
object
ProgramIdentifier
Title:
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
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.
Show Source
-
object
ProjectIdentifier
Title:
ProjectIdentifier
Nested Schema : PortfolioIdentifier
Type:
object
Title:
Show Source
PortfolioIdentifier
-
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.
Nested Schema : ProgramIdentifier
Type:
object
Title:
Show Source
ProgramIdentifier
-
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.
Nested Schema : ProjectIdentifier
Type:
object
Title:
Show Source
ProjectIdentifier
-
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.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityScheduleJob
Type:
object
Title:
Show Source
ApiEntityScheduleJob
-
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.
400 Response
Invalid input for the Action service.