Table of Contents
Read methods
Method / Path: | GET /rebuild/states.json |
---|---|
Description: | Returns the index rebuild servicerepopulation states |
Path params: | NONE |
Optional (query) params: | NONE |
Response formats: | application/json |
Status codes: | 200: OK, Returns the repopulation states of the index rebuild services |
Notes: |
|
Testing: |
Sample:
/rebuild/states.json
/index/rebuild/states.json
|
Write methods
Method / Path: | POST /clear |
---|---|
Description: | Clear the index |
Path params: | NONE |
Optional (form) params: | NONE |
Status codes: |
200: OK, Index is cleared 500: Internal Server Error, Unable to clear index |
Notes: |
|
Testing: |
Sample:
/clear
Testing form (click to reveal)
|
Method / Path: | POST /rebuild/{service} |
---|---|
Description: | Repopulates the Index from an specific service |
Path params: | service: The service to recreate index from. The available services are: Themes, Series, Scheduler, AssetManager, Comments, Workflow and Search. The service order (see above) is very important except for Search! Make sure, you do not run index rebuildfor more than one service at a time! |
Optional (form) params: | NONE |
Status codes: | 200: OK, OK if repopulation has started |
Notes: |
|
Testing: |
Sample:
/rebuild/{service}
Testing form (click to reveal)
|
Method / Path: | POST /rebuild |
---|---|
Description: | Clear and repopulates the Index directly from the Services |
Path params: | NONE |
Optional (form) params: | NONE |
Status codes: | 200: OK, OK if repopulation has started |
Notes: |
|
Testing: |
Sample:
/rebuild
Testing form (click to reveal)
|
Method / Path: | POST /resume/{service} |
---|---|
Description: | Starts repopulating the Index from an specific service and will then continue with the rest of the services that come afterwards |
Path params: | service: The service to start recreating the index from. The available services are: Themes, Series, Scheduler, AssetManager, Comments and Workflow. All services that come after the specified service in the order above will also run. |
Optional (form) params: | NONE |
Status codes: | 200: OK, OK if repopulation has started |
Notes: |
|
Testing: |
Sample:
/resume/{service}
Testing form (click to reveal)
|