Jump to

• Request
• Response
• Examples

Get a project resource assignment

get

/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}

Request

Path Parameters

• AssignmentId(required): integer
  Unique identifier of the project resource assignment.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : projectResourceAssignments-item-response

Type: object

Show Source

• AdjustmentType: string
  Title: Adjustment Type

  Read Only: true

  Maximum Length: 80

  Type of adjustment if some adjustment has happenned on the project resource assignment.
• AdjustmentTypeCode: string
  Title: Adjustment Type Code

  Read Only: true

  Maximum Length: 30

  Code for the adjustment performed on the project resource assignment.
• AssignmentComments: string
  Title: Assignment Additional Comments

  Maximum Length: 2000

  Additional details for the project resource assignment.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  The date until which the resource is engaged on the project assignment. If no value is passed when creating the assignment, it defaults to project end date.
• AssignmentExternalIdentifier: string
  Title: Assignment External Identifier

  Maximum Length: 100

  Identifier of the assignment in an external application.
• AssignmentHoursPerDay: number
  Title: Assignment Hours per Day

  A period of time measured in hours for each day for the project resource assignment. Mandatory if you are passing Use Project Calendar Flag attribute value as N.
• AssignmentHoursPerWeek: number
  Title: Assignment Hours per Week

  Hours for every week of the assignment duration. Applicable only if Use Weekly Hours Indicator value is true.
• AssignmentId: integer
  Title: Assignment ID

  Read Only: true

  Unique identifier of the project resource assignment.
• AssignmentLocation: string
  Title: Assignment Location

  Maximum Length: 240

  Location for the work specified on the project resource assignment.
• AssignmentName: string
  Title: Assignment Name

  Maximum Length: 240

  The name given to a project resource assignment. This name is used to identify an assignment.
• AssignmentStartDate: string (date)
  Title: Assignment Start Date

  The date from which the resource is assigned to the project assignment. If no value is passed when creating the assignment, it defaults to the system date for all already started projects and to project start date for all projects starting in future. If the assignment start date is provided and is before the project's start date, the assignment will still be created.
• AssignmentStatusCode: string
  Title: Assignment Status Code

  Maximum Length: 30

  Status code of the assignment.
• AssignmentStatusName: string
  Title: Assignment Status

  Maximum Length: 80

  Status of the assignment.
• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 80

  Indicates if the assignment is a billable or a nonbillable assignment.
• AssignmentTypeCode: string
  Title: Assignment Type Code

  Maximum Length: 30

  Code to indicate if the assignment is a billable assignment or a nonbillable assignment.
• BillablePercent: integer
  Title: Billable Percent

  Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a nonbillable assignment, the value is ignored. Valid values are positive integer between 0 and 100.
• BillablePercentReason: string
  Title: Billable Percent Reason

  Maximum Length: 80

  Indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
• BillablePercentReasonCode: string
  Title: Billable Percent Reason Code

  Maximum Length: 30

  Code that indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
• BillRate: number
  Title: Bill Rate

  Rate that represents the targeted bill rate for the resource on the assignment.
• BillRateCurrencyCode: string
  Title: Bill Rate Currency Code

  Maximum Length: 15

  Code of the currency used to define the bill rate. The bill rate currency must be the same as the project currency.
• CanceledBy: string
  Title: Canceled By

  Read Only: true

  Maximum Length: 240

  The user who canceled the project resource assignment, if the assignment is canceled.
• CanceledByResourceId: integer (int64)
  Title: Canceled by Resource ID

  Read Only: true

  Unique Identifier of the resource who canceled the project resource assignment, if the assignment is canceled.
• CancellationDate: string (date)
  Title: Cancellation Date

  Read Only: true

  Date of cancellation if the assignment is canceled.
• CancellationReason: string
  Title: Cancellation Reason

  Read Only: true

  Maximum Length: 2000

  Reason of cancellation if the assignment is canceled.
• CostRate: number
  Title: Cost Rate

  Rate that represents the cost rate for the resource on the assignment.
• CostRateCurrencyCode: string
  Title: Cost Rate Currency Code

  Maximum Length: 15

  Code of the currency used to define the cost rate.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedFromFlow: string
  Title: Created from Flow

  Maximum Length: 30

  The flow from which the project resource assignment was created. For example, BRYNTUM indicates the project resource assignment was created from the resource schedule Gantt Chart.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• FridayHours: number
  Title: Friday Hours

  Hours for Friday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdatedFromFlow: string
  Title: Last Updated from Flow

  Maximum Length: 30

  The flow from which the project resource assignment was updated. Examples are BYNTUM_ADJUST or BRYNTUM_CANCEL. These values indicate the assignment schedule was adjusted or canceled using the resource schedule Gantt Chart.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MondayHours: number
  Title: Monday Hours

  Hours for Monday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator value is true.
