Oracle Prime Projects REST API

Schedule a Project

post

/primeapi/restapi/action/scheduleProject

Send a request to this endpoint to schedule a project. 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.Schedule a project to determine a project timeline based on the constraints, relationships, and date types to which activities must adhere. The application's project scheduler will use the Critical path method algorithm to assign activity dates, calculate total float, and set the project critical path.

Request

Supported Media Types

application/json

A project schedule object specifying a target project and optional data date.

Root Schema : ApiEntityProjectSchedule

Type: object

Show Source

dataDate(optional): string(date-time)

The progress point, or "as-of date", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually.
The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities.
projectId: integer(int64)

The unique identifier for the project.

{
    "type":"object",
    "required":[
        "projectId"
    ],
    "properties":{
        "dataDate":{
            "type":"string",
            "format":"date-time",
            "description":"The progress point, or \"as-of date\", for activities in the project. Project status is up-to-date as of the data date. You can set the data date when you schedule the project, or you can set it manually. <br />The data date is also used for updating the dates of scope assignments and work packages when they are not linked to activities."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project."
        }
    }
}

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.