/rocketlane-tasks | Type: Application | PCID required: Yes
Tools
rocketlane_tasks_add_assignee_to_task
Add assignees to a task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
members | object[] | No | — | The list includes both team members and customers assigned to the task. |
placeholders | object[] | No | — | Rocketlane’s placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailId": {
"type": "string",
"description": "The user's email identifier."
},
"userId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the customer. `userId` will take precedence if both `emailId` and `userId` are provided."
},
"firstName": {
"type": "string",
"description": "The first name of the user."
},
"lastName": {
"type": "string",
"description": "The last name of the user."
}
}
},
"description": "The list includes both `team members` and `customers` assigned to the task."
},
"placeholders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"placeholderId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the placeholder."
},
"placeholderName": {
"type": "string",
"description": "The name of the placeholder."
},
"role": {
"type": "object",
"description": "The role of the member or placeholder to whom allocation is made for"
}
}
},
"description": "Rocketlane's placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future"
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_add_dependencies_to_task
Add dependencies to a task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
dependencies | object[] | Yes | — | Task Dependencies allow you to define relationships between tasks that are dependent on each other. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"dependencies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskId": {
"type": "integer",
"format": "int64",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
}
}
},
"description": "Task Dependencies allow you to define relationships between tasks that are dependent on each other."
}
},
"required": [
"PCID",
"taskId",
"dependencies"
]
}
rocketlane_tasks_add_followers_to_task
Add followers to a task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
members | object[] | No | — | The list includes both team members and customers assigned to the task. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailId": {
"type": "string",
"description": "The user's email identifier."
},
"userId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the customer. `userId` will take precedence if both `emailId` and `userId` are provided."
},
"firstName": {
"type": "string",
"description": "The first name of the user."
},
"lastName": {
"type": "string",
"description": "The last name of the user."
}
}
},
"description": "The list includes both `team members` and `customers` assigned to the task."
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_create_task
Create a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
assignees | object | No | — | The assignees value |
atRisk | boolean | No | — | Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task’s execution. |
dueDate | string | No | — | The date when a task completes its execution. It can be empty. If both startDate and dueDate are specified for a given task, it is necessary that the latter should be on or after the given startDate. The format for the due date is YYYY-MM-DD. |
effortInMinutes | integer | No | — | The effort is the expected time required to complete the task. The value is determined in minutes. |
externalReferenceId | string | No | — | An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency. |
fields | object[] | No | — | The custom fields can be set during the task creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type. |
followers | object | No | — | The task followers can be either members (team members or customers) or placeholders. |
parent | object | No | — | Parent task id |
phase | object | No | — | The phase that needs to be associated with the task can be mentioned here. Note: The phase needs to be associated with the project and thus failing the task creation process. |
private | boolean | No | — | This depicts if the task is private or not. |
progress | integer | No | — | The task’s progress, if indicated, will be available here and ranges in value from 0 to 100. The task’s status can be used in place of this field, however progress can offer more precise data. |
project | object | Yes | — | The project associated with task needs to be specified here and it is mandatory for the task to get created and map accordingly. |
source | object | No | — | Source information for importing a task from a template |
startDate | string | No | — | The date when a task starts its execution. It can be empty. The format for the start date is YYYY-MM-DD. |
status | object | No | — | The value of the task status can be specified here and this is essential to keep track of it. |
taskDescription | string | No | — | The description of the task. The description body needs to be in html format to avoid any formatting issues in the application. |
taskId | integer | No | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
taskName | string | Yes | — | The name of the task. |
taskPrivateNote | string | No | — | The privateNote for the task is intended exclusively for team members. The note’s content should be in HTML format to prevent any formatting issues in the application. |
type | string | No | — | The type of the task if specified will be available here. There are two options: MILESTONE or TASK. If a task is not explicitly marked as a milestone, it takes the default value as TASK. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task’s execution. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"startDateActual",
"dueDateActual",
"type",
"phase",
"assignees",
"followers",
"dependencies",
"billable",
"csatEnabled",
"priority",
"timeEntryCategory",
"financialsBudget",
"taskPrivateNote",
"parent",
"externalReferenceId"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
},
"assignees": {
"type": "object",
"description": "The assignees value",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list includes both `team members` and `customers` assigned to the task."
},
"placeholders": {
"type": "array",
"items": {
"type": "object"
},
"description": "Rocketlane's placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future"
}
}
},
"atRisk": {
"type": "boolean",
"description": "Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task's execution."
},
"dueDate": {
"type": "string",
"description": "The date when a task completes its execution. It can be empty. If both `startDate` and `dueDate` are specified for a given task, it is necessary that the latter should be on or after the given `startDate`. The format for the due date is _YYYY-MM-DD_."
},
"effortInMinutes": {
"type": "integer",
"description": "The effort is the expected time required to complete the task. The value is determined in minutes."
},
"externalReferenceId": {
"type": "string",
"description": "An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the field"
},
"fieldLabel": {
"type": "string",
"description": "The fieldLabel is the name of the custom field."
},
"fieldValue": {
"type": "object",
"description": "The value for the field. It can either be a string or a number or number array. Refer [example](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know more about assigning value for different fields."
}
}
},
"description": "The custom fields can be set during the task creation with the help of `fields`. The `fieldValue` can be either a string or a number or an array and it has to comply with the type of the field. Refer [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`."
},
"followers": {
"type": "object",
"description": "The task followers can be either `members` (team members or customers) or `placeholders`.",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list includes both `team members` and `customers` assigned to the task."
}
}
},
"parent": {
"type": "object",
"description": "Parent task id",
"properties": {
"taskId": {
"type": "integer",
"description": "The unique identifier for the parent task."
}
}
},
"phase": {
"type": "object",
"description": "The `phase` that needs to be associated with the task can be mentioned here. Note: The `phase` needs to be associated with the `project` and thus failing the task creation process.",
"properties": {
"phaseId": {
"type": "integer",
"description": "The unique identifier for the phase."
},
"phaseName": {
"type": "string",
"description": "The name of the phase."
}
}
},
"private": {
"type": "boolean",
"description": "This depicts if the task is private or not."
},
"progress": {
"type": "integer",
"description": "The task's progress, if indicated, will be available here and ranges in value from 0 to 100. The task's status can be used in place of this field, however progress can offer more precise data."
},
"project": {
"type": "object",
"description": "The `project` associated with task needs to be specified here and it is mandatory for the task to get created and map accordingly.",
"properties": {
"projectId": {
"type": "integer",
"description": "The `identifier` of the project is generated by the system and can be used to identify the project globally."
}
}
},
"source": {
"type": "object",
"description": "Source information for importing a task from a template",
"properties": {
"templateId": {
"type": "integer",
"description": "Task Template ID to import from"
},
"startDate": {
"type": "string",
"description": "Start date for scheduling the imported task"
}
},
"required": [
"startDate",
"templateId"
]
},
"startDate": {
"type": "string",
"description": "The date when a task starts its execution. It can be empty. The format for the start date is _YYYY-MM-DD_."
},
"status": {
"type": "object",
"description": "The value of the task status can be specified here and this is essential to keep track of it.",
"properties": {
"value": {
"type": "integer",
"description": "The value of the status field."
}
}
},
"taskDescription": {
"type": "string",
"description": "The `description` of the task. The description body needs to be in **html** format to avoid any formatting issues in the application."
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"taskName": {
"type": "string",
"description": "The **name** of the task."
},
"taskPrivateNote": {
"type": "string",
"description": "The `privateNote` for the task is intended exclusively for team members. The note's content should be in `HTML` format to prevent any formatting issues in the application."
},
"type": {
"type": "string",
"description": "The type of the task if specified will be available here. There are two options: `MILESTONE` or `TASK`. If a task is not explicitly marked as a milestone, it takes the default value as `TASK`. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task's execution.",
"enum": [
"TASK",
"MILESTONE"
]
}
},
"required": [
"PCID",
"project",
"taskName"
]
}
rocketlane_tasks_create_time_entry
Create a time entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
activityName | string | No | — | Name of the adhoc activity being performed |
billable | boolean | No | — | Whether the time entry is billable. Defaults to true |
category | object | No | — | Category associated with the time entry |
date | string | Yes | — | Date of the time entry in format YYYY-MM-DD |
fields | object[] | No | — | The custom fields can be set during the time-entry creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type. |
minutes | integer | Yes | — | Duration of the time entry in minutes |
notes | string | No | — | Notes for the time entry |
project | object | No | — | Project associated with the time entry |
projectPhase | object | No | — | Project phase associated with the time entry |
task | object | No | — | Task associated with the time entry |
timeEntryId | integer | No | — | The unique, system-generated identifier, which can be used to identify the time entry globally. |
user | object | No | — | User associated with the time entry |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"notes",
"sourceType",
"deleted",
"status",
"submittedBy",
"submittedAt",
"approvedBy",
"approvedAt",
"rejectedBy",
"rejectedAt",
"costRate",
"billRate"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
},
"activityName": {
"type": "string",
"description": "Name of the adhoc activity being performed"
},
"billable": {
"type": "boolean",
"description": "Whether the time entry is billable. Defaults to true"
},
"category": {
"type": "object",
"description": "Category associated with the time entry",
"properties": {
"categoryName": {
"type": "string",
"description": "The name of the category."
},
"categoryId": {
"type": "integer",
"description": "The unique identifier for the category."
}
}
},
"date": {
"type": "string",
"description": "Date of the time entry in format YYYY-MM-DD"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the field"
},
"fieldLabel": {
"type": "string",
"description": "The fieldLabel is the name of the custom field."
},
"fieldValue": {
"type": "object",
"description": "The value for the field. It can either be a string or a number or number array. Refer [example](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know more about assigning value for different fields."
}
}
},
"description": "The custom fields can be set during the time-entry creation with the help of `fields`. The `fieldValue` can be either a string or a number or an array and it has to comply with the type of the field. Refer [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`."
},
"minutes": {
"type": "integer",
"description": "Duration of the time entry in minutes"
},
"notes": {
"type": "string",
"description": "Notes for the time entry"
},
"project": {
"type": "object",
"description": "Project associated with the time entry",
"properties": {
"projectName": {
"type": "string",
"description": "The name of the project."
},
"projectId": {
"type": "integer",
"description": "The unique identifier for the project."
}
}
},
"projectPhase": {
"type": "object",
"description": "Project phase associated with the time entry",
"properties": {
"phaseId": {
"type": "integer",
"description": "The unique identifier for the phase."
},
"phaseName": {
"type": "string",
"description": "The name of the phase."
}
}
},
"task": {
"type": "object",
"description": "Task associated with the time entry",
"properties": {
"taskName": {
"type": "string",
"description": "The name of the task."
},
"taskId": {
"type": "integer",
"description": "The task’s unique, system-generated identifier, which can be used to identify the task globally."
}
}
},
"timeEntryId": {
"type": "integer",
"description": "The unique, system-generated identifier, which can be used to identify the time entry globally."
},
"user": {
"type": "object",
"description": "User associated with the time entry",
"properties": {
"emailId": {
"type": "string",
"description": "Email ID"
},
"userId": {
"type": "integer",
"description": "User ID"
},
"firstName": {
"type": "string",
"description": "First name"
},
"lastName": {
"type": "string",
"description": "Last name"
}
}
}
},
"required": [
"PCID",
"date",
"minutes"
]
}
rocketlane_tasks_create_timeoff
Create a time-off Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
durationInMinutes | integer | No | — | The duration of time off is determined by the type selected: if the time off type is CUSTOM, the durationInMinutes field is required. |
endDate | string | Yes | — | The time-off end date. The endDate must be on or after the startDate, formatted as YYYY-MM-DD. |
note | string | No | — | The note or comment about the time-off. |
notifyUsers | object | No | — | Users to notify about your time off. |
startDate | string | Yes | — | The time-off start date. The format for the start date is YYYY-MM-DD. |
timeOffId | integer | No | — | The unique identifier of the time-off is generated by the system and used to identify the time-off globally. |
type | string | Yes | — | The type of the time-off. |
user | object | Yes | — | The time-off user. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"note",
"notifyUsers"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
},
"durationInMinutes": {
"type": "integer",
"description": "The duration of time off is determined by the type selected: if the time off type is `CUSTOM`, the `durationInMinutes` field is `required`."
},
"endDate": {
"type": "string",
"description": "The time-off end date. The `endDate` must be on or after the `startDate`, formatted as _YYYY-MM-DD_."
},
"note": {
"type": "string",
"description": "The note or comment about the time-off."
},
"notifyUsers": {
"type": "object",
"description": "Users to notify about your time off.",
"properties": {
"projectOwners": {
"type": "boolean",
"description": "Notify project owners of projects I'm part of."
},
"others": {
"type": "array",
"items": {
"type": "object"
},
"description": "Users to notify about your time off."
}
}
},
"startDate": {
"type": "string",
"description": "The time-off start date. The format for the start date is _YYYY-MM-DD_."
},
"timeOffId": {
"type": "integer",
"description": "The unique `identifier` of the time-off is generated by the system and used to identify the time-off globally."
},
"type": {
"type": "string",
"description": "The `type` of the time-off.",
"enum": [
"FULL_DAY",
"HALF_DAY",
"CUSTOM"
]
},
"user": {
"type": "object",
"description": "The time-off user.",
"properties": {
"emailId": {
"type": "string",
"description": "The user's email identifier."
},
"userId": {
"type": "integer",
"description": "The unique identifier for the customer."
},
"firstName": {
"type": "string",
"description": "The first name of the customer."
},
"lastName": {
"type": "string",
"description": "The last name of the customer."
}
}
}
},
"required": [
"PCID",
"endDate",
"startDate",
"type",
"user"
]
}
rocketlane_tasks_delete_task
Delete task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The ID of the task object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The ID of the task object"
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_delete_time_entry
Delete a time entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timeEntryId | integer | Yes | — | The unique, system-generated identifier, which can be used to identify the time entry globally. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"timeEntryId": {
"type": "integer",
"description": "The unique, system-generated identifier, which can be used to identify the time entry globally."
}
},
"required": [
"PCID",
"timeEntryId"
]
}
rocketlane_tasks_delete_timeoff
Delete a time-off Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timeOffId | integer | Yes | — | The ID of the time-off object |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"timeOffId": {
"type": "integer",
"description": "The ID of the time-off object"
}
},
"required": [
"PCID",
"timeOffId"
]
}
rocketlane_tasks_get_all_resource_allocations
Get all Resource allocations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startDate | string | Yes | — | 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. |
endDate | string | Yes | — | You can use this parameter to define an end date, and the API will return allocations that end on or before the specified date. |
pageSize | number | No | — | 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. |
pageToken | string | No | — | 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. |
includeFields | string[] | No | — | 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. |
includeAllFields | boolean | No | — | 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 | string | No | — | You can use the sortBy param to sort the responses by the given field. |
sortOrder | string | No | — | 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 | string | No | — | 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.eq | string | No | — | 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.oneOf | string | No | — | 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.noneOf | string | No | — | 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.eq | string | No | — | You can use this parameter to specify a project id, and the API will return allocations that exactly match the given project id. |
projectId.oneOf | string | No | — | 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.noneOf | string | No | — | 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.eq | string | No | — | You can use this parameter to specify a placeholder id, and the API will return allocations that exactly match the given placeholder id. |
placeholderId.oneOf | string | No | — | 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.noneOf | string | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"startDate": {
"type": "string",
"description": "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."
},
"endDate": {
"type": "string",
"description": "You can use this parameter to define an end date, and the API will return allocations that end on or before the specified date."
},
"pageSize": {
"type": "number",
"description": "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."
},
"pageToken": {
"type": "string",
"description": "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."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"member",
"task",
"placeholder",
"duration"
]
},
"description": "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."
},
"includeAllFields": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "You can use the sortBy param to sort the responses by the given field.",
"enum": [
"startDate",
"endDate",
"allocationType",
"allocationFor"
]
},
"sortOrder": {
"type": "string",
"description": "The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.",
"enum": [
"ASC",
"DESC"
]
},
"match": {
"type": "string",
"description": "You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.",
"enum": [
"all",
"any"
]
},
"memberId.eq": {
"type": "string",
"description": "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.oneOf": {
"type": "string",
"description": "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.noneOf": {
"type": "string",
"description": "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.eq": {
"type": "string",
"description": "You can use this parameter to specify a project id, and the API will return allocations that exactly match the given project id."
},
"projectId.oneOf": {
"type": "string",
"description": "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.noneOf": {
"type": "string",
"description": "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.eq": {
"type": "string",
"description": "You can use this parameter to specify a placeholder id, and the API will return allocations that exactly match the given placeholder id."
},
"placeholderId.oneOf": {
"type": "string",
"description": "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.noneOf": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"startDate",
"endDate"
]
}
rocketlane_tasks_get_all_tasks
Get all tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | number | No | — | 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. |
pageToken | string | No | — | 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. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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 | string | No | — | You can use the sortBy param to sort the responses by the given field. |
sortOrder | string | No | — | 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 | string | No | — | You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND. |
startDate.gt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date. |
startDate.eq | string | No | — | You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date. |
startDate.lt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than the given date. |
startDate.ge | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date. |
startDate.le | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date. |
dueDate.gt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date. |
dueDate.eq | string | No | — | You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date. |
dueDate.lt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than the given date. |
dueDate.ge | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date. |
dueDate.le | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date. |
startDateActual.gt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date. |
startDateActual.eq | string | No | — | You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date. |
startDateActual.lt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than the given date. |
startDateActual.ge | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date. |
startDateActual.le | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date. |
dueDateActual.gt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date. |
dueDateActual.eq | string | No | — | You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date. |
dueDateActual.lt | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than the given date. |
dueDateActual.ge | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date. |
dueDateActual.le | string | No | — | You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date. |
createdAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than the given tasks created date. |
createdAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain exact matches of tasks that match the given tasks created date. |
createdAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than the given tasks created date. |
createdAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than or equal to the given tasks created date. |
createdAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than or equal to the given tasks created date. |
updatedAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than the given tasks updated date. |
updatedAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain exact matches of tasks that match the given tasks updated date. |
updatedAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than the given tasks updated date. |
updatedAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than or equal to the given tasks updated date. |
updatedAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than or equal to the given tasks updated date. |
projectId.eq | number | No | — | You can use this param to specify some value as project id and the responses will contain exact matches of tasks that match the given value. |
phaseId.eq | number | No | — | You can use this param to specify some value as phase id and the responses will contain exact matches of tasks that match the given value. |
taskName.eq | string | No | — | You can use this param to specify some task name and the responses will contain exact matches of tasks that match the given name. |
taskName.cn | string | No | — | You can use this param to specify some task name and the responses will contain matches of tasks that match the given name. |
taskName.nc | string | No | — | You can use this param to specify some task name and the responses will not contain matches of tasks that match the given name. |
effortInMinutes.eq | number | No | — | You can use this param to specify some value as effort and the responses will contain exact matches of tasks that match the given value. |
effortInMinutes.gt | number | No | — | You can use this param to specify some value as effort and the responses will contain exact matches of tasks greater than that of the given value. |
effortInMinutes.lt | number | No | — | You can use this param to specify some value as effort and the responses will contain exact matches of tasks lesser than that of the given value. |
progress.eq | number | No | — | You can use this param to specify some value as progress and the responses will contain exact matches of tasks that match the given value. |
progress.gt | number | No | — | You can use this param to specify some value as progress and the responses will contain exact matches of tasks greater than that of the given value. |
progress.lt | number | No | — | You can use this param to specify some value as progress and the responses will contain exact matches of tasks lesser than that of the given value. |
includeArchive.eq | boolean | No | — | You can use this parameter to specify whether responses will include the archived tasks. |
task.status.eq | string | No | — | You can use this param to provide status and the responses will contain tasks that are equal to the given status |
task.status.oneOf | string | No | — | You can use this param to provide statuses and the responses will contain tasks that contains the given status |
task.status.noneOf | string | No | — | You can use this param to provide statuses and the responses will not contain tasks that are equal to the given status |
project.status.eq | string | No | — | You can use this param to provide status of project and the responses will contain tasks whose project’s status are equal to the given status |
project.status.oneOf | string | No | — | You can use this param to provide statuses of project and the responses will contain tasks whose project’s statuses that contains the given status |
project.status.noneOf | string | No | — | You can use this param to provide statuses of project and the responses will not contain tasks whose project’s statuses are equal to the given status(es) |
externalReferenceId.eq | string | No | — | You can use this param to provide external reference id and the responses will contain tasks that are equal to the given id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "number",
"description": "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."
},
"pageToken": {
"type": "string",
"description": "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."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"startDateActual",
"dueDateActual",
"type",
"phase",
"assignees",
"followers",
"dependencies",
"billable",
"csatEnabled",
"priority",
"timeEntryCategory",
"financialsBudget",
"taskPrivateNote",
"parent",
"externalReferenceId"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "You can use the sortBy param to sort the responses by the given field.",
"enum": [
"taskName",
"startDate",
"dueDate",
"startDateActual",
"dueDateActual"
]
},
"sortOrder": {
"type": "string",
"description": "The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.",
"enum": [
"ASC",
"DESC"
]
},
"match": {
"type": "string",
"description": "You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.",
"enum": [
"all",
"any"
]
},
"startDate.gt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date."
},
"startDate.eq": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date."
},
"startDate.lt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than the given date."
},
"startDate.ge": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date."
},
"startDate.le": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date."
},
"dueDate.gt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date."
},
"dueDate.eq": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date."
},
"dueDate.lt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than the given date."
},
"dueDate.ge": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date."
},
"dueDate.le": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date."
},
"startDateActual.gt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date."
},
"startDateActual.eq": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date."
},
"startDateActual.lt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than the given date."
},
"startDateActual.ge": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date."
},
"startDateActual.le": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date."
},
"dueDateActual.gt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than the given date."
},
"dueDateActual.eq": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain exact matches of tasks that match the given date."
},
"dueDateActual.lt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than the given date."
},
"dueDateActual.ge": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are greater than or equal to the given date."
},
"dueDateActual.le": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain tasks whose date are less than or equal to the given date."
},
"createdAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than the given tasks created date."
},
"createdAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain exact matches of tasks that match the given tasks created date."
},
"createdAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than the given tasks created date."
},
"createdAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than or equal to the given tasks created date."
},
"createdAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than or equal to the given tasks created date."
},
"updatedAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than the given tasks updated date."
},
"updatedAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain exact matches of tasks that match the given tasks updated date."
},
"updatedAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than the given tasks updated date."
},
"updatedAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are greater than or equal to the given tasks updated date."
},
"updatedAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain tasks whose date are less than or equal to the given tasks updated date."
},
"projectId.eq": {
"type": "number",
"description": "You can use this param to specify some value as project id and the responses will contain exact matches of tasks that match the given value."
},
"phaseId.eq": {
"type": "number",
"description": "You can use this param to specify some value as phase id and the responses will contain exact matches of tasks that match the given value."
},
"taskName.eq": {
"type": "string",
"description": "You can use this param to specify some task name and the responses will contain exact matches of tasks that match the given name."
},
"taskName.cn": {
"type": "string",
"description": "You can use this param to specify some task name and the responses will contain matches of tasks that match the given name."
},
"taskName.nc": {
"type": "string",
"description": "You can use this param to specify some task name and the responses will not contain matches of tasks that match the given name."
},
"effortInMinutes.eq": {
"type": "number",
"description": "You can use this param to specify some value as effort and the responses will contain exact matches of tasks that match the given value."
},
"effortInMinutes.gt": {
"type": "number",
"description": "You can use this param to specify some value as effort and the responses will contain exact matches of tasks greater than that of the given value."
},
"effortInMinutes.lt": {
"type": "number",
"description": "You can use this param to specify some value as effort and the responses will contain exact matches of tasks lesser than that of the given value."
},
"progress.eq": {
"type": "number",
"description": "You can use this param to specify some value as progress and the responses will contain exact matches of tasks that match the given value."
},
"progress.gt": {
"type": "number",
"description": "You can use this param to specify some value as progress and the responses will contain exact matches of tasks greater than that of the given value."
},
"progress.lt": {
"type": "number",
"description": "You can use this param to specify some value as progress and the responses will contain exact matches of tasks lesser than that of the given value."
},
"includeArchive.eq": {
"type": "boolean",
"description": "You can use this parameter to specify whether responses will include the archived tasks."
},
"task.status.eq": {
"type": "string",
"description": "You can use this param to provide status and the responses will contain tasks that are equal to the given status"
},
"task.status.oneOf": {
"type": "string",
"description": "You can use this param to provide statuses and the responses will contain tasks that contains the given status"
},
"task.status.noneOf": {
"type": "string",
"description": "You can use this param to provide statuses and the responses will not contain tasks that are equal to the given status"
},
"project.status.eq": {
"type": "string",
"description": "You can use this param to provide status of project and the responses will contain tasks whose project's status are equal to the given status"
},
"project.status.oneOf": {
"type": "string",
"description": "You can use this param to provide statuses of project and the responses will contain tasks whose project's statuses that contains the given status"
},
"project.status.noneOf": {
"type": "string",
"description": "You can use this param to provide statuses of project and the responses will not contain tasks whose project's statuses are equal to the given status(es)"
},
"externalReferenceId.eq": {
"type": "string",
"description": "You can use this param to provide external reference id and the responses will contain tasks that are equal to the given id"
}
},
"required": [
"PCID"
]
}
rocketlane_tasks_get_all_time_entries
Get all time entries Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | number | No | — | 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. |
pageToken | string | No | — | 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. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
sortBy | string | No | — | You can use the sortBy param to sort the responses by the given field. Valid fields to perform sortBy are: MINUTES, DATE, ID and BILLABLE. |
sortOrder | string | No | — | 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 | string | No | — | You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND. |
date.gt | string | No | — | You can use this param to specify some date and the responses will contain time-entries whose date are greater than the given date. |
date.eq | string | No | — | You can use this param to specify some date and the responses will contain exact matches of time-entries that match the given date. |
date.lt | string | No | — | You can use this param to specify some date and the responses will contain time-entries whose date are less than the given date. |
date.ge | string | No | — | You can use this param to specify some date and the responses will contain time-entries whose date are greater than or equal to the given date. |
date.le | string | No | — | You can use this param to specify some date and the responses will contain time-entries whose date are less than or equal to the given date. |
project.eq | number | No | — | You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project. |
projectId.eq | number | No | — | You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project. |
task.eq | number | No | — | You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task. |
taskId.eq | number | No | — | You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task. |
taskId.oneOf | number | No | — | You can use this param to provide ids of task and the responses will contain time entries whose time entries that contains the given task ids |
taskId.noneOf | number | No | — | You can use this param to provide ids of task and the responses will contain time entries whose time entries that contains the given task ids |
projectPhase.eq | number | No | — | You can use this param to specify some project phase Id and the responses will contain exact matches of time-entries that match the given phase. |
category.eq | number | No | — | You can use this param to specify some category Id and the responses will contain exact matches of time-entries that match the given category. |
user.eq | number | No | — | You can use this param to specify some user Id and the responses will contain exact matches of time-entries that belong to the user with the given user Id. |
emailId.eq | string | No | — | You can use this param to specify some email Id and the responses will contain exact matches of time-entries that belong to the user with the given email Id. |
emailId.cn | string | No | — | You can use this param to specify some text and the responses will contain time-entries that contain the given text in their email name. |
emailId.nc | string | No | — | You can use this param to specify some text and the responses will contain time-entries that DO NOT contain the given text in their email Id. |
sourceType.eq | string | No | — | You can use this param to specify a source type for the time entries and the responses will contain exact matches of time-entries that have the given source type. |
activityName.eq | string | No | — | You can use this param to specify some activity name and the responses will contain exact matches of time-entries that match the given activity name. |
activityName.cn | string | No | — | You can use this param to specify some text and the responses will contain time-entries that contain the given text in their activity name. |
activityName.nc | string | No | — | You can use this param to specify some text and the responses will contain time-entries that DO NOT contain the given text in their activity name. |
approvalStatus.eq | string | No | — | You can use this param to specify an approval status for the time entries and the responses will contain exact matches of time-entries that have the given approval type. |
submittedBy.eq | number | No | — | You can use this param to specify a submitter for the time entries and the response will contain time-entries submitted by the given user. |
submittedAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries submitted at the given timestamp. |
submittedAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries submitted after the given timestamp. |
submittedAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries submitted at or after the given timestamp. |
submittedAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries submitted before the given timestamp. |
submittedAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries submitted at or before the given timestamp. |
approvedBy.eq | number | No | — | You can use this param to specify an approver for the time entries and the response will contain time-entries approved by the given user. |
approvedAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries approved at the given timestamp. |
approvedAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries approved after the given timestamp. |
approvedAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries approved at or after the given timestamp. |
approvedAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries approved before the given timestamp. |
approvedAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries approved at or before the given timestamp. |
rejectedBy.eq | number | No | — | You can use this param to specify a rejecter for the time entries and the response will contain time-entries rejected by the given user. |
rejectedAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries rejected at the given timestamp. |
rejectedAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries rejected after the given timestamp. |
rejectedAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries rejected at or after the given timestamp. |
rejectedAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries rejected before the given timestamp. |
rejectedAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries rejected at or before the given timestamp. |
billable.eq | boolean | No | — | You can use this param to specify the billable flag for the time entries and the responses will contain exact matches of time-entries that have the given billable. |
includeDeleted.eq | boolean | No | — | You can use this parameter to specify whether responses will include the deleted time entries. |
createdAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than the given time entries created date. |
createdAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain exact matches of time entries that match the given time entries created date. |
createdAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than the given time entries created date. |
createdAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than or equal to the given time entries created date. |
createdAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than or equal to the given time entries created date. |
updatedAt.gt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than the given time entries updated date. |
updatedAt.eq | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain exact matches of time entries that match the given time entries updated date. |
updatedAt.lt | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than the given time entries updated date. |
updatedAt.ge | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than or equal to the given time entries updated date. |
updatedAt.le | integer | No | — | You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than or equal to the given time entries updated date. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "number",
"description": "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."
},
"pageToken": {
"type": "string",
"description": "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."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"notes",
"sourceType",
"deleted",
"status",
"submittedBy",
"submittedAt",
"approvedBy",
"approvedAt",
"rejectedBy",
"rejectedAt",
"costRate",
"billRate"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"sortBy": {
"type": "string",
"description": "You can use the sortBy param to sort the responses by the given field. Valid fields to perform sortBy are: `MINUTES`, `DATE`, `ID` and `BILLABLE`.",
"enum": [
"minutes",
"date",
"id",
"billable"
]
},
"sortOrder": {
"type": "string",
"description": "The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.",
"enum": [
"ASC",
"DESC"
]
},
"match": {
"type": "string",
"description": "You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.",
"enum": [
"all",
"any"
]
},
"date.gt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain time-entries whose date are greater than the given date."
},
"date.eq": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain exact matches of time-entries that match the given date."
},
"date.lt": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain time-entries whose date are less than the given date."
},
"date.ge": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain time-entries whose date are greater than or equal to the given date."
},
"date.le": {
"type": "string",
"description": "You can use this param to specify some date and the responses will contain time-entries whose date are less than or equal to the given date."
},
"project.eq": {
"type": "number",
"description": "You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project."
},
"projectId.eq": {
"type": "number",
"description": "You can use this param to specify some project Id and the responses will contain exact matches of time-entries that match the given project."
},
"task.eq": {
"type": "number",
"description": "You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task."
},
"taskId.eq": {
"type": "number",
"description": "You can use this param to specify some task Id and the responses will contain exact matches of time-entries that match the given task."
},
"taskId.oneOf": {
"type": "number",
"description": "You can use this param to provide ids of task and the responses will contain time entries whose time entries that contains the given task ids"
},
"taskId.noneOf": {
"type": "number",
"description": "You can use this param to provide ids of task and the responses will contain time entries whose time entries that contains the given task ids"
},
"projectPhase.eq": {
"type": "number",
"description": "You can use this param to specify some project phase Id and the responses will contain exact matches of time-entries that match the given phase."
},
"category.eq": {
"type": "number",
"description": "You can use this param to specify some category Id and the responses will contain exact matches of time-entries that match the given category."
},
"user.eq": {
"type": "number",
"description": "You can use this param to specify some user Id and the responses will contain exact matches of time-entries that belong to the user with the given user Id."
},
"emailId.eq": {
"type": "string",
"description": "You can use this param to specify some email Id and the responses will contain exact matches of time-entries that belong to the user with the given email Id."
},
"emailId.cn": {
"type": "string",
"description": "You can use this param to specify some text and the responses will contain time-entries that contain the given text in their email name."
},
"emailId.nc": {
"type": "string",
"description": "You can use this param to specify some text and the responses will contain time-entries that _DO NOT_ contain the given text in their email Id."
},
"sourceType.eq": {
"type": "string",
"description": "You can use this param to specify a source type for the time entries and the responses will contain exact matches of time-entries that have the given source type.",
"enum": [
"GOOGLE_CALENDAR",
"OUTLOOK_CALENDAR",
"TASK",
"PROJECT",
"PHASE",
"ADHOC",
"MILESTONE"
]
},
"activityName.eq": {
"type": "string",
"description": "You can use this param to specify some activity name and the responses will contain exact matches of time-entries that match the given activity name."
},
"activityName.cn": {
"type": "string",
"description": "You can use this param to specify some text and the responses will contain time-entries that contain the given text in their activity name."
},
"activityName.nc": {
"type": "string",
"description": "You can use this param to specify some text and the responses will contain time-entries that _DO NOT_ contain the given text in their activity name."
},
"approvalStatus.eq": {
"type": "string",
"description": "You can use this param to specify an approval status for the time entries and the responses will contain exact matches of time-entries that have the given approval type.",
"enum": [
"NOT_SUBMITTED",
"SUBMITTED",
"APPROVED",
"REJECTED"
]
},
"submittedBy.eq": {
"type": "number",
"description": "You can use this param to specify a submitter for the time entries and the response will contain time-entries submitted by the given user."
},
"submittedAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries submitted at the given timestamp."
},
"submittedAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries submitted after the given timestamp."
},
"submittedAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries submitted at or after the given timestamp."
},
"submittedAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries submitted before the given timestamp."
},
"submittedAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries submitted at or before the given timestamp."
},
"approvedBy.eq": {
"type": "number",
"description": "You can use this param to specify an approver for the time entries and the response will contain time-entries approved by the given user."
},
"approvedAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries approved at the given timestamp."
},
"approvedAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries approved after the given timestamp."
},
"approvedAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries approved at or after the given timestamp."
},
"approvedAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries approved before the given timestamp."
},
"approvedAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries approved at or before the given timestamp."
},
"rejectedBy.eq": {
"type": "number",
"description": "You can use this param to specify a rejecter for the time entries and the response will contain time-entries rejected by the given user."
},
"rejectedAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries rejected at the given timestamp."
},
"rejectedAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries rejected after the given timestamp."
},
"rejectedAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries rejected at or after the given timestamp."
},
"rejectedAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries rejected before the given timestamp."
},
"rejectedAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries rejected at or before the given timestamp."
},
"billable.eq": {
"type": "boolean",
"description": "You can use this param to specify the billable flag for the time entries and the responses will contain exact matches of time-entries that have the given billable."
},
"includeDeleted.eq": {
"type": "boolean",
"description": "You can use this parameter to specify whether responses will include the deleted time entries."
},
"createdAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than the given time entries created date."
},
"createdAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain exact matches of time entries that match the given time entries created date."
},
"createdAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than the given time entries created date."
},
"createdAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than or equal to the given time entries created date."
},
"createdAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than or equal to the given time entries created date."
},
"updatedAt.gt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than the given time entries updated date."
},
"updatedAt.eq": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain exact matches of time entries that match the given time entries updated date."
},
"updatedAt.lt": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than the given time entries updated date."
},
"updatedAt.ge": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are greater than or equal to the given time entries updated date."
},
"updatedAt.le": {
"type": "integer",
"description": "You can use this param to provide an epoch milli value and the responses will contain time entries whose date are less than or equal to the given time entries updated date."
}
},
"required": [
"PCID"
]
}
rocketlane_tasks_get_all_timeoffs
Get all time-offs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | number | No | — | 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. |
pageToken | string | No | — | 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. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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 | string | No | — | You can use the sortBy param to sort the responses by the given field. |
sortOrder | string | No | — | 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 | string | No | — | You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND. |
startDate.gt | string | No | — | Returns responses with start dates greater than the specified date. |
startDate.eq | string | No | — | Returns responses with start dates equal to the specified date. |
startDate.lt | string | No | — | Returns responses with start dates lesser than the specified date. |
startDate.ge | string | No | — | Returns responses with start dates greater than or equal to the specified date. |
startDate.le | string | No | — | Returns responses with start dates lesser than or equal to the specified date. |
endDate.gt | string | No | — | Returns responses with start dates greater than the specified date. |
endDate.eq | string | No | — | Returns responses with start dates equal to the specified date. |
endDate.lt | string | No | — | Returns responses with start dates lesser than the specified date. |
endDate.ge | string | No | — | Returns responses with start dates greater than or equal to the specified date. |
endDate.le | string | No | — | Returns responses with start dates lesser than or equal to the specified date.e. |
type.eq | string[] | No | — | Returns responses with time-offs that exactly match the specified time off type. |
type.oneOf | string[] | No | — | Returns responses with time-offs that matches one of the specified time off type. |
type.noneOf | string[] | No | — | Returns responses with time-offs that matches none of the specified time off type. |
userId.eq | string | No | — | Returns responses with time-offs that exactly match the specified user id. |
userId.oneOf | string | No | — | Returns responses with time-offs that matches one of the specified user id. |
userId.noneOf | string | No | — | Returns responses with time-offs that matches none of the specified user id. |
emailId.eq | string | No | — | Returns responses with time-offs that exactly match the specified user’s email id. |
emailId.oneOf | string | No | — | Returns responses with time-offs that matches one of the specified user’s email ids. |
emailId.noneOf | string | No | — | Returns responses with time-offs that matches none of the specified user’s email ids. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "number",
"description": "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."
},
"pageToken": {
"type": "string",
"description": "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."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"note",
"notifyUsers"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "You can use the sortBy param to sort the responses by the given field.",
"enum": [
"startDate",
"endDate",
"createdAt"
]
},
"sortOrder": {
"type": "string",
"description": "The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.",
"enum": [
"ASC",
"DESC"
]
},
"match": {
"type": "string",
"description": "You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.",
"enum": [
"all",
"any"
]
},
"startDate.gt": {
"type": "string",
"description": "Returns responses with start dates greater than the specified date."
},
"startDate.eq": {
"type": "string",
"description": "Returns responses with start dates equal to the specified date."
},
"startDate.lt": {
"type": "string",
"description": "Returns responses with start dates lesser than the specified date."
},
"startDate.ge": {
"type": "string",
"description": "Returns responses with start dates greater than or equal to the specified date."
},
"startDate.le": {
"type": "string",
"description": "Returns responses with start dates lesser than or equal to the specified date."
},
"endDate.gt": {
"type": "string",
"description": "Returns responses with start dates greater than the specified date."
},
"endDate.eq": {
"type": "string",
"description": "Returns responses with start dates equal to the specified date."
},
"endDate.lt": {
"type": "string",
"description": "Returns responses with start dates lesser than the specified date."
},
"endDate.ge": {
"type": "string",
"description": "Returns responses with start dates greater than or equal to the specified date."
},
"endDate.le": {
"type": "string",
"description": "Returns responses with start dates lesser than or equal to the specified date.e."
},
"type.eq": {
"type": "array",
"items": {
"type": "string",
"enum": [
"FULL_DAY",
"HALF_DAY",
"CUSTOM"
]
},
"description": "Returns responses with time-offs that exactly match the specified time off type."
},
"type.oneOf": {
"type": "array",
"items": {
"type": "string",
"enum": [
"FULL_DAY",
"HALF_DAY",
"CUSTOM"
]
},
"description": "Returns responses with time-offs that matches one of the specified time off type."
},
"type.noneOf": {
"type": "array",
"items": {
"type": "string",
"enum": [
"FULL_DAY",
"HALF_DAY",
"CUSTOM"
]
},
"description": "Returns responses with time-offs that matches none of the specified time off type."
},
"userId.eq": {
"type": "string",
"description": "Returns responses with time-offs that exactly match the specified user id."
},
"userId.oneOf": {
"type": "string",
"description": "Returns responses with time-offs that matches one of the specified user id."
},
"userId.noneOf": {
"type": "string",
"description": "Returns responses with time-offs that matches none of the specified user id."
},
"emailId.eq": {
"type": "string",
"description": "Returns responses with time-offs that exactly match the specified user's email id."
},
"emailId.oneOf": {
"type": "string",
"description": "Returns responses with time-offs that matches one of the specified user's email ids."
},
"emailId.noneOf": {
"type": "string",
"description": "Returns responses with time-offs that matches none of the specified user's email ids."
}
},
"required": [
"PCID"
]
}
rocketlane_tasks_get_task
Get task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated identifier, which can be used to identify the task globally."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"startDateActual",
"dueDateActual",
"type",
"phase",
"assignees",
"followers",
"dependencies",
"billable",
"csatEnabled",
"priority",
"timeEntryCategory",
"financialsBudget",
"taskPrivateNote",
"parent",
"externalReferenceId"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_get_time_entry
Get a time entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timeEntryId | integer | Yes | — | The unique, system-generated identifier, which can be used to identify the time entry globally. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"timeEntryId": {
"type": "integer",
"description": "The unique, system-generated identifier, which can be used to identify the time entry globally."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"notes",
"sourceType",
"deleted",
"status",
"submittedBy",
"submittedAt",
"approvedBy",
"approvedAt",
"rejectedBy",
"rejectedAt",
"costRate",
"billRate"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"timeEntryId"
]
}
rocketlane_tasks_get_time_entry_categories
Get time entry categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | number | No | — | 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. |
pageToken | string | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "number",
"description": "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."
},
"pageToken": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID"
]
}
rocketlane_tasks_get_timeoff
Get time-off by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timeOffId | integer | Yes | — | The unique identifier of the time-off is generated by the system and used to identify the time-off globally. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"timeOffId": {
"type": "integer",
"description": "The unique `identifier` of the time-off is generated by the system and used to identify the time-off globally."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"note",
"notifyUsers"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
}
},
"required": [
"PCID",
"timeOffId"
]
}
rocketlane_tasks_move_task_to_given_phase
Move a task to the phase by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
phase | object | Yes | — | The phase to which the task will be moved, associating the task with this phase. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"phase": {
"type": "object",
"description": "The phase to which the task will be moved, associating the task with this phase.",
"properties": {
"phaseId": {
"type": "integer",
"description": "The phases's unique, system-generated identifier, which can be used to identify the phase globally."
},
"phaseName": {
"type": "string",
"description": "Phase Name"
}
}
}
},
"required": [
"PCID",
"taskId",
"phase"
]
}
rocketlane_tasks_remove_assignees_from_task
Remove assignees from a task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
members | object[] | No | — | The list includes both team members and customers assigned to the task. |
placeholders | object[] | No | — | Rocketlane’s placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailId": {
"type": "string",
"description": "The user's email identifier."
},
"userId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the customer. `userId` will take precedence if both `emailId` and `userId` are provided."
},
"firstName": {
"type": "string",
"description": "The first name of the user."
},
"lastName": {
"type": "string",
"description": "The last name of the user."
}
}
},
"description": "The list includes both `team members` and `customers` assigned to the task."
},
"placeholders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"placeholderId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the placeholder."
},
"placeholderName": {
"type": "string",
"description": "The name of the placeholder."
},
"role": {
"type": "object",
"description": "The role of the member or placeholder to whom allocation is made for"
}
}
},
"description": "Rocketlane's placeholders are associated with roles. Based on the kind of roles and expertise that are needed to execute a task, placeholders can be added as assignees to templates as well as projects. Eventually, you can resolve placeholders by replacing them with team members according to their availability and role. Note: If the project is not built using sources, this value will be ignored but the mappings are retained and can be used in the future"
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_remove_dependencies_from_task
Remove dependencies from a task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
dependencies | object[] | Yes | — | Task Dependencies allow you to define relationships between tasks that are dependent on each other. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"dependencies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"taskId": {
"type": "integer",
"format": "int64",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
}
}
},
"description": "Task Dependencies allow you to define relationships between tasks that are dependent on each other."
}
},
"required": [
"PCID",
"taskId",
"dependencies"
]
}
rocketlane_tasks_remove_followers_from_task
Remove followers from a task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
members | object[] | No | — | The list includes both team members and customers assigned to the task. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailId": {
"type": "string",
"description": "The user's email identifier."
},
"userId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the customer. `userId` will take precedence if both `emailId` and `userId` are provided."
},
"firstName": {
"type": "string",
"description": "The first name of the user."
},
"lastName": {
"type": "string",
"description": "The last name of the user."
}
}
},
"description": "The list includes both `team members` and `customers` assigned to the task."
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_update_task
Update task by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | integer | Yes | — | The task’s unique, system-generated identifier, which can be used to identify the task globally |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
atRisk | boolean | No | — | Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task’s execution. |
dueDate | string | No | — | The date when a task completes its execution. It can be empty. If both startDate and dueDate are specified for a given task, it is necessary that the latter should be on or after the given startDate. The format for the due date is YYYY-MM-DD. |
effortInMinutes | integer | No | — | The effort is the expected time required to complete the task. The value is determined in minutes. |
externalReferenceId | string | No | — | An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency. |
fields | object[] | No | — | The custom fields can be set during the task creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type. |
private | boolean | No | — | This depicts if the task is private or not. |
progress | integer | No | — | The task’s progress, if indicated, will be available here and ranges in value from 0 to 100. The task’s status can be used in place of this field, however progress can offer more precise data. |
startDate | string | No | — | The date when a task starts its execution. It can be empty. The format for the start date is YYYY-MM-DD. |
status | object | No | — | The value of the task status can be specified here and this is essential to keep track of it. |
taskDescription | string | No | — | The description of the task. The description body needs to be in html format to avoid any formatting issues in the application. |
taskName | string | No | — | The name of the task. |
taskPrivateNote | string | No | — | The privateNote for the task is intended exclusively for team members. The note’s content should be in HTML format to prevent any formatting issues in the application. |
type | string | No | — | The type of the task if specified will be available here. There are two options: MILESTONE or TASK. If a task is not explicitly marked as a milestone, it takes the default value as TASK. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task’s execution. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "integer",
"description": "The task's unique, system-generated **identifier**, which can be used to identify the task globally"
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"startDateActual",
"dueDateActual",
"type",
"phase",
"assignees",
"followers",
"dependencies",
"billable",
"csatEnabled",
"priority",
"timeEntryCategory",
"financialsBudget",
"taskPrivateNote",
"parent",
"externalReferenceId"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
},
"atRisk": {
"type": "boolean",
"description": "Indicates whether the task has been marked as At Risk. This parameter is used to indicate that immediate action is necessary to unblock the task's execution."
},
"dueDate": {
"type": "string",
"description": "The date when a task completes its execution. It can be empty. If both `startDate` and `dueDate` are specified for a given task, it is necessary that the latter should be on or after the given `startDate`. The format for the due date is _YYYY-MM-DD_."
},
"effortInMinutes": {
"type": "integer",
"description": "The effort is the expected time required to complete the task. The value is determined in minutes."
},
"externalReferenceId": {
"type": "string",
"description": "An externalReferenceId is a unique identifier that links entities or transactions between external systems and Rocketlane, ensuring accurate data correlation and consistency."
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the field"
},
"fieldLabel": {
"type": "string",
"description": "The fieldLabel is the name of the custom field."
},
"fieldValue": {
"type": "object",
"description": "The value for the field. It can either be a string or a number or number array. Refer [example](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know more about assigning value for different fields."
}
}
},
"description": "The custom fields can be set during the task creation with the help of `fields`. The `fieldValue` can be either a string or a number or an array and it has to comply with the type of the field. Refer [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`."
},
"private": {
"type": "boolean",
"description": "This depicts if the task is private or not."
},
"progress": {
"type": "integer",
"description": "The task's progress, if indicated, will be available here and ranges in value from 0 to 100. The task's status can be used in place of this field, however progress can offer more precise data."
},
"startDate": {
"type": "string",
"description": "The date when a task starts its execution. It can be empty. The format for the start date is _YYYY-MM-DD_."
},
"status": {
"type": "object",
"description": "The value of the task status can be specified here and this is essential to keep track of it.",
"properties": {
"value": {
"type": "integer",
"description": "The value of the status field."
}
}
},
"taskDescription": {
"type": "string",
"description": "The `description` of the task. The description body needs to be in **html** format to avoid any formatting issues in the application."
},
"taskName": {
"type": "string",
"description": "The **name** of the task."
},
"taskPrivateNote": {
"type": "string",
"description": "The `privateNote` for the task is intended exclusively for team members. The note's content should be in `HTML` format to prevent any formatting issues in the application."
},
"type": {
"type": "string",
"description": "The type of the task if specified will be available here. There are two options: `MILESTONE` or `TASK`. If a task is not explicitly marked as a milestone, it takes the default value as `TASK`. Milestones refer to critical tasks in the project that include an inbuilt CSAT capability that allows customers to offer CSAT evaluations depending on the task's execution.",
"enum": [
"TASK",
"MILESTONE"
]
}
},
"required": [
"PCID",
"taskId"
]
}
rocketlane_tasks_update_time_entry
Update a time entry Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
timeEntryId | integer | Yes | — | The unique, system-generated identifier, which can be used to identify the time entry globally. |
includeFields | string[] | No | — | This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned. |
includeAllFields | boolean | No | — | 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. |
activityName | string | No | — | Name of the adhoc activity being performed |
billable | boolean | No | — | The billable value |
category | object | No | — | Category associated with the time entry |
date | string | No | — | Date of the time entry in format YYYY-MM-DD |
fields | object[] | No | — | The custom fields can be set during the time-entry creation with the help of fields. The fieldValue can be either a string or a number or an array and it has to comply with the type of the field. Refer examples to know how to assign fieldValue based on their field_type. |
minutes | integer | No | — | Duration of the time entry in minutes |
notes | string | No | — | Notes for the time entry |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"timeEntryId": {
"type": "integer",
"description": "The unique, system-generated identifier, which can be used to identify the time entry globally."
},
"includeFields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"notes",
"sourceType",
"deleted",
"status",
"submittedBy",
"submittedAt",
"approvedBy",
"approvedAt",
"rejectedBy",
"rejectedAt",
"costRate",
"billRate"
]
},
"description": "This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned."
},
"includeAllFields": {
"type": "boolean",
"description": "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."
},
"activityName": {
"type": "string",
"description": "Name of the adhoc activity being performed"
},
"billable": {
"type": "boolean",
"description": "The billable value"
},
"category": {
"type": "object",
"description": "Category associated with the time entry",
"properties": {
"categoryName": {
"type": "string",
"description": "The name of the category."
},
"categoryId": {
"type": "integer",
"description": "The unique identifier for the category."
}
}
},
"date": {
"type": "string",
"description": "Date of the time entry in format YYYY-MM-DD"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the field"
},
"fieldLabel": {
"type": "string",
"description": "The fieldLabel is the name of the custom field."
},
"fieldValue": {
"type": "object",
"description": "The value for the field. It can either be a string or a number or number array. Refer [example](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know more about assigning value for different fields."
}
}
},
"description": "The custom fields can be set during the time-entry creation with the help of `fields`. The `fieldValue` can be either a string or a number or an array and it has to comply with the type of the field. Refer [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how to assign `fieldValue` based on their `field_type`."
},
"minutes": {
"type": "integer",
"description": "Duration of the time entry in minutes"
},
"notes": {
"type": "string",
"description": "Notes for the time entry"
}
},
"required": [
"PCID",
"timeEntryId"
]
}