Jump to

• Request
• Response

Perform Project Resource Leveling

post

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

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityLevelerOption

Type: object

Title: ApiEntityLevelerOption

Show Source

• isLevelingMethodRole(required): boolean
  Whether the leveling method role is for Leveler option.
• 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.
• preserveSchedDates: boolean
  Preserves the early and late dates that were calculated during project scheduling when leveling a project.
• priorities: array priorities
  Prioritizes resources and roles during leveling and used when more than one activity competes for the same resource or role at the same time.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.
• resourceOrRoles: array resourceOrRoles
  Unique Items Required: true

  Option to enable leveling by resource or leveling by role.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityLevelerOption",
    "required":[
        "isLevelingMethodRole",
        "projectId"
    ],
    "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"
            ]
        },
        "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":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "preserveSchedDates":{
            "type":"boolean",
            "description":"Preserves the early and late dates that were calculated during project scheduling when leveling a project. ",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "resourceOrRoles":{
            "uniqueItems":true,
            "type":"array",
            "description":"Option to enable leveling by resource or leveling by role.",
            "exampleSetFlag":false,
            "items":{
                "type":"integer",
                "format":"int64",
                "exampleSetFlag":false,
                "types":[
                    "integer"
                ]
            },
            "types":[
                "array"
            ]
        },
        "priorities":{
            "type":"array",
            "description":"Prioritizes resources and roles during leveling and used when more than one activity competes for the same resource or role at the same time.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityLevelingPriority",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "isLevelingMethodRole":{
            "type":"boolean",
            "description":"Whether the leveling method role is for Leveler option.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : priorities

Type: array

Prioritizes resources and roles during leveling and used when more than one activity competes for the same resource or role at the same time.

Show Source

• Array of: object ApiEntityLevelingPriority
  Title: ApiEntityLevelingPriority

{
    "type":"array",
    "description":"Prioritizes resources and roles during leveling and used when more than one activity competes for the same resource or role at the same time.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityLevelingPriority",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : resourceOrRoles

Type: array

Unique Items Required: true

Option to enable leveling by resource or leveling by role.

Show Source

• Array of: integer(int64)

{
    "uniqueItems":true,
    "type":"array",
    "description":"Option to enable leveling by resource or leveling by role.",
    "exampleSetFlag":false,
    "items":{
        "type":"integer",
        "format":"int64",
        "exampleSetFlag":false,
        "types":[
            "integer"
        ]
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityLevelingPriority

Type: object

Title: ApiEntityLevelingPriority

Show Source

• field(required): string
  Maximum Length: 4000

  Fields to be used to prioritize resources or roles during leveling.
• order(required): string
  Allowed Values: [ "ASCENDING", "DESCENDING", "SEQUENTIAL", "HIERARCHICAL" ]

  The order in which to level resources or roles for the fields chosen for priority.

{
    "title":"ApiEntityLevelingPriority",
    "required":[
        "field",
        "order"
    ],
    "type":"object",
    "properties":{
        "field":{
            "maxLength":"4000",
            "type":"string",
            "description":"Fields to be used to prioritize resources or roles during leveling.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "order":{
            "type":"string",
            "description":"The order in which to level resources or roles for the fields chosen for priority.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ASCENDING",
                "DESCENDING",
                "SEQUENTIAL",
                "HIERARCHICAL"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Perform Project Resource Leveling

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