GET applications - ocariot/api-gateway GitHub Wiki

Description

Returns a list with applications.

Permissions:

• Only Admin user can list information of all applications.

Scope

applications:readAll

URL

GET https://localhost/v1/applications

Curl example

curl -X GET "https://localhost/v1/applications" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 200 Successful requisition.

  [
    {
      "id": "5db32930bec1431c51ae15fb",
      "username": "APPBR01",
      "institution_id": "5a62be07de34500146d9c624",
      "application_name": "Raspberry Pi 3 Model B+"
    }
  ]
  

• 401 Unauthorized Error

• 403 Permission Error

• 429 Too Many Requests Error

• 500 Internal Server Error

Query Strings (Optional)

Query strings are used as follows: there must be a question mark following the URL and providing the parameters for the desired operations. There are four possible operations: filtering, paging, limiting, and sorting.

• Filtering

  https://localhost/v1/applications?username=*BR*

• Pagination

  https://localhost/v1/applications?page=1

• Limitation

  https://localhost/v1/applications?limit=10

• Sorting

  https://localhost/v1/applications?sort=username

All parameters can also be used together concatenated by the & character as follows:

https://localhost/v1/applications?username=*BR*&sort=username&page=1&limit=10

For more details about using Query Strings click here.