ch.aaap.harvestclient.api

Interface ProjectAssignmentsApi

All Known Implementing Classes:

ProjectAssignmentsApiImpl

public interface ProjectAssignmentsApi

Admin permissions required, except when retrieving the currently authenticated user’s project assignments.

See Also:

User Project Assignments API on Harvest

Method Summary

Modifier and Type	Method and Description
default List<ProjectAssignment>	list(Reference<User> userReference) List all Project Assignment for a User, sorted by creation date, newest first.
List<ProjectAssignment>	list(Reference<User> userReference, Instant updatedSince) List Project Assignment for a User, sorted by creation date, newest first, optionally filtered by updatedSince.
Pagination<ProjectAssignment>	list(Reference<User> userReference, Instant updatedSince, int page, int perPage) List Project Assignment for a User, sorted by creation date, newest first, optionally filtered by updatedSince.
List<ProjectAssignment>	listSelf()
Pagination<ProjectAssignment>	listSelf(int page, int perPage) Return a list of all ProjectAssignment for the current user.

Method Detail

list

default List<ProjectAssignment> list(Reference<User> userReference)

List all Project Assignment for a User, sorted by creation date, newest first.

Parameters:

userReference - which user to get the ProjectAssignment for

Returns:

a List of all ProjectAssignment for the user

list

List<ProjectAssignment> list(Reference<User> userReference,
                             Instant updatedSince)

List Project Assignment for a User, sorted by creation date, newest first, optionally filtered by updatedSince.

Parameters:

updatedSince - If set, return only assignments that have been updated this point in time. If null, no filtering takes place

userReference - which user to get the ProjectAssignment for

Returns:

a List of ProjectAssignment for the user, filtered accordingly

list

Pagination<ProjectAssignment> list(Reference<User> userReference,
                                   Instant updatedSince,
                                   int page,
                                   int perPage)

List Project Assignment for a User, sorted by creation date, newest first, optionally filtered by updatedSince. Page and perPage allow controlling how many results to return.

Parameters:

updatedSince - If set, return only assignments that have been updated this point in time. If null, no filtering takes place

userReference - which user to get the ProjectAssignment for

page - the page number

perPage - how many results to return for one page. Max 100

Returns:

a List of ProjectAssignment for the user, filtered accordingly

listSelf

List<ProjectAssignment> listSelf()

Returns:

a list of all ProjectAssignment for the current user.

listSelf

Pagination<ProjectAssignment> listSelf(int page,
                                       int perPage)

Return a list of all ProjectAssignment for the current user. Page and perPage allow controlling how many results to return.

Parameters:

page - the page number

perPage - how many results to return for one page. Max 100

Returns:

a list of all ProjectAssignment for the current user.