Jump to Content
TargetprocessDocsDiscussionAPI ReferenceBlog
HomeDocsAPI ReferenceBlogDiscussion
DocsDiscussionAPI ReferenceBlogLog InTargetprocess
Log In

Documentation

  • Integrations with Targetprocess
  • Resources meta-info
  • Troubleshooting REST API issues

REST API v.1

  • Getting Started
  • Authentication
  • Resources and collections
  • Response formats
  • Paging
  • Sorting and Filters
  • Partial response (includes and excludes)
  • Appends and Calculations
  • Operations (CRUD)
    • Create
    • Update
    • Set Fields and Properties
    • Upload Attachments
    • Delete, Unassign
    • Converted Entities
    • Direct Access to Entities
  • Context
  • Use Cases
    • Users
    • Work Items
    • Assignments
    • Releases
    • Testing module
    • Time Reports
  • Code Samples
    • JavaScript
    • Google Apps Script

REST API v.2

  • Overview
  • Selectors and filters
  • Result
  • Working with Custom Fields
  • Working with Tags
  • Working with Dates
  • Filtering by Releases, Iterations and Team Iterations
  • Working with Relations
  • Getting first or last element of a collection

Historical records

  • What is a historical record?
  • Simple history
  • Full history
  • Examples
  • Custom Field values in history

Other APIs

  • RESTful Storage
  • Views Menu API
  • Validate Users and Requesters
  • Undelete API
  • Conversion API

Automation Rules

  • Automation Rules Overview
  • Setup
    • Sources
    • Filters
    • Actions
    • Other
    • How to apply Raw JSON from Examples
  • Diagnostic and troubleshooting
    • Automation Rule Logs
    • How to make rules more efficient
    • Limits and Timeouts
    • Troubleshooting: My Automation Rule is not working!
  • JavaScript for Automation Rules
    • JavaScript Reference
    • JavaScript Helper Functions
    • JavaScript DevOps functions
  • Examples: Actions in Targetprocess
    • Add an automatic comment when a Request is closed
    • Assign a Feature's Project to a User Story
    • Assign users to a parent when they are working on its child
    • Assign a User Story's Feature to a Bug
    • Assign a bug to a current Release/Team Iteration
    • Assign an item to the Person who started it
    • Assign the people working on a parent to a newly created child
    • Assign Project's Teams to a newly created item
    • Calculate Planned End Date based on Initial Estimate or Effort
    • Create a Related Bug for new Requests
    • Close a request when all related items are closed
    • Close an item on its Planned End Date
    • Close User Stories that stayed more than 10 days in a particular state
    • Close all children when the parent was closed
    • Close an item when all its children are closed
    • Create a set of Tasks under User Story based on a template
    • Create pre-defined hierarchy for new Projects
    • Entity Templates
    • Follow items automatically
    • Inherit Attachments from Child to Parent
    • Inherit Tags from a parent to its children
    • Inherit Team from parent to all its children
    • Inherit Team Iteration/Release/Iteration from parent to its children
    • Inherit Planned Dates from children to parents
    • Inherit Planned Dates from parents to children
    • Inherit Release/Iteration/Team Iteration from children to its parent
    • Inherit Portfolio Epic from Epic to its Features
    • Inherit relations from child to parents
    • Limit Planned Dates based on Relations
    • Move an item to “Planned” state when its Release / Iteration / Team Iteration is set
    • Move an item to “Planned” state when its Planned Start Date is set
    • Move an item to Blocked state
    • Move requests to particular project based on recipient email
    • Open User Story when one of its Bugs becomes open
    • Post a comment when an item is split
    • Reminders in comments
    • Reschedule work items in a Release / Iteration / Team Iteration
    • Reopen a Request when replied by requester
    • Set Found In Release/Team Iteration fields for Bugs
    • Set Velocity for new Team Iterations from effort of previous Team Iterations of the Team
    • Set default effort
    • Set Planned End Date based on Severity
    • Set Planned Dates based on Iteration/Release/Team Iteration dates
    • Start items on their Planned Start date
    • Start the parent item when a child item has been started
    • Start an item when time is added on it
    • Create Bug and attach to User Story from incoming webhook
    • Mention Assigned Users on Status Change
    • Apply several templates
    • Recalculate last run result when Test Case Run is deleted
    • Inherit Initial Estimate from Epic to Portfolio Epic
    • Set custom field for Request based on requester's domain
    • Update Team State of the Entity when a Team is assigned to it
  • Examples: Integration with GitLab
    • When GitLab Pipeline passes → move to state
    • When GitLab Commit pushed - Add new record to Sources tab on Entity View
  • Examples: Integration with Slack
    • Message to Slack when Request created
    • Send comments to Slack
    • Send personal Slack notifications about assignments
    • Send mentions to Slack directly
    • Send stuck stories to Slack
    • Send overdue features to Slack
    • Send closed stories to Slack
    • Slack Slash commands to create Request in Targetprocess
  • Examples: Integration with MS Teams
    • Message to MS Teams when a Request got new comment
    • Send mention to MS Teams about new assignment
    • Sending outgoing webhooks from MS Teams to Targetprocess
  • Examples: Integration with Wrike
    • Create Task in Wrike when User Story is create in Targetprocess
  • DevOps Integrations
    • Example: Change state in Targetprocess, when merge/pull request updates
    • Example: When repositories custom field value changes → create branch/merge request
    • Model Definition
  • Examples: Working with custom fields
    • Check the custom field value in a filter
    • Set custom field in UI action
    • Set custom field in Javascript action
    • Use custom field value in HTTP request action

