Contribute in GitHub:
Edit online
Entity, User, Comment
The entity object in the root level is the Business Object (also referred to as an Entity) that is passed to the template for processing. This object can be a User Story, Bug, Task, Feature, or any other Entity type
in Targetprocess. An entity may contain references to other entities.
The user object in the root level is always the user who is the recipient of the email. Objects of User class may be referenced in fields and collections such as Assignments, Owner,
LastEditor.
📘 Fields
A field is a member variable that belongs to an object.
Common fields
These properties are common among all entities.
| Field | Type | Description |
|---|---|---|
| .ID | Integer | The entity’s numeric ID. |
Entity: Assignable
These properties are common among assignable entities (for example, User Stories, Bugs, Features, and Tasks).
| Field | Type | Description |
|---|---|---|
| .Name | String | The name of the entity. |
| .Description | String | The entity’s description text. Formatting is HTML processed properly. |
| .Kind.Kind.ToString() | Object (Kind) | String The name of the entity type. For instance it can be UserStory, Bug, Task, Feature, Request, or any other Targetprocess entity. |
| .Priority | Object Priority | The current priority (business value) of the entity. |
| .Release.Iteration | Object Release | Object Iteration The current release / iteration (sprint) the entity is assigned to. |
| .TeamsCollection | Array of Objects Assignment | This array contains Assignments of Users to an entity. Details on responsible Roles are included as well. |
| .Owner | Object User | The user who is Owner of an entity. |
| .LastEditor | Object User | The user who performed most recent modification of an item. Example: Last Editor |
Priority
The current priority (business value) of the entity.
| Field | Type | Description |
|---|---|---|
| .Name | String | The name of the business value. |
Release, Iteration
The current release / iteration (sprint) the entity is assigned to. The object inherits all properties of Entity: Assignable object and has some additional ones.
| Field | Type | Description |
|---|---|---|
| .StartDate | Date | The start date of the release / iteration (sprint). |
| .EndDate | Date | The end date of the release / iteration (sprint). |
Assignment
The object represent assignment of a user to an entity. Details on responsible Role are included as well. Array of Assignments is retrieved from the Assignable entity via the following method:
$entity.TeamsCollection
| Field | Type | Description |
|---|---|---|
| .User | Object (User) | The user associated with the assignment. |
| .Role | Object (Role) | The role of the assignment. |
Role
The role of the assignment.
| Field | Type | Description |
|---|---|---|
| .Name | String | The name of the role. |
Comment
An (Assignable) entity has linked Comments collection.
| Field | Type | Description |
|---|---|---|
| .Description | String | The text of the comment. Formatting is HTML. Should be processed properly. |
| .General | Object (Assignable) | The entity to which the comment is submitted to. |
| .Owner | Object (User) | The user who submitted the comment. |
| .IsPrivate | Boolean | Private comments are hidden for Requesters in Service Desk. Requesters are external users who don't have Targetprocess license. |
User
The user object in the root level is always the user who is the recipient of the email. Objects of User class may be referenced in fields and collections such as Assignments,
Owner, LastEditor.
| Field | Type | Description |
|---|---|---|
| .FullName | String | The user’s full name. |
| .FirstName | String | The user’s first name. |
| .LastName | String | The user’s last name. |
| String | The user’s email address. | |
| .Login | String | The user’s login within Targetprocess. |
Interactive Data Model
You can find more detailed documentation on the Business Objects and their respective properties here: https://md5.tpondemand.com/api/v1/index/meta