• ProjectId: integer
  Title: Project ID

  Unique identifier of the project associated to the resource assignment. To identify the project, you may provide a value only for this attribute, the Project Number attribute, or the Project Name attribute. Project is mandatory when creating an assignment.
• ProjectManagementFlowFlag: boolean
  Title: Project Management Flow Indicator

  Flag that indicates if the action is called in the project manager flow. Set this value only if the service is being called in the project manager flow. Default value will be set to resource management flow which is the primary applicationation of the service.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute, Project ID attribute, or the Project Number attribute.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Unique number of the project associated to the resource assignment. To identify the project associated to the assignment, you may provide a value only for this attribute or the Project ID attribute or the Project Name attribute.
• ProjectRoleId: integer
  Title: Project Role ID

  Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, you may provide a value for this attribute or for Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.
• ProjectRoleName: string
  Title: Project Role Name

  Maximum Length: 240

  Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, you may provide a value for only this attribute or for Project Role ID attribute but not both.
• ProjResourceId: integer (int64)
  Title: Project Resource ID

  Read Only: true

  Identifier of the project labor resource associated with the project resource assignment.
• ReservationExpirationDate: string (date)
  Title: Reservation Expiration Date

  Date until which the resource should be reserved on the project. On or before this date, you should either confirm the assignment or cancel the reservation.
• ReservationReason: string
  Title: Reservation Reason

  Maximum Length: 80

  Reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Resource Reason Code attribute but not both. Applies only if the Assignment Status is RESERVED.
• ReservationReasonCode: string
  Title: Reservation Reason

  Maximum Length: 30

  Code for the reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Reservation Reason attribute but not both. Applies only if the Assignment Status is RESERVED.
• ResourceEmail: string
  Title: Resource Email

  Maximum Length: 240

  Email of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource ID attribute but not both.
• ResourceHCMPersonId: integer (int64)
  Title: Resource Person ID

  Read Only: true

  HCM person identifier for the project enterprise resource who is selected for the assignment.
• ResourceId: integer
  Title: Resource ID

  Unique identifier of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource Email attribute but not both. Resource is mandatory when creating an assignment.
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 240

  Name of the resource that is selected for the assignment.
• SaturdayHours: number
  Title: Saturday Hours

  Hours for Saturday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
• SundayHours: number
  Title: Sunday Hours

  Hours for Sunday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
• ThursdayHours: number
  Title: Thursday Hours

  Hours for Thursday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
• TotalAssignedHours: number
  Title: Total Assigned Hours

  Read Only: true

  The total number of hours for a project resource assignment calculated based on the date range, daily hours, working days, and calendar exceptions.
• TuesdayHours: number
  Title: Tuesday Hours

  Hours for Tuesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.
• UseDailyHoursFlag: boolean
  Title: Use Daily Hours Indicator

  Read Only: true

  Indicates if the hours for the assignment vary each day. Valid values are True and False. If the value is True, the assignment hours can vary each day of the project resource assignment.
• UseProjectCalendarFlag: boolean
  Title: Use Project Calendar Indicator

  Maximum Length: 1

  Default Value: true

  Indicates if the hours for the assignment are provided in Assignment Hours Per Day attribute or if it should be derived from the project calendar. Valid values are Y and N. If the value is Y, the assignment hours are derived from the project calendar.
• UseVariableHoursFlag: boolean
  Title: Use Variable Hours Indicator

  Indicates if the hours for the assignment are variable for every day of the week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attributes Monday Hours through Sunday Hours.
• UseVariableWeeklyHoursFlag: boolean
  Title: Use Variable Weekly Hours Indicator

  Indicates that the assignment is scheduled with weekly hours that vary for each week in the assignment date range.
• UseWeeklyHoursFlag: boolean
  Title: Use Weekly Hours Indicator

  Indicates if the hours for the assignment are for every week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attribute AssignmentHoursPerWeek.
