Documentation

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Entity API / assign

Operation Information

  • Application Reference: com.hornbill.servicemanager
  • Scope: Entity - Requests
  • Class: Entity
  • Required Privilege Level: guest
  • Required Rights: none

Description

This operation assigns a Request to a team or a team member.

Request Parameters

The assign API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.

Name Type Required Description
inReference xs:string Yes The request that is being assigned
inAssignToId xs:string No The analyst id of who the request is being assigned to
inAssignToGroupId xs:string Yes The Group the request is being assigned to
returnAfterAssignment xs:string No This param is used when we want the flowcode to return after the assignment operation (i.e. skip resumong the BPM, updateing the timeline and send notifications). This param is false by default. It is used when we invoke this flowcode from a BPM process: in this case, we don't need to resume any BPM, and the flowcode related to the BPM process will write his own message on the timeline and post notifications.
updateTimelineInputs xs:string No A JSON formatted string, containing information that will be used to update the Request Timeline. This includes activityType, updateText, source, postType and visibility.
accessToken xs:string No System use only.

Response Parameters

Name Type Description
assignToSameOwner xs:string Populated if the request is assigned to the same owner.
requestId xs:string The request that is being assigned
assignError xs:string Populated with an error if the intended Owner or Team does not exist
teamName xs:string The name of the team the request has been assigned to
ownerName xs:string The name of the user the request has been assigned to

Code Examples

In This Document