Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
P Portal-api
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • doc
  • Portal-api
  • Wiki
  • App API

App API · Changes

Page history
Added list request authored Apr 29, 2022 by Jurjen Brouwer's avatar Jurjen Brouwer
Show whitespace changes
Inline Side-by-side
Showing with 17 additions and 1 deletion
+17 -1
  • App-API.md App-API.md +17 -1
  • No files found.
App-API.md
View page @ d44452df
......@@ -108,9 +108,25 @@ https://portal.robotsindeklas.nl/API/v1/app/link
Parameters:
- **app** - *string*: the object id of the app we want to link;
- **send** - *array\<string\>*: list of robot ids we want to link this app with; // TODO why list?
- **rid** - *string*: the robot id we want to link this app with;
- **link** - *boolean*: link (true) or de-link (false).
### List
Get a list of apps the user has access to.
```
https://portal.robotsindeklas.nl/API/v1/app/link
```
Parameters:
- **filter** - *dictionary*: a dictionary containing the following keys to further define the search parameters:
- **search** - *string* - (optional, default: ""): search in the description and the name for a specific keyword;
- **sort** - *string* - (optional, default: ""): sort the result based on `name` (the name of the app), `edit` (last edit date) or `create` (creation date);
- **owner** - *string* - (optional, default: "user"): o `user` `shared`
- **folder** - *string* - (optional, default: ""): only search through a specific folder using the id of the folder;
- **limit** - *integer* - (optional, default: 0): limit the number of returned results;
- **row** - *integer* - (optional, default: 0): if a limit is applied, scroll through the results with defining the starting row.
## Response
If the request was successful, you will receive the following response:
......
Clone repository
  • App API
  • Folder API
  • Group API
  • Robot API
  • User API
  • Home