diff --git a/items.md b/items.md index 7fe5de6..aee4408 100644 --- a/items.md +++ b/items.md @@ -605,3 +605,14 @@ Return codes: * 401 Unauthorized - if you are not authenticated * 403 Forbidden - if you are not logged in with sufficient permissions * 404 Not found - if the item doesn't exist (or was already deleted) + +### findByCustomURL + +**GET /api/core/items/search/findByCustomURL?q=<:custom-url>** + +Search an item by the provided custom url. If the provided url is an UUID, a find by item's uuid is performed. The response has the same format of the find by uuid. + +Return codes: +* 200 OK - if the operation succeed +* 404 Not found - if no item was found with the given custom URL +* 500 Internal server error - if multiple item was found related to the given url \ No newline at end of file