Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The status resource allows you to view the status of the indexing service. You can view the number of users, groups, and search items in both the database (store) and the index. If the database and index do not match, indexing is either in progress or there is a problem with the index. It is recommended that you reindex to correct any issues. If indexing is in progress, you can monitor the status by refreshing the page.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the status resource:
https://organization.example.com/<context>/admin/system/indexer/status?f=pjsonJSON Response examples
The following response is returned while indexing is in progress (when reindexing is true). When reindexing is true, any other attempts to run the reindex operation will be blocked and will result in a 500 error.
{
"indexes": [
{
"databaseCount": 4,
"indexCount": 4,
"name": "users"
},
{
"databaseCount": 15,
"indexCount": 0,
"name": "groups"
},
{
"databaseCount": 650,
"indexCount": 650,
"name": "items"
}
],
"reindexingInProgress": true,
"syncStatus": false
}The following sample response is returned when indexing is complete. If the values for all stores are matching after reindexing, the sync property will return as true, otherwise it returns as false.
{
"indexes": [
{
"databaseCount": 4,
"indexCount": 4,
"name": "users"
},
{
"databaseCount": 15,
"indexCount": 15,
"name": "groups"
},
{
"databaseCount": 650,
"indexCount": 650,
"name": "items"
}
],
"reindexingInProgress": false,
"syncStatus": true
}