Assignment History
The Assignment History report allows you to fetch records of all the assignments that exist for a specific Project or Person. Each entity type has a respective endpoint below.
Get Project's Assignment History Data
GET - /v2/companies/<company_id>/projects/<project_id>/reports/assignment-history
Get Person's Assignment History Data
GET - /v2/companies/<company_id>/people/<person_id>/reports/assignment-history
Optional Params for Project request only
Property | Data Type | Description |
---|---|---|
employeeName | Boolean | Will return the Person's name for each assignment Default: true |
employeeNumber | Boolean | Will return the Person's number for each assignment Default: true |
jobTitle | Boolean | Will return the Person's Job Title for each assignment Default: true |
Optional Params for Person request only
Property | Data Type | Description |
---|---|---|
projectName | Boolean | Will return the Project name for each assignment Default: true |
projectNumber | Boolean | Will return the Project number for each assignment Default: true |
Optional Params for both Project and Person request
Property | Data Type | Description |
---|---|---|
assignmentStart | Boolean | Will return the start date for each assignment Default: true |
assignmentEnd | Boolean | Will return the end date for each assignment Default: true |
startTime | Boolean | Will return the daily start time for each assignment Default: true |
endTime | Boolean | Will return the daily end time for each assignment Default: true |
costCode | Boolean | Will return the name and UUID of the Cost Code for each assignment. Default: true |
labels | Boolean | Will return the name and UUID of the Label for each assignment. Default: true |
duration | Boolean | Will return a calculated duration for each listed assignment. Values will be formatted as below. It should also be noted that duration is calculated on calendar weeks, not work weeks.3D = 3 Days1W 2D = 9 Days2W = 14 daysDefault: true |
Responses:
Successful Response
The returned JSON array will contain objects representing each assignment that will have some permutation of the below properties depending on what your request param configuration is.
[
{
// Project Request Only
"person_name": {"first": "Joseph", "last": "Lopez" },
"employee_number": "123-a234s-456",
"job_title": "Journeyman",
// Person Request Only
"project_name": "Hospital Job",
"project_number": "123abc",
// Both Request
"start_day": "10/01/2017",
"end_day": "11/02/2017",
"start_time": "7:30 am",
"end_time": "3:30 pm",
"cost_code_name": "Phase 1",
"code_code_id": "e70d45dd-27dc-43ad-ab1a-abd4c54bbe3a",
"label_name": "Temp Work",
"label_id": "25202254-f832-403f-9a96-2df2ceb8faf1",
"duration": "4W 5D"
},
...
]
Updated almost 7 years ago
What’s Next