ServiceControl API Documentation

[Jesse Inskeep]

So I've been poking around at the ServiceControl API and was wondering if documentation has been developed.

I wrote a little script to grab a batch of error messages (from resource /errors ), make a PATCH call to the resource of /errors/archive with a json payload that contains all the ids. (I reverse engineered ServicePulse to see how the archive button worked.....)

After doing all this I receive a 200 and 202 back from the server, but when I got to ServicePulse, none of the messages have been archived.

I know that the service control API is "technology-preview feature" (http://docs.particular.net/servicecontrol/capacity-and-planning) but was wondering if there was any type of even unofficial documentation on it so I can do some tactical scripts to help manage our failed messages.

I'm also working on a dashboard that will pull in the error message count from all of our servers (8 right now) which then provides a link to each server's version of ServicePulse. Basically, a dashboard of dashboards.

[Adam Schentag]

There's this:

http://andreasohlund.net/2013/06/17/accessing-audit-and-error-messages-in-nservicebus-v4-0/

You can also get some info from the API itself. GET http://localhost:33333/api returned this:

{

"description": "",

"endpoints_error_url": "http://localhost:33333/api/endpoints/{name}/errors/{?page,per_page,direction,sort}",

"endpoints_message_search_url": "http://localhost:33333/api/endpoints/{name}/messages/search/{keyword}/{?page,per_page,direction,sort}",

"endpoints_messages_url": "http://localhost:33333/api/endpoints/{name}/messages/{?page,per_page,direction,sort}",

"endpoints_url": "http://localhost:33333/api/endpoints",

"errors_url": "http://localhost:33333/api/errors/{?page,per_page,direction,sort}",

"instance_info": "http://localhost:33333/api/instance-info",

"message_search_url": "http://localhost:33333/api/messages/search/{keyword}/{?page,per_page,direction,sort}",

"license_status": "invalid",

"name": "",

"sagas_url": "http://localhost:33333/api/sagas"

[John Simons]

Hi Jesse,

What does you payload look like?

It should look like a json array, eg:

[ 'id1', 'id2', 'id3' ]

Is this what you sending?

Also the ids, make sure you are using the "id" field that is returned from  /errors.

Does this help?

Cheers

John

[Jesse Inskeep]

So it looks like the problem was on my side....

I was pulling a batch of events from "/errors" resource, which was pulling errors that were not necessarily "unresolved". So my script was passing in a batch of Ids to be marked as "resolved", it's just that I was passing in ids for events that had already been resolved.

I changed the URL to "/errors?status=unresolved" (or something similar, I don't have my code in front of me right now), which would then return only unresolved errors. I then looped through these and passed the list of ids into the "/errors/resolve" with a patch and everything started working just fine.

So first off... It was totally my fault. :)

But secondly, I was really only able to find this by running Fiddler and snooping through the network traffic that ServicePulse was sending to ServiceControl as well as searching through the source code on ServiceControl in GitHub. If this had some documentation around it with how to query the different resources or how to send in PATCH commands it would be a little easier.

Again, I'm making an assumption that there will be some documentation on this in the future, I'm just being impatient and want it now. :)

-Jesse