Connectors Reference
Get work done across projects and teams. Projectplace lets you plan, collaborate and track progress of all projects and assignments in an easy and user-friendly way.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Get board information |
|
|
create_card (integer board_id, [Optional]create_cardParameterBody body) |
Create Card |
|
move_card (integer board_id, [Optional]move_cardParameterBody body) |
Move card to another column |
|
Get cards on board |
|
|
Lists the boards the user have access to |
|
|
Get the Planlets that exists on a board |
|
|
Lists the members that have access to the board |
|
Name |
Summary |
|
set_webhook_card_create ([Optional]set_webhook_card_createParameterBody body) |
When a card is created |
|
set_webhook_properties_change ([Optional]set_webhook_properties_changeParameterBody body) |
When a card's properties are changed |
|
set_webhook_card_due_date ([Optional]set_webhook_card_due_dateParameterBody body) |
When a card is due |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get board information
Description: Retrieves detailed information about the board
Syntax:
Projectplace.get_board_info (integer board_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
board_id |
integer(int32)
|
|
True |
Returns:
Summary: Create Card
Description: Creates a new card with the parameters provided
Syntax:
Projectplace.create_card (integer board_id, [Optional]create_cardParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
board_id |
integer(int32) (Board) |
The id of the Board where the card should be created |
True |
|
|
body |
|
|
False |
Returns:
Type:create_cardResponse
Summary: Move card to another column
Description: Move a card on the selected board
Syntax:
Projectplace.move_card (integer board_id, [Optional]move_cardParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
board_id |
integer(int32) (Board) |
The id of the Board where the card should be created |
True |
|
|
body |
|
|
False |
Returns:
Type:move_cardResponse
Summary: Get cards on board
Description: Returns the list of cards on a board
Syntax:
Projectplace.get_cards (integer board_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
board_id |
integer(int32)
|
|
True |
Returns:
Type:array of (get_cardsResponseItem)
Summary: Lists the boards the user have access to
Description: Lists the boards that are part of the projects the user have access to
Syntax:
Projectplace.list_boards ()
Returns:
Type:array of (list_boardsResponseItem)
Summary: Get the Planlets that exists on a board
Description: Retrieves a list of Planlets that are connected to the specific board
Syntax:
Projectplace.get_planlets (integer board_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
board_id |
integer(int32)
|
|
True |
Returns:
Type:array of (get_planletsResponseItem)
Summary: Lists the members that have access to the board
Description: Lists the members that have access to the board specified
Syntax:
Projectplace.list_members (integer board_id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
board_id |
integer(int32)
|
|
True |
Returns:
Type:array of (list_membersResponseItem)
Summary: When a card is created
Description: Triggers when a card is created on the defined board
Syntax:
Projectplace.set_webhook_card_create ([Optional]set_webhook_card_createParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
set_webhook_card_createParameterBody
|
|
False |
Returns:
Summary: When a card's properties are changed
Description: Triggers when one of the card's properties are changed
Syntax:
Projectplace.set_webhook_properties_change ([Optional]set_webhook_properties_changeParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
set_webhook_properties_changeParameterBody
|
|
False |
Returns:
Summary: When a card is due
Description: Triggers on the date that the card is due
Syntax:
Projectplace.set_webhook_card_due_date ([Optional]set_webhook_card_due_dateParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
set_webhook_card_due_dateParameterBody
|
|
False |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
column_id |
integer(int32)
|
The column where the card should be created |
|
title |
string
|
The title of the created card |
|
description |
string
|
The description of the created card |
|
assignee_email |
string
|
The person that will be assigned to the created card |
|
planlet_id |
integer(int32)
|
The activity the Card should be associated with |
|
due_date |
string(date)
|
The due date of the created card |
|
label_id |
integer(int32)
|
The label of the created card |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
access |
string
|
Access rights |
|
assignee |
|
The person who is assigned to the card |
|
assignee_id |
integer
|
The id of the person who is assigned the card |
|
board_id |
integer(int32)
|
The ID of the board |
|
board_name |
string
|
The name of the board |
|
direct_url |
string
|
The card's direct URL |
|
due_date |
string
|
The due date of the card |
|
estimated_time |
string
|
Estimated time for completion |
|
id |
integer(int32)
|
The ID of the card |
|
is_blocked |
boolean
|
Is the card is |
|
is_blocked_reason |
string
|
The blocking reason - if blocked |
|
is_done |
boolean
|
Is the card done |
|
is_template |
boolean
|
Is a template card |
|
label_id |
integer(int32)
|
The id of the label |
|
planlet_id |
integer(int32)
|
The id of the planlet |
|
reported_time |
string
|
How much time was reported for the card |
|
title |
string
|
The card's title |
Summary:
Description: The person who is assigned to the card
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
access |
string
|
access |
|
activity_count |
integer(int32)
|
activity_count |
|
attachment_container_id |
integer(int32)
|
attachment_container_id |
|
done_count |
integer(int32)
|
done_count |
|
|
string
|
|
|
id |
integer(int32)
|
id |
|
is_archived |
boolean
|
is_archived |
|
labels |
array of (LabelsItem)
|
labels |
|
mail_active |
boolean
|
mail_active |
|
name |
string
|
name |
|
progresses |
array of (ProgressesItem)
|
progresses |
|
project |
|
project |
|
project_id |
integer(int32)
|
project_id |
|
project_step |
string
|
project_step |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
display_order |
integer(int32)
|
display_order |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
display_order |
integer(int32)
|
display_order |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
|
wip_limit |
string
|
wip_limit |
Summary:
Description: project
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
|
is_team_member_plus |
boolean
|
is_team_member_plus |
|
is_team_member_plus_plan |
boolean
|
is_team_member_plus_plan |
|
name |
string
|
name |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
|
title |
string
|
title |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32)
|
id |
|
name |
string
|
name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
board |
integer(int32)
|
board |
|
name |
string
|
name |
|
project_id |
integer(int32)
|
project_id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
avatar |
string
|
avatar |
|
|
string
|
|
|
first_name |
string
|
first_name |
|
id |
integer(int32)
|
id |
|
last_name |
string
|
last_name |
|
name |
string
|
name |
|
role |
string
|
role |
|
type |
string
|
type |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
card_id |
integer(int32)
|
The card to be moved |
|
card_title |
string
|
The title of the card to be moved |
|
column_id |
integer(int32)
|
The column where the card should be moved to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
access |
string
|
Access rights |
|
assignee_id |
integer(int32)
|
The ID of the person the card assigned to |
|
board_id |
integer(int32)
|
The ID of the board |
|
board_name |
string
|
The name of the board |
|
column_id |
integer(int32)
|
The id of the column the card is on |
|
column_name |
string
|
The name of the column |
|
description |
string
|
The description on the card |
|
direct_url |
string
|
The direct URL of the card |
|
due_date |
string
|
The due date of the card |
|
estimated_time |
string
|
The estimated time of the card |
|
id |
integer(int32)
|
The id of the card |
|
is_blocked |
boolean
|
Is the card blocked |
|
is_blocked_reason |
string
|
The reason the card is blocked |
|
is_done |
boolean
|
Is the card done |
|
is_template |
boolean
|
Is a template card |
|
label_id |
integer(int32)
|
The id of the card's label |
|
label_name |
string
|
The name of the label |
|
planlet_id |
integer(int32)
|
The id of the planlet |
|
reported_time |
string
|
The time reported for this card |
|
title |
string
|
The title of the card |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
card_create |
boolean
|
Triggers when a card is created on the defined board Values: [, ] |
|
webhook |
string
|
webhook |
|
board_id |
integer(int32)
|
The id of the Board that the card belongs to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
due_today |
boolean
|
Triggers on the date that the card is due Values: [, ] |
|
webhook |
string
|
webhook |
|
board_id |
integer(int32)
|
The id of the Board that the card belongs to |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
card_blocked |
boolean
|
Triggers when a card is blocked Values: [, ] |
|
card_unblock |
boolean
|
Triggers when a card block is removed Values: [, ] |
|
status_change |
boolean
|
Triggers when a card is moved to another column on the Values: [, ] |
|
card_done |
boolean
|
Triggers when a card is set to done by moving it to the rightmost column on the board Values: [, ] |
|
description_changed |
boolean
|
Triggers when the description of a card changes Values: [, ] |
|
due_date_changed |
boolean
|
Triggers when the due date of a card changes Values: [, ] |
|
webhook |
string
|
webhook |
|
board_id |
integer(int32)
|
The id of the Board that the card belongs to |