ReST API

ConnectALL publishes a ReST API that allows external systems to interact with the product. This interface allows the mapped applications to PUSH record changes into ConnectALL for synchronization. For example, Jira can push its changes via Jira webhooks or workflow post function etc. The pushed changes will be placed into the internal queue for processing and synchronized to the destination asynchronously. An application link must be created with "Sync Type" as "PUSH" in Entity Mapping >> Advanced properties section and the sync will happen as per the mapping provided in the application link.

PUSH Service

ReST URL

http://<ConnectAllServer>:7070/SyncService/push

Method

POST

AuthenticationBasic   (Use ConnectALL-GUI admin credential. Default : admin/welcome) / API Key authentication

Accept

application/json

Content-Type

application/json

Body

{

                "appLinkName":"Jira6QC11Req",

                "origin":"source",

                "id":"QC-20"

}

Response Codes

201 – {"Response":"Success", "Message":"Record Jira6QC11Req\QC-20 successfully pushed into ConnectAll queue! "}

400 – Bad request or validation errors: Sample > {"Response":"Error", "Message":"<specific error message>"}

500 – Unable to process the request due to internal server.

appLinkName – Mapping name in ConnectAll

origin – “source” or “destination” which denotes the origin application pushes the change. Application configured on the left-hand side of the mapping is considered as "source" and application on right-hand side is considered as "destination"

The port 7070 specified in the ReST URL is the default port and it can be changed to any available port in MULE_HOME/conf/ConnectAll.properties file as shown below,


push.service.port=http://0.0.0.0:7070



Make sure the ReST API URL (and port) is accessible from the mapped applications.

PUSH Service (query string variant)

This variation takes source record inputs via the query string. This service allows Jira Webhooks to push issue changes to ConnectALL.

ReST URL

http://<ConnectAllServer>:7070/SyncService/push/<appLinkName>/<origin>/${issue.key}?apikey=<CA-api-key>

Method

POST

AuthenticationAPI key authentication - Use ConnectALL GUI to generate api key.

Accept

application/json

Content-Type

application/json

Body

NA

Response Codes

201 – {"Response":"Success", "Message":"Record Jira6QC11Req\QC-20 successfully pushed into ConnectAll queue! "}

400 – Bad request or validation errors: Sample > {"Response":"Error", "Message":"<specific error message>"}

500 – Unable to process the request due to internal server.


Refer to the WebHook section under the Jira adapter page to learn about WebHook configuration for PUSH service. For more details about Jira WebHook, please refer to Jira documentation.

MicroFocus ALM workflow configuration to push data to ConnectALL

Business Rules configuration in ServiceNow to push data to ConnectALL


PUSH Service for Multi-Project Functionality

This PUSH service allows the mapped applications to identify the project, against which the PUSH service has to be executed. 

ReST URL

http://<ConnectAllServer>:7070/SyncService/push

Method

POST

Authentication

Basic   (Use ConnectALL-GUI admin credential. Default : admin/welcome) / API Key authentication

Accept

application/json

Content-Type

application/json

Body

{

                "appLinkName":"Jira6QC11Req",

                “origin":"source",

                “project”:”QC”

                "id":"QC-20"

}

Response Codes

201 – {"Response":"Success", "Message":"Record Jira6QC11Req\QC-20 successfully pushed into ConnectAll queue! "}

400 – Bad request or validation errors: Sample > {"Response":"Error", "Message":"<specific error message>"}

500 – Unable to process the request due to internal server.


appLinkName – Mapped name in ConnectALL.

origin – “source” or “destination” which denotes the origin application that pushes the change. The application configured on the left-hand side of the mapping is considered as the "source" and the application on the right-hand side is considered as the “destination".

project – Project in the synchronizing record. This is required only for the multi-project app-links, and the app-links that need a project to login.

Apps that require the project attribute:

      • Microfocus ALM/Quality Centre
      • Perforce Helix ALM

PUSH Service for Multi-Project Functionality (query string variant)

This variation takes source record inputs via the query string. This service allows Jira Webhooks to push all the issue changes to ConnectALL.

ReST URL

http://<ConnectAllServer>:7070/SyncService/push/<appLinkName>/<origin>/<project>/${issue.key}?apikey=<CA-api-key>

Method

POST

Authentication

API key authentication - Use ConnectALL GUI to generate api key.

Accept

application/json

Content-Type

application/json

Body

NA

Response Codes

201 – {"Response":"Success", "Message":"Record Jira6QC11Req\QC-20 successfully pushed into ConnectAll queue! "}

400 – Bad request or validation errors: Sample > {"Response":"Error", "Message":"<specific error message>"}

500 – Unable to process the request due to internal server.