Jump to

• Request
• Response
• Examples

Get all project labor resources

get

/fscmRestApi/resources/11.13.18.05/projectLaborResources

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the resource that matches the specified primary key.
    Finder Variables:
    • ProjResourceId; integer; Unique identifier of the project resource.
  • findByProjResourceId: Finds the resource with the specified project resource ID.
    Finder Variables:
    • ProjResourceId; integer; Unique identifier of the project resource.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Allocation; number; The percentage of hours a resource is allocated to the project for a specified duration.
  • AssignmentStatusCode; string; Code for the status of the assignment.
  • AssignmentType; string; Indicates whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
  • AssignmentTypeCode; string; Code to indicate whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
  • BillablePercent; integer; 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 integers between 0 and 100.
  • BillablePercentReason; string; Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
  • BillablePercentReasonCode; string; Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
  • CalendarId; integer; Identifier of the calendar that establishes the normal working days, hours per day, and exceptions for a project enterprise resource.
  • CreatedBy; string; Indicates the resource who created the row of data.
  • CreationDate; string; Date when the row of data was created.
  • DailyHours; number; Working hours of a resource for each working day during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is N.
  • DefaultStaffingOwnerFlag; boolean; Indicates whether all project resource requests will be assigned to the staffing owner by default.
  • Email; string; Email address of the resource.
  • FridayHours; number; Working hours of a resource for every Friday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • FromDate; string; The date when the resource assignment is to start on the project.
  • LaborBillRate; number; The amount paid to a business by its customer for a unit of work completed by the project enterprise resource.
  • LaborCostRate; number; The cost of a unit of work by the project enterprise resource.
  • LaborEffort; number; The number of hours that a resource is assigned or allocated to work on a project.
  • LastUpdateDate; string; Date when the record was last edited.
  • LastUpdatedBy; string; Indicates who last edited the record.
  • MondayHours; number; Working hours of a resource for every Monday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • Name; string; Display name of the resource.
  • ProjResourceId; integer; Unique identifier of the project resource.
  • ProjectCurrencyCode; string; The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.
  • ProjectId; integer; Unique identifier of the project associated to the resource assignment. To identify the project, provide a value for this attribute, or any one of the Project Number attribute or the Project Name attribute. Project is mandatory when creating an assignment.
  • ProjectName; string; Name of the project.
  • ProjectNumber; string; Alphanumeric identifier of the project.
  • ProjectResourceAssignmentId; integer; Unique identifier of the project resource assignment.
  • ProjectRoleId; integer; Identifier of the role that the selected resource is assigned to on a project assignment. To identify the project role, provide a value either for this attribute or the Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.
  • ProjectRoleName; string; Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, provide a value either for this attribute or for the Project Role ID attribute but not both.
  • Reason; string; Reason for requesting modification of the resource assignment.
  • ResourceId; integer; Unique identifier of the project enterprise resource.
  • SaturdayHours; number; Working hours of a resource for every Saturday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • ScheduleHoursType; string; Indicates whether working hours are assigned to resources based on the project calendar, per week, per day, or the day of the week. Valid values are Y, N, X, and W. If the value is Y, hours are assigned based on the project calendar. If the value is N, hours are assigned per day. If the value is X, hours are assigned based on the day of the week and can vary across days. If the value is set to W, hours are assigned per week. The default value is Y.
  • SundayHours; number; Working hours of a resource for every Sunday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • ThursdayHours; number; Working hours of a resource for every Thursday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • ToDate; string; The date when the resource assignment is to end on the project.
  • TuesdayHours; number; Working hours of a resource for every Tuesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • WednesdayHours; number; Working hours of a resource for every Wednesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
  • WeeklyHours; number; Working hours of a resource for each week during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is W.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : projectLaborResources

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/projectLaborResources-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object projectLaborResources-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/projectLaborResources-item-response"
    }
}

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 : projectLaborResources-item-response

Type: object

Show Source

• Allocation: number
  Title: Allocation Percentage

  Default Value: 100

  The percentage of hours a resource is allocated to the project for a specified duration.
• AssignmentStatus: string
  Status of the resource assignment on the project, such as Assigned, Planning, and Canceled.
• AssignmentStatusCode: string
  Maximum Length: 30

  Default Value: PLANNING_ONLY

  Code for the status of the assignment.
• AssignmentType: string
  Title: Assignment Type

  Indicates whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
• AssignmentTypeCode: string
  Title: Assignment Type Code

  Maximum Length: 30

  Code to indicate whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.
• 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 integers between 0 and 100.
• BillablePercentReason: string
  Title: Billable Percent Reason

  Indicates the reason that 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 that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.
