Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Resource Allocations

Get all Resource allocations

get/1.0/resource-allocations

Query parameters

startDatestring required
Example:2023-03-28

You can use this parameter to define the start date, and the API response will return all resource allocations that start on or after the specified date.

endDatestring required
Example:2023-03-28

You can use this parameter to define an end date, and the API will return allocations that end on or before the specified date.

pageSizenumber
Example:100

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFieldsstring[]

Use this query parameter to opt in for fields to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy'startDate' | 'endDate' | 'allocationType' | 'allocationFor'

You can use the sortBy param to sort the responses by the given field.

sortOrder'ASC' | 'DESC'

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

match'all' | 'any'

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

memberId.eqstring

You can use this parameter to specify a member id, and the API will return allocations that exactly match the given member id. This allows for precise filtering of allocations based on the specified user.

memberId.oneOfstring
Example:1,2,3

You can use this parameter to specify multiple member ids, separated by commas, and the API will return allocations that match any of the provided member ids.

memberId.noneOfstring
Example:1,2,3

You can use this parameter to specify multiple member ids, separated by commas, and the API will return allocations that exclude any of the provided member ids.

projectId.eqstring

You can use this parameter to specify a project id, and the API will return allocations that exactly match the given project id.

projectId.oneOfstring
Example:1,2,3

You can use this parameter to specify multiple project ids, separated by commas, and the API will return allocations that match any of the provided project ids.

projectId.noneOfstring
Example:1,2,3

You can use this parameter to specify multiple project ids, separated by commas, and the API will return allocations that exclude any of the provided project ids.

placeholderId.eqstring

You can use this parameter to specify a placeholder id, and the API will return allocations that exactly match the given placeholder id.

placeholderId.oneOfstring
Example:1,2,3

You can use this parameter to specify multiple placeholder ids, separated by commas, and the API will return allocations that match any of the provided placeholder ids.

placeholderId.noneOfstring
Example:1,2,3

You can use this parameter to specify multiple placeholder ids, separated by commas, and the API will return allocations that exclude any matching placeholder ids.

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "startDate": "2023-03-28",
      "endDate": "2023-03-28",
      "secondsPerDay": 45000,
      "minutesPerDay": 750,
      "hoursPerDay": 12,
      "duration": {
        "daysConsider": 1,
        "seconds": 45000,
        "minutes": 750,
        "hours": 12
      },
      "project": {
        "projectId": 201,
        "projectName": "Acme onboarding"
      },
      "tasks": [
        {
          "taskName": "Kickoff meeting",
          "taskId": 201
        }
      ],
      "member": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe",
        "role": {
          "roleId": 101,
          "roleName": "Designer"
        }
      },
      "placeholder": {
        "placeholderId": 201,
        "placeholderName": "Customer Success",
        "role": {
          "roleId": 101,
          "roleName": "Designer"
        }
      },
      "createdAt": 1681319726000,
      "updatedAt": 1681319726000,
      "createdBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "updatedBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/resource-allocations?includeFields=role&sortBy=startDate&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}