Jump to

• Request
• Response
• Examples

Validate new project resource assignment

post

/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/action/validateForGanttCreation

The method validates the single assignment schedule creation. It returns a list of errors and warnings if the new assignment doesn't pass the validation.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• AssignmentComments: string
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentEndDate: string (date)
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentHoursPerDay: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentHoursPerWeek: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentLocation: string
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentName: string
  The resourceId belonging to the resource for whom project resource assignment daily hours are being updated.
• AssignmentStartDate: string (date)
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentStatusName: string
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• AssignmentType: string
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• BillablePercent: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• BillablePercentReasonCode: string
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• FridayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• MondayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• ProjectId: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• ProjectRoleId: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• ReservationExpirationDate: string (date)
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• ReservationReasonCode: string
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• ResourceId: number
  Indicates whether or not to proceed with project resource assignment daily hours updates if overbooking warnings exist.
• SaturdayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• SundayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• ThursdayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• TuesdayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• UseProjectCalendarFlag: boolean
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• UseVariableHoursFlag: boolean
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• UseWeeklyHoursFlag: boolean
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.
• WednesdayHours: number
  Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.

{
    "type":"object",
    "properties":{
        "AssignmentLocation":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "ReservationReasonCode":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "ProjectRoleId":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "AssignmentComments":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "SundayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "ThursdayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "AssignmentStatusName":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "AssignmentHoursPerDay":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "UseVariableHoursFlag":{
            "type":"boolean",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "ReservationExpirationDate":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "format":"date",
            "nullable":true
        },
        "AssignmentEndDate":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "format":"date",
            "nullable":true
        },
        "BillablePercentReasonCode":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "MondayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "ProjectId":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "UseWeeklyHoursFlag":{
            "type":"boolean",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "AssignmentStartDate":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "format":"date",
            "nullable":true
        },
        "WednesdayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "UseProjectCalendarFlag":{
            "type":"boolean",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "ResourceId":{
            "type":"number",
            "description":"Indicates whether or not to proceed with project resource assignment daily hours updates if overbooking warnings exist.",
            "nullable":true
        },
        "AssignmentName":{
            "type":"string",
            "description":"The resourceId belonging to the resource for whom project resource assignment daily hours are being updated.",
            "nullable":true
        },
        "FridayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "AssignmentType":{
            "type":"string",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "BillablePercent":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "SaturdayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "AssignmentHoursPerWeek":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        },
        "TuesdayHours":{
            "type":"number",
            "description":"Consists of ProjectAssignmentId, AssignmentEntryDate, and AssignmentDailyHours for the updateAssignmentDailyHours action.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): array result
  Returns a list of warnings and errors if the create assignment operation completes successfully or returns FAILURE if the operation isn't successful.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"Returns a list of warnings and errors if the create assignment operation completes successfully or returns FAILURE if the operation isn't successful.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

Returns a list of warnings and errors if the create assignment operation completes successfully or returns FAILURE if the operation isn't successful.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Returns a list of warnings and errors if the create assignment operation completes successfully or returns FAILURE if the operation isn't successful.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to validate new project resource assignment schedule by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/action/validateForGanttCreation

Request Body Example

The following shows an example of the request body in JSON format.

{
    "ResourceId": 300100026246622,
    "ProjectRoleId": 3,
    "ProjectId": 300100025498122,
    "AssignmentStatusName": "Confirmed",
    "AssignmentStartDate": "2023-03-28",
    "AssignmentEndDate": "2023-03-28"
}

Back to Top