Overview
The GitHub connector for Bizagi is available for download at Bizagi Connectors Xchange.
Through this connector, youcan connect your Bizagi processes to your GitHub account and services.
For more information about this connector's capabilities, visit Bizagi Connectors Xchange.
|
This Connector was developed according to the contents of the API and the information about it provided by GitHub. Bizagi and its subsidiaries will not provide any kind of guarantee over the content or error caused by calling the API services. Bizagi and its subsidiaries are not responsible for any loss, cost or damage consequence of the calls to GitHub's API. |
Before you start
To test and use this connector, you need:
1.Bizagi Studio installed.
2.This connector installed, via the Connectors Xchange as described at https://help.bizagi.com/platform/en/index.html?Connectors_Xchange.htm, or through a manual installation as described at https://help.bizagi.com/platform/en/index.html?connectors_setup.htm.
3.An account at https://github.com/.
4.An access token
Obtain your access token
Follow this steps to obtain your access token
1.Go to https://github.com/settings/developers and log in.
2.Go to the Personal access tokens tab.
3.Click Generate new token.
4.Name your token.
5.Select at least these permissions for your token and click Generate token.
6.Copy your access token and save it in a secure location.
Configuring the connector
To configure the connector (in particular its authentication parameters), follow the steps presented at the Configuration chapter in https://help.bizagi.com/platform/en/index.html?connectors_setup.htm.
For this configuration, consider the following authentication parameters:
•Authentication method: Custom
•TOKEN: Token obtained in the previous step.
•OWNER: Optional - User name of the default owner. This value will be used in all the activities that require a owner unless other owner is specified.
•REPO: Optional - Name of the default repository. This value will be used in all the activities that require a repository unless other owner is specified.
•ORG: Optional - Name of the default organization. This value will be used in all the activities that require an organization unless other organization is specified.
Using the connector
This connector features a set of methods to help you take advantage of the capabilites ofGitHub's API services.
To learn overall how/where to configure the use of a connector, refer to https://help.bizagi.com/platform/en/index.html?Connectors_Studio.htm.
When using the connector, keep in mind the following details for the available method.
Add assignees to an issue
This action lets you add assignees to an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
• assignees (Required): user name of the users assigned to the issue. It will not replace the currently assigned user. If an assignee on the list doesn't exist, the action will ignore it without throwing an error.. This parameter should be an array of strings in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue.
Check assignee
This action lets you check if an user can be assigned to a repository.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• assignee (Required): user name of the user you want to check. It is case-sensitive.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/assignees/#check-assignee.
Create a comment
This action lets you create a comment.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
• body (Required): content of the comment.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/comments/#create-a-comment.
Create an issue
This action lets you create an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• title (Required): title of the issue.. This parameter should be a String in your Bizagi model.
• body : description of the issue.. This parameter should be a String in your Bizagi model.
• labels : labels asociated with this issue. Only users with push access can assign new labels. If a user without this access tries to add a label, the action deletes all the labels without throwing an error.. This parameter should be an array of strings in your Bizagi model.
• assignees : users to whom the issue will be assigned. Only users with push access can assign new users. If a user without this access tries to add a new user, the action deletes all the assignees without throwing an error.. This parameter should be an array of strings in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#create-an-issue.
Delete a comment
This action lets you delete a comment.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• comment_id (Required): ID of the comment.. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/comments/#delete-a-comment.
Edit a comment
This action lets you edit a comment.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• comment_id (Required): ID of the comment.. This parameter should be a number in your Bizagi model.
• body (Required): content of the comment.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/comments/#edit-a-comment.
Edit an issue
This action lets you edit an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
• title (Required): title of the issue.. This parameter should be a String in your Bizagi model.
• body : description of the issue.. This parameter should be a String in your Bizagi model.
• state : the new status of the issue. Possible values: "open", "closed". If no value is provided the default value "open" is used.. This parameter should be a String in your Bizagi model.
• labels : new labels to be asociated with this issue. If no labels are provided, the existing ones are deleted.. This parameter should be an array of strings in your Bizagi model.
• assignees : new users to whom the issue will be assigned. Only users with push access can assign new users. If a user without this access tries to add a new user, the action deletes the assignees without throwing an error. If no users are provided, the existing ones are deleted.. This parameter should be an array of strings in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#edit-an-issue.
Get a single comment
This action lets you get a single comment.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• comment_id (Required): ID of the comment.. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/comments/#get-a-single-comment.
Get a single issue
This action lets you a single issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#get-a-single-issue.
List all issues
This action lets you get multiple issues.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• org : show only issues of the organization provided in this fielda. If no user is provided the global variable ORG is used. If this value is empty this field is ignored.. This parameter should be a String in your Bizagi model.
• filter : a filter used to reduce the amount of issues returned. The possible values are: "assigned" (only issues assigned to the authenticated user), "created" (issues created by the authenticated user), "mentioned" (issues where the authenticated user is mentioned), "subscribed" (issues where the authenticated user is subscribed), "all" (all the issues the user can see). If no filter is provided the default value "assigned" is used.. This parameter should be a String in your Bizagi model.
• state : shows the status of the issue. The possible values are "open", "closed", "all". If no value is provided the default value "open" is used.. This parameter should be a String in your Bizagi model.
• labels : labels used to filter the issues.. This parameter should be an array of strings in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#list-issues.
List all labels in a repository
This action lets you get all labels in a repository.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository.
List assignees
This action lets you get all the assigees.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/assignees/#list-assignees.
List comments in a repository
This action lets you get all the comments in a repository.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository.
List comments on an issue
This action lets you get all the comments in an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue.
List issues for a repository
This action lets you get multiple issues in a repository.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• state : shows the status of the issue. The possible values are "open", "closed", "all". If no value is provided the default value "open" is used.. This parameter should be a String in your Bizagi model.
• labels : labels used to filter the issues.. This parameter should be an array of strings in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#list-issues-for-a-repository.
List releases for a repository
This action lets you get all the releases in a repository.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository.
Lock an issue
This action lets you lock an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#lock-an-issue.
Remove assignees from an issue
This action lets you remove all the assignees of an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
• assignees (Required): username of the users that will be deleted from the issue. No error is thrown if the users are not assigned to the issue.. This parameter should be an array of strings in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue.
Unlock an issue
This action lets you unlock an issue.
To configure its inputs, take into account the following descriptions:
• owner (Required): owner of the repository (GitHub user name). If no user is provided the global variable OWNER is used.. This parameter should be a String in your Bizagi model.
• repo (Required): name of the repository. If no repository is provided the global variable REPO is used.. This parameter should be a String in your Bizagi model.
• issue_number (Required): number of the issue.. This parameter should be a number in your Bizagi model.
To configure the outputs of this action, you can map the output object to the corresponding entity in Bizagi. Make sure you map the attributes of the entity appropriately.
For more information about using this method, refer to GitHub's official documentation at https://developer.github.com/v3/issues/#unlock-an-issue.
Last Updated 10/27/2022 10:49:24 AM