Rest API's

Not Yet Reviewed

Where can i find the documentation of all the available Rest API's for the xMatters.
What i am intending to accomplish: Send a Page/Cell Phone message using a Rest API. Need the exact Rest URL to perform this action.
Version: 5.5.63(r80218)

0

Comments

8 comments
Date Votes

Please sign in to leave a comment.

  • Jose,
    The RESTS API is documented in the online help. Simply click on the Question Mark in the UI. It is also self-documenting - go to any of your forms, provision it as a web service, and the system will provide you with the exact URL and a sample CURL command.

    0
  • I dint find the exact resource url for the intent i was looking for

    0
  • Sorry, are you saying you couldn't find the REST API Appendix in the help, or you can't find where to provision a form as a web service

    0
  • Thanks Doug I found it. I am running into another problem. I am trying to post a trigger to a 'form' and i get the following error. Any suggestions on what could i be possibly doing wrong
    {
    "type": "INTERNALSERVERERROR",
    "message": "An internal server error has occurred."
    }

    0
  • Jose, that is a strange error. Can you share the payload you are sending over?

    0
  • <Fault xmlns="https://xxx.hosted.xmatters.com/reapi/2015-01-01/forms/6dbff414-032a-4ede-ac73-38ae881057a2/triggers">
    <message>An internal server error has occurred.</message>
    <type>INTERNAL_SERVER_ERROR</type>
    </Fault>


    curl -1 -H "Content-Type: application/json" --user USERNAME -X POST -d '
    {
    "properties": {},
    "recipients": [
    {
    "targetName": "efg"
    },
    {
    "targetName": "abc"
    }
    ]
    }
    ' "https://xxx.hosted.xmatters.com/reapi/2015-01-01/forms/6dbff414-032a-4ede-ac73-38ae881057a2/triggers

    0
  • Hmm, that looks fine. I was concerned about the empty "properties" element, but I tested that and I can submit your payload to one of my rest endpoints just fine. I'm guessing it is something happening on the backside. Can you open a ticket with support so we can investigate any errors in the web server?

    0
  • We've updated the location of the REST API documentation, so please check it out at  http://help.xmatters.com/xmAPI/ 

    0

Didn't find what you were looking for?

New post