query? API Documentation

[Martyn Houghton]

The api.hornbill.com link sends you to the new Documentation Site for the API details, but this does not appear to be complete. Is it possible to still reach the original documentation site for the API whilst the content is completed?

Cheers

Martyn

 

[Steve Giller]

If I can refer you to Gerry's response On another thread for a complete answer:

The short answer is that if it's not on the Hornbill Documents site then it is not intended for public use.

[Martyn Houghton]

@Steve Giller

Ok, so from what I can see you cannot search for a request, for example retrieving a request by the External Reference number so you can then pass the Request Id to get its status?

Seems quite a basic requirement to me.

Cheers

Martyn

[Gerry]

@Martyn Houghton

Can I ask, what API's are you currently using to achieve that?

The requirement is perfectly reasonable, however, for us to implement that in a way that is supportable that would require some speciific behaviour.  For example, many of our customers now have +millions of request records, so, if your external reference number was just stored into a custom field, where there is no index, then it would be a very poor performing API call as it would have to do a full table scan to find a record.  

So if this is a requirement we should provide you with the ability to do this via an API, but, in this case, we would probably want to be adding a dedicated field (if one does not already exist) and ensure that its correctly indexed in order to support such an API.  This is really the point.  The general query API's will let you do pretty much anything, but given our database schema, and general query APIs (like the search API) will and need to change as we improve things, we cannot be continuously locked into API's of the day, as we have been when exposing these. 

I would be interested to know which API's you are currently using to achieve this.  It certainly sounds like something we should be able to correctly accommodate for. 

Gerry
 

[Martyn Houghton]

@Gerry

At the moment we use API's to create requests only. This requirement is to be able to retrieve an existing request and update it based on a change in an external system. Given the key to all the current 'end-user' api's is the request id, you would only know this if you logged the request via the api in the first place and then rettain this in the external system.

Appreciate the need to optimise and engineer the request to be efficient both in resources and response time.

From our current use case, we would be able to limit the search via Request Type and Service id(s) as mandatory criteria, plus the date logged/closed, status and sub-status as optional parameters. This is related to us wanting to import and keep in sync Change Requests for Projects being managed in Salesforce.

Cheers

Martyn

 

[Gerry]

@Martyn Houghton

Thanks for the clarification.  So by the sounds of it a Requests::lookupRequestIdByExternalId() API would get you what you need?  It would look for the request where "h_external_ref_number" matches the external reference, and would return the Request ID?

Gerry

[Martyn Houghton]

@Gerry

That would work and if the list of Service ID(s) is mandatory this would limit the resources needed to execute the search by narrowing the search surface by the foreign key of the Service ID which I presume would be indexed already on the request table.

Cheers

Martyn