Mashups

  • Overview
  • Install mashups from library
  • Install code of a mashup manually
  • Create your first mashup
  • Deactivate and delete mashups
  • Tweak views and UI elements
    • Detailed views
    • Main menu
    • Left menu (Views list)
    • Board, list and timeline views
    • Dashboards
    • Reports list
    • Timesheet
    • Settings
    • Any screen
  • Purposes supported
    • Show more details
    • Customize look and layout
    • Add controls and actions
    • Create interactive reports
    • Hide details and controls
    • Interrupt events and tweak actions
  • Placeholders
  • Custom units
  • Custom Lane Headers
  • Dashboard widgets
  • Customize Settings for Mashups

Metrics and Calculated Custom Fields

  • Metrics vs CCFs
  • Data Types
  • Custom Formulas Syntax
  • Entity Fields
  • Parent and Linked Entities
  • Custom Fields
  • Effort via Relations
  • Custom Progress Metrics
  • Customize Planned Dates with Metrics

Validation Rules

  • Validation Rules
  • Examples

Entity view customization

  • Customize Entity Detailed View
  • Limitations of Entity detailed view customization
  • Advanced Сustomization: Customize Inner Lists
  • External mashup support
    • Mashup: Feature state on User Story
    • Mashup: Copy User Story details to clipboard
    • Mashup: Epic on UserStory
    • Mashup: External link
    • Mashup: Rich text
    • Sibling marker(Workaround for Classes for Stack element)
  • Embedded Roadmap view customization
  • Advanced Сustomization: Custom styling
  • Setting up portfolioAssignments

UI Controls Configuration

  • Assignments Control Configuration
  • Configurable Dropdown

Zapier integration

  • Getting started
  • Supported Triggers and Actions
  • Use Cases
    • Create new items in Targetprocess from Slack
    • Integration with personal Toggl timer
    • Send an email when Time Spent is added

Email Notifications

  • Markup Guide
  • Templates
  • Entity, User, Comment
  • Tool
  • Conditions
  • Formatting Values
  • Examples

Webhooks (deprecated)

  • Webhooks in Targetprocess
  • Replacement with Automation Rules
    • Send notifications to Slack
    • Assign Users
    • Assign Requesters
    • Modify Custom Field values
    • Append Tags
  • Available fields and entities
  • Working with Custom Fields
  • Update trigger
  • Filters
  • Templates
  • Content type
  • External Integrations
    • Send notifications to Slack
  • Automatic Rules in Targetprocess
    • Create New Entities
    • Modify Description of work items
    • Modify States of work items
    • Assign Users
    • Assign Requesters
    • Add Followers
    • Modify Planned Dates
    • Assign Teams
    • Modify Custom Field values
    • Create Relations
    • Append Tags

Native Issue Level Integrations (Jira, ADO, TP)

  • JavaScript Routings
    • Example: Dynamic routing with the filter by process.
    • Example: Sync Features with specific Custom Field value
  • JavaScript Fields Mappings and Comparators
    • Example: Map Jira Worklog to Targetprocess time
    • Example: Map Jira Status Targetprocess TeamStates
  • WorkSharing API
Powered by 

Any screen

Suggest Edits

These mashups are rendered in any screen:

  • Browser Performance Monitor

Updated over 3 years ago