• CalendarId: integer (int64)
  Title: Calendar ID

  Read Only: true

  Identifier of the calendar that establishes the normal working days, hours per day, and exceptions for a project enterprise resource.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Indicates the resource who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the row of data was created.
• DailyHours: number
  Title: Resource Assignment Hours per Day

  Working hours of a resource for each working day during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is N.
• DefaultStaffingOwnerFlag: boolean
  Indicates whether all project resource requests will be assigned to the staffing owner by default.
• Email: string
  Title: Email

  Maximum Length: 240

  Email address of the resource.
• FridayHours: number
  Title: Resource Assignment Hours on Fridays

  Working hours of a resource for every Friday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• FromDate: string (date)
  Title: From Date

  The date when the resource assignment is to start on the project.
• LaborBillRate: number
  Title: Bill Rate

  The amount paid to a business by its customer for a unit of work completed by the project enterprise resource.
• LaborCostRate: number
  Title: Cost Rate

  The cost of a unit of work by the project enterprise resource.
• LaborEffort: number
  Title: Effort in Hours

  The number of hours that a resource is assigned or allocated to work on a project.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date when the record was last edited.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Indicates who last edited the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MondayHours: number
  Title: Resource Assignment Hours on Mondays

  Working hours of a resource for every Monday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• Name: string
  Title: Name

  Maximum Length: 240

  Display name of the resource.
• ProjectCurrencyCode: string
  Maximum Length: 15

  Default Value: USD

  The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.
• ProjectId: integer (int64)
  Title: Project ID

  Unique identifier of the project associated to the resource assignment. To identify the project, provide a value for this attribute, or any one of the Project Number attribute or the Project Name attribute. Project is mandatory when creating an assignment.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Alphanumeric identifier of the project.
• ProjectResourceAssignmentId: integer (int64)
  Title: Assignment ID

  Unique identifier of the project resource assignment.
• ProjectRoleId: integer (int64)
  Title: Project Role ID

  Default Value: 13

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

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

  Unique identifier of the project resource.
• Reason: string
  Title: Reason

  Reason for requesting modification of the resource assignment.
• ResourceId: integer (int64)
  Title: Resource ID

  Unique identifier of the project enterprise resource.
• SaturdayHours: number
  Title: Resource Assignment Hours on Saturdays

  Working hours of a resource for every Saturday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• ScheduleHoursType: string
  Title: Resource Assignment Schedule Hours Indicator

  Maximum Length: 1

  Indicates whether working hours are assigned to resources based on the project calendar, per week, per day, or the day of the week. Valid values are Y, N, X, and W. If the value is Y, hours are assigned based on the project calendar. If the value is N, hours are assigned per day. If the value is X, hours are assigned based on the day of the week and can vary across days. If the value is set to W, hours are assigned per week. The default value is Y.
• SundayHours: number
  Title: Resource Assignment Hours on Sundays

  Working hours of a resource for every Sunday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• ThursdayHours: number
  Title: Resource Assignment Hours on Thursdays

  Working hours of a resource for every Thursday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• ToDate: string (date)
  Title: To Date

  The date when the resource assignment is to end on the project.
• TuesdayHours: number
  Title: Resource Assignment Hours on Tuesdays

  Working hours of a resource for every Tuesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• WednesdayHours: number
  Title: Resource Assignment Hours on Wednesdays

  Working hours of a resource for every Wednesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.
