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 / addCard

Operation Information

  • Application Reference: com.hornbill.boardmanager
  • Scope: Entity - Card
  • Class: Entity
  • Required Privilege Level: user
  • Required Rights: Group A - canAddTo

Description

Add a card to the board

Request Parameters

The addCard 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
h_board_id xs:integer Yes The board Id
h_lane_id xs:integer No The Lane Id
h_title xs:string No Card Title
h_content xs:string No Display contents of card
h_order xs:integer No order card appears in lane
h_column xs:string No Which column within the lane a card will appear (if the lane has multiple columns)
h_type xs:string Yes Card Type that define what properties a card can have (eg card, note, seperator). Not different applications can define different types
h_value xs:decimal No A value for the card (eg scrum points, cost etc)
h_progress xs:integer No Progress of card from 0-100
h_key xs:string No The key if the card is related to another object
h_link xs:string No link to open from card
h_members xs:string No List of member URN to add
h_status_name xs:string No Status for Card
h_status_icon xs:string No Icon for status
h_status_info xs:string No Status info of the card
h_checklist xs:string No A checklist to add to the card
h_style xs:string No Custom style of card
tag_ids xs:integer No Tags data to add to card
h_activitystream_id xs:string No The activitystream to post updates too
fromBoard xs:boolean No Is this created from the board
h_custom_1 xs:string No The first custom field in board manager
h_custom_2 xs:string No The second custom field in board manager
h_custom_3 xs:string No The third custom field in board manager
h_custom_4 xs:string No The fourth custom field in board manager

Response Parameters

Name Type Description
h_card_id xs:integer Id of the newly created card
h_entered_on xs:dateTime Time set for when card entered
log xs:string Log message alerting any possible problems

Code Examples

In This Document