• WednesdayHours: number
  Title: Wednesday Hours

  Hours for Wednesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the resource that is selected for the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SundayHours":{
            "title":"Sunday Hours",
            "type":"number",
            "description":"Hours for Sunday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate if the assignment is a billable assignment or a nonbillable assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStatusName":{
            "title":"Assignment Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "AssignmentHoursPerDay":{
            "title":"Assignment Hours per Day",
            "type":"number",
            "description":"A period of time measured in hours for each day for the project resource assignment. Mandatory if you are passing Use Project Calendar Flag attribute value as N.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignmentExternalIdentifier":{
            "title":"Assignment External Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"Identifier of the assignment in an external application.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"The date until which the resource is engaged on the project assignment. If no value is passed when creating the assignment, it defaults to project end date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CanceledBy":{
            "title":"Canceled By",
            "maxLength":"240",
            "type":"string",
            "description":"The user who canceled the project resource assignment, if the assignment is canceled.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BillablePercentReasonCode":{
            "title":"Billable Percent Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Resource Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource ID attribute but not both.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedFromFlow":{
            "title":"Last Updated from Flow",
            "maxLength":"30",
            "type":"string",
            "description":"The flow from which the project resource assignment was updated. Examples are BYNTUM_ADJUST or BRYNTUM_CANCEL. These values indicate the assignment schedule was adjusted or canceled using the resource schedule Gantt Chart.",
            "nullable":true,
            "x-queryable":false
        },
        "CancellationDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"Date of cancellation if the assignment is canceled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseWeeklyHoursFlag":{
            "title":"Use Weekly Hours Indicator",
            "type":"boolean",
            "description":"Indicates if the hours for the assignment are for every week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attribute AssignmentHoursPerWeek.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStartDate":{
            "title":"Assignment Start Date",
            "type":"string",
            "description":"The date from which the resource is assigned to the project assignment. If no value is passed when creating the assignment, it defaults to the system date for all already started projects and to project start date for all projects starting in future. \nIf the assignment start date is provided and is before the project's start date, the assignment will still be created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UseVariableWeeklyHoursFlag":{
            "title":"Use Variable Weekly Hours Indicator",
            "type":"boolean",
            "description":"Indicates that the assignment is scheduled with weekly hours that vary for each week in the assignment date range.",
            "nullable":true,
            "x-queryable":true
        },
        "WednesdayHours":{
            "title":"Wednesday Hours",
            "type":"number",
            "description":"Hours for Wednesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "UseProjectCalendarFlag":{
            "title":"Use Project Calendar Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the hours for the assignment are provided in Assignment Hours Per Day attribute or if it should be derived from the project calendar.  Valid values are Y and N. If the value is Y, the assignment hours are derived from the project calendar.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "TotalAssignedHours":{
            "title":"Total Assigned Hours",
            "type":"number",
            "description":"The total number of hours for a project resource assignment calculated based on the date range, daily hours, working days, and calendar exceptions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name given to a project resource assignment. This name is used to identify an assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentStatusCode":{
            "title":"Assignment Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Status code of the assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "TuesdayHours":{
            "title":"Tuesday Hours",
            "type":"number",
            "description":"Hours for Tuesday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "CanceledByResourceId":{
            "title":"Canceled by Resource ID",
            "type":"integer",
            "description":"Unique Identifier of the resource who canceled the project resource assignment, if the assignment is canceled.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CancellationReason":{
            "title":"Cancellation Reason",
            "maxLength":"2000",
            "type":"string",
            "description":"Reason of cancellation if the assignment is canceled.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AssignmentLocation":{
            "title":"Assignment Location",
            "maxLength":"240",
            "type":"string",
            "description":"Location for the work specified on the project resource assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project associated to the resource assignment. To identify the project associated to the assignment,  you may provide a value only for this attribute, Project ID  attribute, or the Project Number attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "ReservationReasonCode":{
            "title":"Reservation Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Reservation Reason attribute but not both.  Applies only if the Assignment Status is RESERVED.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectRoleId":{
            "title":"Project Role ID",
            "type":"integer",
            "description":"Identifier of the role that the selected resource is assigned to on a project assignment.  To identify the project role, you may provide a value for this attribute or for Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignmentComments":{
            "title":"Assignment Additional Comments",
            "maxLength":"2000",
            "type":"string",
            "description":"Additional details for the project resource assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedFromFlow":{
            "title":"Created from Flow",
            "maxLength":"30",
            "type":"string",
            "description":"The flow from which the project resource assignment was created. For example, BRYNTUM indicates the project resource assignment was created from the resource schedule Gantt Chart.",
            "nullable":true,
            "x-queryable":false
        },
        "ThursdayHours":{
            "title":"Thursday Hours",
            "type":"number",
            "description":"Hours for Thursday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "CostRateCurrencyCode":{
            "title":"Cost Rate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Code of the currency used to define the cost rate.",
            "nullable":true,
            "x-queryable":true
        },
        "UseVariableHoursFlag":{
            "title":"Use Variable Hours Indicator",
            "type":"boolean",
            "description":"Indicates if the hours for the assignment are variable for every day of the week or not. Valid values are True and False. If the value is True, the assignment hours are derived from the attributes Monday Hours through Sunday Hours.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "UseProjectCalendarFlag"
                ]
            },
            "x-queryable":true
        },
        "ResourceHCMPersonId":{
            "title":"Resource Person ID",
            "type":"integer",
            "description":"HCM person identifier for the project enterprise resource who is selected for the assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReservationExpirationDate":{
            "title":"Reservation Expiration Date",
            "type":"string",
            "description":"Date until which the resource should be reserved on the project. On or before this date,  you should either confirm the assignment or cancel the reservation.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the project resource assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjResourceId":{
            "title":"Project Resource ID",
            "type":"integer",
            "description":"Identifier of the project labor resource associated with the project resource assignment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MondayHours":{
            "title":"Monday Hours",
            "type":"number",
            "description":"Hours for Monday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator value is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "CostRate":{
            "title":"Cost Rate",
            "type":"number",
            "description":"Rate that represents the cost rate for the resource on the assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Unique number of the project associated to the resource assignment. To identify the project associated to the assignment,  you may provide a value only for this attribute or the Project ID  attribute or the Project Name attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project associated to the resource assignment. To identify the project, you may provide a value only for this attribute, the Project Number attribute, or the Project Name attribute. Project is mandatory when creating an assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "BillRateCurrencyCode":{
            "title":"Bill Rate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Code of the currency used to define the bill rate. The bill rate currency must be the same as the project currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ReservationReason":{
            "title":"Reservation Reason",
            "maxLength":"80",
            "type":"string",
            "description":"Reason for reserving a resource on the project resource assignment. You may provide a value for this attribute or for Resource Reason Code attribute but not both.  Applies only if the Assignment Status is RESERVED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentType":{
            "title":"Adjustment Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of adjustment if some adjustment has happenned on the project resource assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "BillablePercentReason":{
            "title":"Billable Percent Reason",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the reason why the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentTypeCode":{
            "title":"Adjustment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code for the adjustment performed on the project resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProjectRoleName":{
            "title":"Project Role Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, you may provide a value for only this attribute or for Project Role ID attribute but not both.",
            "nullable":false,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "ProjectManagementFlowFlag":{
            "title":"Project Management Flow Indicator",
            "type":"boolean",
            "description":"Flag that indicates if the action is called in the project manager flow. Set this value only if the service is being called in the project manager flow. Default value will be set to resource management flow which is the primary applicationation of the service.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Unique identifier of the resource who is selected for the assignment. To identify the resource, you may provide a value for this attribute or for Resource Email attribute but not both. Resource is mandatory when creating an assignment.",
            "nullable":false,
            "x-queryable":true
        },
        "FridayHours":{
            "title":"Friday Hours",
            "type":"number",
            "description":"Hours for Friday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates if the assignment is a billable or a nonbillable assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillRate":{
            "title":"Bill Rate",
            "type":"number",
            "description":"Rate that represents the targeted bill rate for the resource on the assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "BillablePercent":{
            "title":"Billable Percent",
            "type":"integer",
            "description":"Indicates the percentage of assignment time that is billable for an assignment that is defined as Billable assignment. For a nonbillable assignment, the value is ignored. Valid values are positive integer between 0 and 100.",
            "nullable":true,
            "x-queryable":true
        },
        "SaturdayHours":{
            "title":"Saturday Hours",
            "type":"number",
            "description":"Hours for Saturday of every week for the assignment time period. Applicable only if Use Variable Hours Indicator is true.",
            "nullable":true,
            "x-hints":{
                "precision":"4",
                "scale":"2"
            },
            "x-queryable":true
        },
        "AssignmentHoursPerWeek":{
            "title":"Assignment Hours per Week",
            "type":"number",
            "description":"Hours for every week of the assignment duration. Applicable only if Use Weekly Hours Indicator value is true.",
            "nullable":true,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "UseDailyHoursFlag":{
            "title":"Use Daily Hours Indicator",
            "type":"boolean",
            "description":"Indicates if the hours for the assignment vary each day. Valid values are True and False. If the value is True, the assignment hours can vary each day of the project resource assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

adjustAssignmentSchedule

Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/adjustAssignmentSchedule

Parameters:

• AssignmentId: $request.path.AssignmentId

Perform project resource assignment schedule change via this action. The schedule change can happen due to assignment date changes and/or changes in assignment hours per day. The assignment must be in Confirmed or Reserved status to perform this action.

cancelAssignment

Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/cancelAssignment

Parameters:

• AssignmentId: $request.path.AssignmentId

Cancel a project resource assignment.

cancelAssignmentAdjustment

Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/cancelAssignmentAdjustment

Parameters:

• AssignmentId: $request.path.AssignmentId

confirmReservedAssignment

Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/confirmReservedAssignment

Parameters:

• AssignmentId: $request.path.AssignmentId

Confirm a reserved project resource assignment.

replaceResource

Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/replaceResource

Parameters:

• AssignmentId: $request.path.AssignmentId

Replace existing resource with a different resource on a project resource assignment with this action. The resource assignment must be in confirmed or reserved status to allow this action.

validateForGanttAdjustment

Operation: /fscmRestApi/resources/11.13.18.05/projectResourceAssignments/{AssignmentId}/action/validateForGanttAdjustment

Parameters:

• AssignmentId: $request.path.AssignmentId

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

Back to Top

Examples

The following example shows how to get a project resource assignment by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061

Response Body Example

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

 {
      "AssignmentId": 300100025520061,
      "ResourceId": 300100025504859,
      "ResourceEmail": "[e-mail]",
      "ResourceHCMPersonId": 300100007741638,
      "ResourceName": "Veronica Johnson",
      "ProjectId": 300100025404084,
      "ProjectNumber": "300100025404084",
      "ProjectName": "zBIQA_Rel8_RM9",
      "AssignmentStartDate": "2014-01-01",
      "AssignmentEndDate": "2014-07-01",
      "AssignmentStatusCode": "PENDING_ADJUSTMENT",
      "AssignmentStatusName": "Pending Adjustment",
      "ProjectRoleId": 300100024326360,
      "ProjectRoleName": "zBIQA_Rel8_Role1 (2)",
      "UseProjectCalendarFlag": true,
      "AssignmentHoursPerDay": null,
      "CostRateCurrencyCode": "USD",
      "CostRate": null,
      "BillRateCurrencyCode": "USD",
      "BillRate": null,
      "AssignmentLocation": "New York",
      "ReservationReasonCode": null,
      "ReservationReason": null,
      "ReservationExpirationDate": null,
      "AssignmentComments": "Project #2 for zBIQA_Rel8_RM9 (Role - zBIQA_Rel8_Role1)",
      "AssignmentExternalIdentifier": null,
      "AdjustmentType": "Cancel Assignment",
      "AdjustmentTypeCode": "CANCEL",
      "CanceledBy": "Abraham Mason",
      "CanceledByResourceId": 300100024326751,
      "CancellationDate": null,
      "CancellationReason": "Pending Adjustment Type",
      "CreationDate": "2013-08-19T14:50:56.006+00:00",
      "CreatedBy": "Abraham.Mason",
      "LastUpdateDate": "2013-08-19T14:52:09.456+00:00",
      "LastUpdatedBy": "Abraham.Mason",
      "AssignmentTypeCode": null,
      "BillablePercent": null,
      "BillablePercentReasonCode": null,
      "AssignmentType": null,
      "BillablePercentReason": null,
      "ProjectManagementFlowFlag": null,
      "UseVariableHoursFlag": "false",
      "SundayHours": null,
      "MondayHours": null,
      "TuesdayHours": null,
      "WednesdayHours": null,
      "ThursdayHours": null,
      "FridayHours": null,
      "SaturdayHours": null,
		 "UseWeeklyHoursFlag": "false",
		 "AssignmentHoursPerWeek": null,
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061",
          "name": "projectResourceAssignments",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061",
          "name": "projectResourceAssignments",
          "kind": "item"
        },
        {
          "rel": "action",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061/action/cancelAssignment",
          "name": "cancelAssignment",
          "kind": "other"
        },
        {
          "rel": "action",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectResourceAssignments/300100025520061/action/adjustAssignmentSchedule",
          "name": "adjustAssignmentSchedule",
          "kind": "other"
        }
      ]
    }

Back to Top