Oracle Prime Projects REST API

Run a Report

post

/primeapi/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

Supported Media Types

application/json

An object specifying report run settings.

Root Schema : ApiEntityReportOverrides

Type: object

Show Source

format: string

Allowed Values: [ "PDF", "EXCEL", "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.
reportCode: string

The unique identifier for the report.
workspaceId: integer(int64)

The system-generated identifier of a workpsace.

{
    "type":"object",
    "required":[
        "format",
        "includeDescendants",
        "orientation",
        "reportCode",
        "workspaceId"
    ],
    "properties":{
        "includeDescendants":{
            "type":"boolean",
            "description":"Indicates whether or not the report includes its descendants."
        },
        "orientation":{
            "type":"string",
            "description":"The page orientation of a report.",
            "enum":[
                "PORTRAIT",
                "LANDSCAPE"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a workpsace."
        },
        "reportCode":{
            "type":"string",
            "description":"The unique identifier for the report."
        },
        "format":{
            "type":"string",
            "description":"The default output format for the report. The valid values are HTML, Excel, PDF, RTF, and XML.",
            "enum":[
                "PDF",
                "EXCEL",
                "HTML",
                "RTF",
                "XML"
            ]
        }
    }
}

Response

Supported Media Types

application/json

201 Response

The object was successfully created.

Root Schema : ApiEntityScheduleJob

Type: object

Show Source

jobId(optional): integer(int64)

The unique identifier for the background service.
jobKey(optional): integer(int64)

A unique identifier of a job.
jobStatus(optional): string

Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS" ]

The status of the background service.
link(optional): string(url)

Read Only: true
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.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "jobKey":{
            "type":"integer",
            "format":"int64",
            "description":"A unique identifier of a job."
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS"
            ]
        },
        "jobId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the background service."
        },
        "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
        }
    }
}

400 Response

Invalid input for the Action service.