• WeeklyHours: number
  Working hours of a resource for each week during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is W.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the row of data was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Allocation",
                    "AssignmentTypeCode",
                    "BillablePercent",
                    "BillablePercentReasonCode",
                    "DailyHours",
                    "DefaultStaffingOwnerFlag",
                    "FridayHours",
                    "FromDate",
                    "LaborBillRate",
                    "LaborCostRate",
                    "LaborEffort",
                    "MondayHours",
                    "ProjectRoleId",
                    "ResourceId",
                    "SaturdayHours",
                    "ScheduleHoursType",
                    "SundayHours",
                    "ThursdayHours",
                    "ToDate",
                    "TuesdayHours",
                    "WednesdayHours",
                    "WeeklyHours"
                ]
            },
            "x-queryable":true
        },
        "LaborBillRate":{
            "title":"Bill Rate",
            "type":"number",
            "description":"The amount paid to a business by its customer for a unit of work completed by the project enterprise resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"Identifier of the calendar that establishes the normal working days, hours per day, and exceptions for a project enterprise resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DailyHours":{
            "title":"Resource Assignment Hours per Day",
            "type":"number",
            "description":"Working hours of a resource for each working day during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is N.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "DefaultStaffingOwnerFlag":{
            "type":"boolean",
            "description":"Indicates whether all project resource requests will be assigned to the staffing owner by default.",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "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, provide a value either for this attribute or the Project Role Name attribute but not both. Project Role value is mandatory when creating an assignment.",
            "format":"int64",
            "nullable":true,
            "default":"13",
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ProjectRoleName"
                ]
            },
            "x-queryable":true
        },
        "SundayHours":{
            "title":"Resource Assignment Hours on Sundays",
            "type":"number",
            "description":"Working hours of a resource for every Sunday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "title":"Assignment Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignmentType"
                ]
            },
            "x-queryable":true
        },
        "ThursdayHours":{
            "title":"Resource Assignment Hours on Thursdays",
            "type":"number",
            "description":"Working hours of a resource for every Thursday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "Reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason for requesting modification of the resource assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the resource.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "Allocation",
                    "AssignmentTypeCode",
                    "BillablePercent",
                    "BillablePercentReasonCode",
                    "DailyHours",
                    "DefaultStaffingOwnerFlag",
                    "Email",
                    "FridayHours",
                    "FromDate",
                    "LaborBillRate",
                    "LaborCostRate",
                    "LaborEffort",
                    "MondayHours",
                    "ProjectRoleId",
                    "ResourceId",
                    "SaturdayHours",
                    "ScheduleHoursType",
                    "SundayHours",
                    "ThursdayHours",
                    "ToDate",
                    "TuesdayHours",
                    "WednesdayHours",
                    "WeeklyHours"
                ]
            },
            "x-queryable":true
        },
        "ProjectCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The code for the currency used in the project. The currency code is a three-letter ISO code associated with a currency.",
            "nullable":false,
            "default":"USD",
            "x-queryable":true
        },
        "Allocation":{
            "title":"Allocation Percentage",
            "type":"number",
            "description":"The percentage of hours a resource is allocated to the project for a specified duration.",
            "nullable":true,
            "default":"100",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjResourceId":{
            "type":"integer",
            "description":"Unique identifier of the project resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BillablePercentReasonCode":{
            "title":"Billable Percent Reason Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignmentType",
                    "AssignmentTypeCode",
                    "BillablePercent"
                ]
            },
            "x-queryable":true
        },
        "ProjectResourceAssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the project resource assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MondayHours":{
            "title":"Resource Assignment Hours on Mondays",
            "type":"number",
            "description":"Working hours of a resource for every Monday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates who last edited the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LaborCostRate":{
            "title":"Cost Rate",
            "type":"number",
            "description":"The cost of a unit of work by the project enterprise resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleHoursType":{
            "title":"Resource Assignment Schedule Hours Indicator",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether working hours are assigned to resources based on the project calendar, per week, per day, or the day of the week. Valid values are Y, N, X, and W.\n\nIf the value is Y, hours are assigned based on the project calendar.\nIf the value is N, hours are assigned per day.\nIf the value is X, hours are assigned based on the day of the week and can vary across days.\nIf the value is set to W, hours are assigned per week.\n\nThe default value is Y.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Indicates the resource who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"Alphanumeric identifier of the project.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "ProjectId1"
                ]
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier of the project associated to the resource assignment. To identify the project, provide a value for this attribute, or any one of the Project Number attribute or the Project Name attribute. Project is mandatory when creating an assignment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillablePercentReason":{
            "title":"Billable Percent Reason",
            "type":"string",
            "description":"Indicates the reason that the billable percentage of the project resource assignment is less than 100%. For a nonbillable assignment, the value is ignored.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignmentType",
                    "AssignmentTypeCode",
                    "BillablePercent"
                ]
            },
            "x-queryable":true
        },
        "ProjectRoleName":{
            "title":"Project Role Name",
            "type":"string",
            "description":"Name of the role that the selected resource is assigned to on a project resource assignment. To identify the project role, provide a value either for this attribute or for the Project Role ID attribute but not both.",
            "nullable":true,
            "x-queryable":true
        },
        "WednesdayHours":{
            "title":"Resource Assignment Hours on Wednesdays",
            "type":"number",
            "description":"Working hours of a resource for every Wednesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Unique identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Allocation",
                    "AssignmentTypeCode",
                    "BillablePercent",
                    "BillablePercentReasonCode",
                    "DailyHours",
                    "DefaultStaffingOwnerFlag",
                    "FridayHours",
                    "FromDate",
                    "LaborBillRate",
                    "LaborCostRate",
                    "LaborEffort",
                    "MondayHours",
                    "ProjectRoleId",
                    "SaturdayHours",
                    "ScheduleHoursType",
                    "SundayHours",
                    "ThursdayHours",
                    "ToDate",
                    "TuesdayHours",
                    "WednesdayHours",
                    "WeeklyHours"
                ]
            },
            "x-queryable":true
        },
        "FridayHours":{
            "title":"Resource Assignment Hours on Fridays",
            "type":"number",
            "description":"Working hours of a resource for every Friday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"Indicates whether a request is for a billable assignment. Examples are BILLABLE, NONBILLABLE, or leave blank.",
            "nullable":true,
            "x-queryable":true
        },
        "WeeklyHours":{
            "type":"number",
            "description":"Working hours of a resource for each week during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is W.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "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 integers between 0 and 100.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignmentType",
                    "AssignmentTypeCode"
                ]
            },
            "x-queryable":true
        },
        "AssignmentStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code for the status of the assignment.",
            "nullable":true,
            "default":"PLANNING_ONLY",
            "x-hints":{
                "dependencies":[
                    "Allocation",
                    "AssignmentType",
                    "AssignmentTypeCode",
                    "BillablePercent",
                    "BillablePercentReason",
                    "BillablePercentReasonCode",
                    "DailyHours",
                    "DefaultStaffingOwnerFlag",
                    "Email",
                    "FridayHours",
                    "FromDate",
                    "LaborBillRate",
                    "LaborCostRate",
                    "LaborEffort",
                    "MondayHours",
                    "Name",
                    "ProjectRoleId",
                    "ProjectRoleName",
                    "ResourceId",
                    "SaturdayHours",
                    "ScheduleHoursType",
                    "SundayHours",
                    "ThursdayHours",
                    "ToDate",
                    "TuesdayHours",
                    "WednesdayHours",
                    "WeeklyHours"
                ]
            },
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the resource assignment is to start on the project.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the resource assignment is to end on the project.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Reason"
                ]
            },
            "x-queryable":true
        },
        "SaturdayHours":{
            "title":"Resource Assignment Hours on Saturdays",
            "type":"number",
            "description":"Working hours of a resource for every Saturday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "LaborEffort":{
            "title":"Effort in Hours",
            "type":"number",
            "description":"The number of hours that a resource is assigned or allocated to work on a project.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "FromDate",
                    "ScheduleHoursType",
                    "ToDate"
                ]
            },
            "x-queryable":true
        },
        "AssignmentStatus":{
            "type":"string",
            "description":"Status of the resource assignment on the project, such as Assigned, Planning, and Canceled.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Allocation",
                    "AssignmentStatusCode",
                    "AssignmentType",
                    "AssignmentTypeCode",
                    "BillablePercent",
                    "BillablePercentReason",
                    "BillablePercentReasonCode",
                    "DailyHours",
                    "DefaultStaffingOwnerFlag",
                    "Email",
                    "FridayHours",
                    "FromDate",
                    "LaborBillRate",
                    "LaborCostRate",
                    "LaborEffort",
                    "MondayHours",
                    "Name",
                    "ProjectRoleId",
                    "ProjectRoleName",
                    "ResourceId",
                    "SaturdayHours",
                    "ScheduleHoursType",
                    "SundayHours",
                    "ThursdayHours",
                    "ToDate",
                    "TuesdayHours",
                    "WednesdayHours",
                    "WeeklyHours"
                ]
            }
        },
        "TuesdayHours":{
            "title":"Resource Assignment Hours on Tuesdays",
            "type":"number",
            "description":"Working hours of a resource for every Tuesday during the assignment date range. This value can be set only if the value of UseProjCalendarHourFlag is X.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ScheduleHoursType"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last edited.",
            "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."
        }
    }
}

Back to Top

Examples

The following example shows how to get all project labor resources 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/projectLaborResources

Response Body Example

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

 {
"items": [
  {
"ProjectId": 300100169584611,
"ProjectRoleId": 13,
"DefaultStaffingOwnerFlag": null,
"ResourceId": 300100023180799,
"Name": "George White",
"Email": "[e-mail]",
"ProjectRoleName": "Team Member",
"ProjectResourceAssignmentId": null,
"CreatedBy": "ABRAHAM.MASON",
"CreationDate": "2018-11-29T08:19:44.369+00:00",
"LastUpdatedBy": "ABRAHAM.MASON",
"LastUpdateDate": "2018-11-29T08:19:44.413+00:00",
"Allocation": 100,
"LaborEffort": null,
"AssignmentStatusCode": "PLANNING_ONLY",
"AssignmentStatus": "Planned",
"LaborBillRate": null,
"LaborCostRate": null,
"FromDate": null,
"ToDate": null,
"ProjResourceId": 300100169584643,
"ProjectCurrencyCode": "USD"
}

Back to Top