HP ALM/QC JIRA CLOUD JIRA ON-PREMISE ZENDESK GITHUB
This article shows how to request a customer monitor. With the customer monitor, you can check the status of your syncs with REST API calls.
In Exalate for HP ALM/QC, customer monitor is available after version 5.0.9.
How to request a customer monitor endpoint
To request a customer monitor endpoint create a ticket on our Service Desk.
In the ticket, please specify the instances you would like to set up the customer monitor for.
After your ticket is processed you will get:
A REST endpoint, for example:
https://jcloudnode.example.exalate.cloud/rest/issuehub/4.0/cmonitor
jcloudnode-example.exalate.cloudis the Exalate URL of your instance.- Credentials to access the endpoint.
An endpoint will return a number of errors, that you can check with the numErrors parameter.
{"numErrors":0}
You can also use REST calls to check the entity sync and the attachment sync status.
REST calls
These REST calls are valid starting from Exalate 4.0 and higher.
GET /rest/issuehub/2.4/relations/{relationName}/syncevents/syncrequests
Used to know if there were any sync requests ready to be received.
Request example
GET http://localhost:2990/jira/rest/issuehub/2.4/relations/AllContent/syncevents/syncrequests
Requires the client to authenticate to the NODE via JWT token.
Response
STATUS 200 - application/json Returned if the message has been successfully received.
[
{
"syncEventId": 4,
"syncEventNumber": 1,
"relationKey": "AllContent",
"replica": {
"issueKey": {
"id": 11703,
"urn": "AC-102"
},
"summary": "AllContentPairAndSyncWiredTest update #1",
"encodedPayload": "{"version":{"major":1,"minor":4,"patch":0},"hubIssue":{"key":"AC-108","summary":"AllContentPairAndSyncWiredTest","description":"AllContentPairAndSyncWiredTest description","project":{"id":10300,"key":"AC","name":"All content","lead":{"key":"admin","active":true,"email":"admin@example.com","displayName":"admin","username":"admin"},"versions":[{"id":10000,"name":"1.0","description":"The initial release","archived":false,"released":true,"releaseDate":1435881600000,"startDate":1435708800000,"projectKey":"AC"},{"id":10001,"name":"1.1","description":"The bug fix release","archived":false,"released":false,"startDate":1436140800000,"projectKey":"AC"},{"id":10002,"name":"2.0","description":"The new feature release","archived":false,"released":false,"projectKey":"AC"}],"components":[{"id":10102,"description":"admin","name":"Test Component","projectId":10300,"projectKey":"AC","assigneeType":"PROJECT_DEFAULT"}]},"components":[{"id":10102,"description":"admin","name":"Test Component","projectId":10300,"projectKey":"AC","assigneeType":"PROJECT_DEFAULT"}],"customKeys":{},"customFields":{"Customer Request Type":{"id":10300,"name":"Customer Request Type","description":"Holds information about which Service Desk was used to create a ticket. This custom field is created programmatically and must not be modified.","type":"VP_ORIGIN"},"Request participants":{"id":10301,"name":"Request participants","description":"Stores the users that are participants in Service Desk customer portal requests. This custom field is created programmatically and required by Service Desk.","type":"USERS","value":[]},"Gender":{"id":10004,"name":"Gender","type":"OPTION","value":{"id":10005,"sequence":0,"value":"Male","disabled":false,"childOptions":[]}},"Birthdate":{"id":10006,"name":"Birthdate","type":"DATE"},"Studies":{"id":10005,"name":"Studies","type":"OPTIONS","value":[{"id":10007,"sequence":0,"value":"University","disabled":false,"childOptions":[]},{"id":10008,"sequence":1,"value":"Secondary","disabled":false,"childOptions":[]}]},"Mood":{"id":10200,"name":"Mood","type":"STRING"},"Time to resolution":{"id":10302,"name":"Time to resolution","description":"This custom field was created by JIRA Service Desk.","type":"SD_SLA_FIELD"},"Remarks":{"id":10002,"name":"Remarks","type":"TEXT"},"Remote Project Detail":{"id":10100,"name":"Remote Project Detail","description":"Has all details of the remote project","type":"TEXT"},"Hobby":{"id":10003,"name":"Hobby","type":"OPTIONS","value":[]},"10000":{"id":10000,"name":"Location","type":"STRING","value":"Brussels"},"10200":{"id":10200,"name":"Mood","type":"STRING"},"10002":{"id":10002,"name":"Remarks","type":"TEXT"},"10001":{"id":10001,"name":"Age","type":"NUMERIC","value":22.0},"10100":{"id":10100,"name":"Remote Project Detail","description":"Has all details of the remote project","type":"TEXT"},"10004":{"id":10004,"name":"Gender","type":"OPTION","value":{"id":10005,"sequence":0,"value":"Male","disabled":false,"childOptions":[]}},"10301":{"id":10301,"name":"Request participants","description":"Stores the users that are participants in Service Desk customer portal requests. This custom field is created programmatically and required by Service Desk.","type":"USERS","value":[]},"10300":{"id":10300,"name":"Customer Request Type","description":"Holds information about which Service Desk was used to create a ticket. This custom field is created programmatically and must not be modified.","type":"VP_ORIGIN"},"10003":{"id":10003,"name":"Hobby","type":"OPTIONS","value":[]},"Age":{"id":10001,"name":"Age","type":"NUMERIC","value":22.0},"10006":{"id":10006,"name":"Birthdate","type":"DATE"},"Location":{"id":10000,"name":"Location","type":"STRING","value":"Brussels"},"10005":{"id":10005,"name":"Studies","type":"OPTIONS","value":[{"id":10007,"sequence":0,"value":"University","disabled":false,"childOptions":[]},{"id":10008,"sequence":1,"value":"Secondary","disabled":false,"childOptions":[]}]},"10302":{"id":10302,"name":"Time to resolution","description":"This custom field was created by JIRA Service Desk.","type":"SD_SLA_FIELD"}},"labels":[{"label":"Review"}],"affectedVersions":[{"id":10000,"name":"1.0","description":"The initial release","archived":false,"released":true,"releaseDate":1435881600000,"startDate":1435708800000,"projectKey":"AC"},{"id":10001,"name":"1.1","description":"The bug fix release","archived":false,"released":false,"startDate":1436140800000,"projectKey":"AC"}],"fixVersions":[{"id":10001,"name":"1.1","description":"The bug fix release","archived":false,"released":false,"startDate":1436140800000,"projectKey":"AC"},{"id":10002,"name":"2.0","description":"The new feature release","archived":false,"released":false,"projectKey":"AC"}],"workLogs":[{"id":10101,"author":{"key":"issuehub","active":true,"email":"issuehub@example.com","displayName":"issuehub","username":"issuehub"},"updateAuthor":{"key":"issuehub","active":true,"email":"issuehub@example.com","displayName":"issuehub","username":"issuehub"},"startDate":1454678257807,"timeSpent":36000,"comment":"I\u0027ve been working for too long.","created":1454678262562,"updated":1454678262562}],"assignee":{"key":"developer","active":true,"email":"developer@example.com","displayName":"Brad Pitt","username":"developer"},"reporter":{"key":"developer","active":true,"email":"developer@example.com","displayName":"Brad Pitt","username":"developer"},"attachments":[],"comments":[{"id":10817,"author":{"key":"issuehub","active":true,"email":"issuehub@example.com","displayName":"issuehub","username":"issuehub"},"updateAuthor":{"key":"issuehub","active":true,"email":"issuehub@example.com","displayName":"issuehub","username":"issuehub"},"body":"Houston, we have a problem.","created":1454678262522,"updated":1454678262522,"internal":false}],"status":{"id":"10001","name":"To Do","description":""},"issueType":{"id":"2","name":"New Feature","description":"A new feature of the product, which has yet to be developed."},"priority":{"id":"2","name":"Critical","description":"Crashes, loss of data, severe memory leak."},"votes":1,"watches":1,"environment":"AllContentPairAndSyncWiredTest environment","due":1451606400000,"voters":[{"key":"admin","active":true,"email":"admin@example.com","displayName":"admin","username":"admin"}],"watchers":[{"key":"issuehub","active":true,"email":"issuehub@example.com","displayName":"issuehub","username":"issuehub"},{"key":"admin","active":true,"email":"admin@example.com","displayName":"admin","username":"admin"}],"estimate":0,"spent":36000}}"
},
"traces": [
{
"type": "COMMENT",
"localId": "10816",
"remoteId": "10817",
"action": "NONE",
"toSynchronize": true
}
],
"blobMetadataList": []
}
]
STATUS 400 - plain/text Returned if connection was not found:
Connection `AllContent` not found. Seems like it was removed on the Destination side.
STATUS 401 - application/json Returned if the request is authenticated with incorrect credentials.STATUS 403 - application/json Returned if the request is not authenticated.STATUS 500 - application/json Returned if a bug situation is encountered.
GET /rest/issuehub/2.4/relations/{relationName}/syncevents/blobrequests
Used to know if there were any blob requests ready to be received.
Request example
GET http://localhost:2990/jira/rest/issuehub/2.4/relations/AllContent/syncevents/blobrequests
Requires the client to authenticate to the NODE via JWT token.
Responses
STATUS 200 - application/json Returned if the message has been successfully received.
[
{
"relationKey":"AllContent",
"syncEventId": 55,
"blobMetadata": {
"blobId": 10008,
"checksum": "90630d8f774de272400bdc9422b26d91"
}
}
]
STATUS 400 - plain/text Returned if the connection was not found:
Connection `AllContent` not found. Seems like it was removed on the Destination side.
STATUS 401 - application/json Returned if the request is authenticated with incorrect credentials.
STATUS 403 - application/json Returned if the request is not authenticated.
STATUS 500 - application/json Returned if a bug situation is encountered.
GET /rest/issuehub/2.4/relations/{relationName}/syncrequests/syncresponses
Used to know if there were any sync responses for the previously submitted sync requests.
Request example
GET http://localhost:2990/jira/rest/issuehub/2.4/relations/AllContent/syncrequests/syncresponses
Requires the client to authenticate to the NODE via JWT token
Response
STATUS 200 - application/json Returned if the message has been successfully received.
[
{
"syncEventId": 16,
"relationKey": "GROOVY",
"sourceIssueKey": {
"id": 11716,
"urn": "PAR-37"
},
"replica": {
"issueKey": {
"id": 11717,
"urn": "PAR-38"
},
"summary": "Exalated: BasicAttachmentWiredTest",
"encodedPayload": "eyJ2ZXJzaW9uIjp7Im1ham9yIjoxLCJtaW5vciI6NCwicGF0Y2giOjB9LCJodWJJc3N1ZSI6eyJzdW1tYXJ5IjoiRXhhbGF0ZWQ6IEJhc2ljQXR0YWNobWVudFdpcmVkVGVzdCIsImN1c3RvbUtleXMiOnt9LCJjdXN0b21GaWVsZHMiOnsiQ3VzdG9tZXIgUmVxdWVzdCBUeXBlIjp7ImlkIjoxMDMwMCwibmFtZSI6IkN1c3RvbWVyIFJlcXVlc3QgVHlwZSIsImRlc2NyaXB0aW9uIjoiSG9sZHMgaW5mb3JtYXRpb24gYWJvdXQgd2hpY2ggU2VydmljZSBEZXNrIHdhcyB1c2VkIHRvIGNyZWF0ZSBhIHRpY2tldC4gVGhpcyBjdXN0b20gZmllbGQgaXMgY3JlYXRlZCBwcm9ncmFtbWF0aWNhbGx5IGFuZCBtdXN0IG5vdCBiZSBtb2RpZmllZC4iLCJ0eXBlIjoiVlBfT1JJR0lOIn0sIlJlcXVlc3QgcGFydGljaXBhbnRzIjp7ImlkIjoxMDMwMSwibmFtZSI6IlJlcXVlc3QgcGFydGljaXBhbnRzIiwiZGVzY3JpcHRpb24iOiJTdG9yZXMgdGhlIHVzZXJzIHRoYXQgYXJlIHBhcnRpY2lwYW50cyBpbiBTZXJ2aWNlIERlc2sgY3VzdG9tZXIgcG9ydGFsIHJlcXVlc3RzLiBUaGlzIGN1c3RvbSBmaWVsZCBpcyBjcmVhdGVkIHByb2dyYW1tYXRpY2FsbHkgYW5kIHJlcXVpcmVkIGJ5IFNlcnZpY2UgRGVzay4iLCJ0eXBlIjoiVVNFUlMiLCJ2YWx1ZSI6W119LCJHZW5kZXIiOnsiaWQiOjEwMDA0LCJuYW1lIjoiR2VuZGVyIiwidHlwZSI6Ik9QVElPTiJ9LCJCaXJ0aGRhdGUiOnsiaWQiOjEwMDA2LCJuYW1lIjoiQmlydGhkYXRlIiwidHlwZSI6IkRBVEUifSwiU3R1ZGllcyI6eyJpZCI6MTAwMDUsIm5hbWUiOiJTdHVkaWVzIiwidHlwZSI6Ik9QVElPTlMiLCJ2YWx1ZSI6W119LCJNb29kIjp7ImlkIjoxMDIwMCwibmFtZSI6Ik1vb2QiLCJ0eXBlIjoiU1RSSU5HIn0sIlRpbWUgdG8gcmVzb2x1dGlvbiI6eyJpZCI6MTAzMDIsIm5hbWUiOiJUaW1lIHRvIHJlc29sdXRpb24iLCJkZXNjcmlwdGlvbiI6IlRoaXMgY3VzdG9tIGZpZWxkIHdhcyBjcmVhdGVkIGJ5IEpJUkEgU2VydmljZSBEZXNrLiIsInR5cGUiOiJTRF9TTEFfRklFTEQifSwiUmVtYXJrcyI6eyJpZCI6MTAwMDIsIm5hbWUiOiJSZW1hcmtzIiwidHlwZSI6IlRFWFQifSwiUmVtb3RlIFByb2plY3QgRGV0YWlsIjp7ImlkIjoxMDEwMCwibmFtZSI6IlJlbW90ZSBQcm9qZWN0IERldGFpbCIsImRlc2NyaXB0aW9uIjoiSGFzIGFsbCBkZXRhaWxzIG9mIHRoZSByZW1vdGUgcHJvamVjdCIsInR5cGUiOiJURVhUIn0sIkhvYmJ5Ijp7ImlkIjoxMDAwMywibmFtZSI6IkhvYmJ5IiwidHlwZSI6Ik9QVElPTlMiLCJ2YWx1ZSI6W119LCIxMDAwMCI6eyJpZCI6MTAwMDAsIm5hbWUiOiJMb2NhdGlvbiIsInR5cGUiOiJTVFJJTkcifSwiMTAyMDAiOnsiaWQiOjEwMjAwLCJuYW1lIjoiTW9vZCIsInR5cGUiOiJTVFJJTkcifSwiMTAwMDIiOnsiaWQiOjEwMDAyLCJuYW1lIjoiUmVtYXJrcyIsInR5cGUiOiJURVhUIn0sIjEwMDAxIjp7ImlkIjoxMDAwMSwibmFtZSI6IkFnZSIsInR5cGUiOiJOVU1FUklDIn0sIjEwMTAwIjp7ImlkIjoxMDEwMCwibmFtZSI6IlJlbW90ZSBQcm9qZWN0IERldGFpbCIsImRlc2NyaXB0aW9uIjoiSGFzIGFsbCBkZXRhaWxzIG9mIHRoZSByZW1vdGUgcHJvamVjdCIsInR5cGUiOiJURVhUIn0sIjEwMDA0Ijp7ImlkIjoxMDAwNCwibmFtZSI6IkdlbmRlciIsInR5cGUiOiJPUFRJT04ifSwiMTAzMDEiOnsiaWQiOjEwMzAxLCJuYW1lIjoiUmVxdWVzdCBwYXJ0aWNpcGFudHMiLCJkZXNjcmlwdGlvbiI6IlN0b3JlcyB0aGUgdXNlcnMgdGhhdCBhcmUgcGFydGljaXBhbnRzIGluIFNlcnZpY2UgRGVzayBjdXN0b21lciBwb3J0YWwgcmVxdWVzdHMuIFRoaXMgY3VzdG9tIGZpZWxkIGlzIGNyZWF0ZWQgcHJvZ3JhbW1hdGljYWxseSBhbmQgcmVxdWlyZWQgYnkgU2VydmljZSBEZXNrLiIsInR5cGUiOiJVU0VSUyIsInZhbHVlIjpbXX0sIjEwMzAwIjp7ImlkIjoxMDMwMCwibmFtZSI6IkN1c3RvbWVyIFJlcXVlc3QgVHlwZSIsImRlc2NyaXB0aW9uIjoiSG9sZHMgaW5mb3JtYXRpb24gYWJvdXQgd2hpY2ggU2VydmljZSBEZXNrIHdhcyB1c2VkIHRvIGNyZWF0ZSBhIHRpY2tldC4gVGhpcyBjdXN0b20gZmllbGQgaXMgY3JlYXRlZCBwcm9ncmFtbWF0aWNhbGx5IGFuZCBtdXN0IG5vdCBiZSBtb2RpZmllZC4iLCJ0eXBlIjoiVlBfT1JJR0lOIn0sIjEwMDAzIjp7ImlkIjoxMDAwMywibmFtZSI6IkhvYmJ5IiwidHlwZSI6Ik9QVElPTlMiLCJ2YWx1ZSI6W119LCJBZ2UiOnsiaWQiOjEwMDAxLCJuYW1lIjoiQWdlIiwidHlwZSI6Ik5VTUVSSUMifSwiMTAwMDYiOnsiaWQiOjEwMDA2LCJuYW1lIjoiQmlydGhkYXRlIiwidHlwZSI6IkRBVEUifSwiTG9jYXRpb24iOnsiaWQiOjEwMDAwLCJuYW1lIjoiTG9jYXRpb24iLCJ0eXBlIjoiU1RSSU5HIn0sIjEwMDA1Ijp7ImlkIjoxMDAwNSwibmFtZSI6IlN0dWRpZXMiLCJ0eXBlIjoiT1BUSU9OUyIsInZhbHVlIjpbXX0sIjEwMzAyIjp7ImlkIjoxMDMwMiwibmFtZSI6IlRpbWUgdG8gcmVzb2x1dGlvbiIsImRlc2NyaXB0aW9uIjoiVGhpcyBjdXN0b20gZmllbGQgd2FzIGNyZWF0ZWQgYnkgSklSQSBTZXJ2aWNlIERlc2suIiwidHlwZSI6IlNEX1NMQV9GSUVMRCJ9fSwiYXR0YWNobWVudHMiOlt7ImlkIjoxMDAwMiwibWltZXR5cGUiOiJpbWFnZS9wbmciLCJmaWxlbmFtZSI6IlRyaWFuZ2xlXzE2eDE2LnBuZyIsImNyZWF0ZWQiOjE0NTQ2NzgwMTA4MzIsImZpbGVzaXplIjo4ODgsImF1dGhvciI6eyJrZXkiOiJpc3N1ZWh1YiIsImFjdGl2ZSI6dHJ1ZSwiZW1haWwiOiJpc3N1ZWh1YkBleGFtcGxlLmNvbSIsImRpc3BsYXlOYW1lIjoiaXNzdWVodWIiLCJ1c2VybmFtZSI6Imlzc3VlaHViIn0sInRodW1ibmFpbGFibGUiOnRydWUsInppcCI6ZmFsc2V9XX19"
},
"traces": [
{
"type": "ATTACHMENT",
"localId": "10002",
"remoteId": "10001",
"action": "NONE",
"toSynchronize": true
}
]
}
]
STATUS 400 - plain/text Returned if connection was not found:
Connection `AllContent` not found. Seems like it was removed on the Destination side.
STATUS 401 - application/json Returned if the request is authenticated with incorrect credentials.STATUS 403 - application/json Returned if the request is not authenticated.STATUS 500 - application/json Returned if a bug situation is encountered.
GET /rest/issuehub/2.4/relations/{relationName}/syncrequests/blobresponses
Used to know if there were any blob responses for the previously submitted blob requests.
Request example
GET http://localhost:2990/jira/rest/issuehub/2.4/relations/AllContent/syncrequests/blobresponses
Requires the client to authenticate to the NODE via JWT token
Response
STATUS 200 - application/json Returned if the message has been successfully received.
[
{
"relationKey": "defaultrelation",
"syncEventId": 14,
"blobEventId": 100,
"blobMetadata": {
"blobId": 10000,
"checksum": "17a7c1aaf84aa7c551dd1e349f30c2c8"
}
}
]
STATUS 400 - plain/text Returned if connection was not found:
Connection `AllContent` not found. Seems like it was removed on the Destination side.
STATUS 401 - application/json Returned if the request is authenticated with incorrect credentials.STATUS 403 - application/json Returned if the request is not authenticated.STATUS 500 - application/json Returned if a bug situation is encountered.
GET /rest/issuehub/2.4/relations/{relationName}/syncrequests/errorresponses
Used to know if there were any failures to process sync requests for the previously submitted sync requests
Request example
Expand source
GET http://localhost:2990/jira/rest/issuehub/2.4/relations/AllContent/syncrequests/errorresponses
Requires the client to authenticate to the NODE via JWT token.
Response
STATUS 200 - application/json Returned if the message has been successfully received.
[
{
"syncEventId": 49,
"relationKey": "AllContent",
"sourceIssueKey": {
"id": 11742,
"urn": "AC-113"
},
"message": "Could not connect `AC-113` to `AC-111`: issue by key `AC-111` already was connected to another issue using relation `AllContent`",
"errorReason": "NO_ISSUE_TO_CONNECT_TO"
}
]
STATUS 400 - plain/text Returned if connection was not found:
Connection `AllContent` not found. Seems like it was removed on the Destination side.
STATUS 401 - application/json Returned if the request is authenticated with incorrect credentials.STATUS 403 - application/json Returned if the request is not authenticated.STATUS 500 - application/json Returned if a bug situation is encountered.
GET /rest/issuehub/2.4/relations/{relationName}/syncrequests/bloberrorresponses
Used to know if there were any failures to process attachment synchronizations for the previously submitted attachment synchronization requests
Request example
GET http://localhost:2990/jira/rest/issuehub/2.4/relations/AllContent/syncrequests/bloberrorresponses
Requires the client to authenticate to the NODE via JWT token
Response
STATUS 200 - application/json Returned if the message has been successfully received.
[
{
"relationKey": "defaultrelation",
"syncEventId": 14,
"blobEventId": 100,
"blobId": 10000,
"sourceIssueKey": {
"id": 11716,
"urn": "PAR-37"
},
"errorMessage": "Checksums for blob id '10000' do not match. Expected: 17a7c1aaf84aa7c551dd1e349f30c2c8 Was: 90630d8f774de272400bdc9422b26d91"
"blobErrorReason": "CHECKSUM_MISMATCH"
}
]
STATUS 400 - plain/text Returned if connection was not found:
Connection `AllContent` not found. Seems like it was removed on the Destination side.
STATUS 401 - application/json Returned if the request is authenticated with incorrect credentials.STATUS 403 - application/json Returned if the request is not authenticated.STATUS 500 - application/json Returned if a bug situation is encountered.
