Oracle Prime Projects REST API

Perform Project Resource Leveling

post

/primeapi/restapi/action/level

Send a request to this endpoint to perform project resource leveling. 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. Resource leveling ensures your project schedules do not overallocate the projects available resources. Performing resource leveling delays simultaneous activities so that overallocated resources and roles may work on activities consecutively.

Request

Supported Media Types

application/json

A leveler options object specifying leveling options to use when performing resource leveling.

Root Schema : ApiEntityLevelerOption

Type: object

Show Source

isLevelingMethodRole(optional): boolean
link(optional): string(url)

Read Only: true
preserveSchedDates(optional): boolean
priorities(optional): array priorities
projectId: integer(int64)
resourceOrRoles(optional): array resourceOrRoles

Unique Items Required: 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",
    "required":[
        "projectId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "preserveSchedDates":{
            "type":"boolean"
        },
        "isLevelingMethodRole":{
            "type":"boolean"
        },
        "resourceOrRoles":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"integer",
                "format":"int64"
            }
        },
        "priorities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApiEntityLevelingPriority"
            }
        },
        "projectId":{
            "type":"integer",
            "format":"int64"
        },
        "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
        }
    }
}

Nested Schema : priorities

Type: array

Show Source

[0]: object ApiEntityLevelingPriority

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityLevelingPriority"
    }
}

Nested Schema : resourceOrRoles

Type: array

Unique Items Required: true

Show Source

[0]: integer(int64)

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : ApiEntityLevelingPriority

Type: object

Show Source

field: string

Allowed Values: [ "activityCode", "activityStatus", "earlyStart", "earlyFinish", "lateStart", "plannedDuration", "freeFloat", "plannedFinish", "plannedStart", "lateFinish", "remainingDuration", "totalFloat" ]
order: string

Allowed Values: [ "ASCENDING", "DESCENDING", "SEQUENTIAL", "HIERARCHICAL" ]

{
    "type":"object",
    "required":[
        "field",
        "order"
    ],
    "properties":{
        "field":{
            "type":"string",
            "enum":[
                "activityCode",
                "activityStatus",
                "earlyStart",
                "earlyFinish",
                "lateStart",
                "plannedDuration",
                "freeFloat",
                "plannedFinish",
                "plannedStart",
                "lateFinish",
                "remainingDuration",
                "totalFloat"
            ]
        },
        "order":{
            "type":"string",
            "enum":[
                "ASCENDING",
                "DESCENDING",
                "SEQUENTIAL",
                "HIERARCHICAL"
            ]
        }
    }
}

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.