The Rebuild Service is available via REST services. All services are located under the following URL: projectdoc-internal/1/rebuilder/
Administrator privileges are required to run these services. This is an internal API for the projectdoc Toolbox and subject to change without notice. | Section |
|---|
| The rebuilder services provide a REST interface to the services. The same services are used by the administration UI, but the REST interface provides more options. The services answer always with a 202. This indicates that the request has been accepted for processing, but the processing has not been completed. The body contains links to the long running tasks that have been started. All services support POST. | Service | Description |
|---|
site | Rebuild projectdoc documents infrastructure for the whole site. Parameters mode - Controls the mode in which the rebuilder is executed. Supported modes are upgrade, update, rebuild, refresh, revalidate, repair, and repopulate.name - The optional name of the task to allow users to identify this instance easily. Must not be longer than 32 characters. The user is responsible to select a name that is appropriately unique.
| projectdoc-spaces | Rebuild projectdoc documents infrastructure for spaces with at least one projectdoc document. All other spaces are skipped. Parameters mode - Controls the mode in which the rebuilder is executed. Supported modes are upgrade, update, rebuild, refresh, revalidate, repair, and repopulate.name - The optional name of the task to allow users to identify this instance easily. Must not be longer than 32 characters. The user is responsible to select a name that is appropriately unique.
| spaces | Processes the projectdoc documents for the specified spaces. At least one space must be specified. Note that the order of the specified spaces keys takes only a minor significance: space keys are processed first, then the sets determined by their space categories. If a strict order is requested, please run this service for each set separately. Note that exclusions are removed from the set of space keys calculated. Therefore a space explicitly specified is removed if its space category matches with one that is excluded. Parameters space-keys - The keys of the spaces to rebuild. Space categories are allowed (#, for instance #project) and spaced may be excluded (!, for instance !#project).mode - Controls the mode in which the rebuilder is executed. Supported modes are upgrade, update, rebuild, refresh, revalidate, repair, and repopulate.name - The optional name of the task to allow users to identify this instance easily. Must not be longer than 32 characters. The user is responsible to select a name that is appropriately unique.
|
|
| Section |
|---|
| The following services allow to access lists of documents or analyze spaces. Information retrieved from these services support use cases with the rebuilder services where a defined set of pages or spaces should be processed. All services support GET. | Service | Description |
|---|
space-key-list | Allows to fetch the list of space keys to traverse for a rebuild. Only spaces that are part of the provided list are processed. It won't add | Static Document Link |
|---|
| document | PDAC:Delegate Space |
|---|
| label | delegate spaces |
|---|
|
. Typically this parameter is not provided and then will return the order based on all spaces in the site. Parameters space-keys - The keys of the spaces to traverse. If not specified or empty then all spaces of the site are traversed (this is the main use case). Space categories are allowed (#, for instance #project) and spaced may be excluded (!, for instance !#project).- verbose - The flag allows to print the space order descriptor (
true) instead of the space key (false, default).
| document-id-list | Allows to fetch the list of document identifiers to traverse for a rebuild. Parameters mode - The mode in which the traversal should take place. The following modes are valid:hierarchy (default): traverse the Confluence page hierarchy.ao-hierarchy: Traverse the pages found in the projectdoc document table, ordered by level.ao-spaced: Traverse the pages found in the projectdoc document table, ordered by level within spaces.upgrade4-5: Traverse the pages found according to the upgrade from version 4 to version 5.
space-keys - The keys of the spaces to traverse. If not specified or empty then all spaces of the site are traversed. Space categories are allowed (#, for instance #project) and spaced may be excluded (!, for instance !#project).verbose - If set to true then not only the page identifiers are written, but also the space key and title of the pages. If not specified or false (default), then only the page identifiers are rendered. Each page is always on a new line.
| taskId | Allows to find the task identifier to check the current status of the rebuilder task. Only one task must execute at any given time. The returned task may already have been completed. Clients need to check the status separately with the Long Running Task API. This service returns the URL to the long running task if there is one. Otherwise the HTTP status code of the response is 404. Parameters name - The optional name of the task to check its current status. Must not be longer than 32 characters. If not specified, the current task is returned regardless of its name.
| test-space-specification | Allows to test the resolution of a space specification. This service may be used to select the space keys to pass to one of the rebuilder services explicitly. Parameters space-keys - The keys of the spaces for the test. Space categories are allowed (#, for instance #project) and spaced may be excluded (!, for instance !#project).
|
|
Use the | Static Document Link |
|---|
| document | Atlassian REST API Browser |
|---|
|
to access the documentation for these services.| Deprecated Box |
|---|
| title | Indexer Service is deprecated |
|---|
| The old Indexer Service of version 4 is still available (see | Static Document Link |
|---|
| document | Troubleshooting Reindexer for projectdoc Documents |
|---|
|
, but considered deprecated. |
|
