URL Endpoints for Review - Revision history

Dgreenwood: /* Additional endpoints */

2025-12-09T16:23:25Z

Additional endpoints

← Older revision		Revision as of 11:23, 9 December 2025
Line 111:		Line 111:

	All of the main Grooper pages accept an optional <code>repositoryId</code> prameter. Use this to create links to specific Grooper Repositories when a Grooper web server is connected to mulitple Grooper Repositories.		All of the main Grooper pages accept an optional <code>repositoryId</code> prameter. Use this to create links to specific Grooper Repositories when a Grooper web server is connected to mulitple Grooper Repositories.
	* Example: <code>https://{serverName}/Grooper/Search?repositoryId={repositoryId}</code>		* Example: <code><nowiki>https://{serverName}/Grooper/Search?repositoryId={repositoryId}</nowiki></code>
	* Example: <code>https://{serverName}/Grooper/Chat?repositoryId={repositoryId}</code>		* Example: <code><nowiki>https://{serverName}/Grooper/Chat?repositoryId={repositoryId}</nowiki></code>

Dgreenwood at 16:22, 9 December 2025

2025-12-09T16:22:45Z

← Older revision		Revision as of 11:22, 9 December 2025
Line 106:		Line 106:
	# Select the '''Grooper Root''' node.		# Select the '''Grooper Root''' node.
	# Under '''''Repository Info''''', copy the value in the '''''Repository ID''''' property.		# Under '''''Repository Info''''', copy the value in the '''''Repository ID''''' property.


			== Additional endpoints ==

			All of the main Grooper pages accept an optional <code>repositoryId</code> prameter. Use this to create links to specific Grooper Repositories when a Grooper web server is connected to mulitple Grooper Repositories.
			* Example: <code>https://{serverName}/Grooper/Search?repositoryId={repositoryId}</code>
			* Example: <code>https://{serverName}/Grooper/Chat?repositoryId={repositoryId}</code>

Randallkinard at 15:46, 22 November 2024

2024-11-22T15:46:01Z

← Older revision		Revision as of 10:46, 22 November 2024
Line 106:		Line 106:
	# Select the '''Grooper Root''' node.		# Select the '''Grooper Root''' node.
	# Under '''''Repository Info''''', copy the value in the '''''Repository ID''''' property.		# Under '''''Repository Info''''', copy the value in the '''''Repository ID''''' property.

	~~== Glossary ==~~
	~~<u><big>'''Batch Process'''</big></u>: {{#lst:Glossary\|Batch Process}}~~

	~~<u><big>'''Batch'''</big></u>: {{#lst:Glossary\|Batch}}~~

	~~<u><big>'''Grooper Repository'''</big></u>: {{#lst:Glossary\|Grooper Repository}}~~

	~~<u><big>'''Repository'''</big></u>: {{#lst:Glossary\|Repository}}~~

	~~<u><big>'''Review Queue'''</big></u>: {{#lst:Glossary\|Review Queue}}~~

	~~<u><big>'''Review'''</big></u>: {{#lst:Glossary\|Review}}~~

	~~<u><big>'''Web Client'''</big></u>: {{#lst:Glossary\|Web Client}}~~

Dgreenwood: /* The ReviewAll endpoint */

2024-09-04T16:01:46Z

The ReviewAll endpoint

Dgreenwood: /* The Scan endpoint */

2024-09-04T15:58:54Z

The Scan endpoint

← Older revision		Revision as of 10:58, 4 September 2024
Line 92:		Line 92:


	The following URL would create a new Batch, using the Batch Process named "Scanned Invoices" (<code>&processName=Scanned%20Invoices</code>), name it "Scan_Session_001" (<code>&batchName=Scan_Session_001</code>) and take the user to the Review step to start scanning:		The following URL would create a new Batch, using the Batch Process named "Scanned Invoices" (<code>&processName=Scanned%20Invoices</code>), name it "Scan_Session_001" (<code>&batchName=Scan_Session_001</code>) and take the user to the Review step to start scanning (in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000):
	:<pre style="width:100%">http://serverName/Grooper/Review/Scan?repositoryId=00000000-0000-0000-0000-000000000000&processName=Scanned%20Invoices&batchName=Scan_Session_001</pre>		:<pre style="width:100%">http://serverName/Grooper/Review/Scan?repositoryId=00000000-0000-0000-0000-000000000000&processName=Scanned%20Invoices&batchName=Scan_Session_001</pre>

Dgreenwood: /* The ReviewTask endpoint */

2024-09-04T15:58:30Z

The ReviewTask endpoint

← Older revision		Revision as of 10:58, 4 September 2024
Line 59:		Line 59:
	Use this endpoint to direct a user to a specific Review task.		Use this endpoint to direct a user to a specific Review task.
	* Please note this endpoint was created as a scaffold for custom scripts and potentially for future development. There is no way to know what a Review task's ID is before that task is created (when the Review step's Processing Job is created). This makes accessing this ID tricky using Grooper's current code base. Its practical use currently is limited as you must know the task ID to use it.		* Please note this endpoint was created as a scaffold for custom scripts and potentially for future development. There is no way to know what a Review task's ID is before that task is created (when the Review step's Processing Job is created). This makes accessing this ID tricky using Grooper's current code base. Its practical use currently is limited as you must know the task ID to use it.


	'''''Required Parameters:''' repositoryId (GUID), taskID (int)''		'''''Required Parameters:''' repositoryId (GUID), taskID (int)''

	You must pass the Grooper Repository ID and Review task's ID in the URL.		You must pass the Grooper Repository ID and Review task's ID in the URL.


	The following URL would take the user to a Review task whose ID is "1" in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.		The following URL would take the user to a Review task whose ID is "1" in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.
	:<pre style="width:100%">https://servername/Grooper/Review/ReviewTask?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1</pre>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewTask?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1</pre>


	'''''Optional Parameters:''' caller (string)''		'''''Optional Parameters:''' caller (string)''

	You may optionally pass a "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.		You may optionally pass a "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.


	The following URL would take the user back to the Tasks Page after the single task is completed.		The following URL would take the user back to the Tasks Page after the single task is completed.

Dgreenwood: /* The ReviewBatch endpoint */

2024-09-04T15:58:01Z

The ReviewBatch endpoint

← Older revision		Revision as of 10:58, 4 September 2024
Line 32:		Line 32:

	=== The ReviewBatch endpoint ===		=== The ReviewBatch endpoint ===
	<pre style="width:100%">https://{serverName}/Grooper/Review/ReviewBatch?repositoryId={repositoryId}&~~taskId~~={~~taskId~~}</pre>		<pre style="width:100%">https://{serverName}/Grooper/Review/ReviewBatch?repositoryId={repositoryId}&batchId={batchId}</pre>

	Use this endpoint to direct a user to Review tasks available for a specific '''Batch'''.		Use this endpoint to direct a user to Review tasks available for a specific '''Batch'''.


	'''''Required Parameters:''' repositoryId (GUID), batchID (GUID)''		'''''Required Parameters:''' repositoryId (GUID), batchID (GUID)''

	You must pass the Grooper Repository ID and The '''Batch''' ID in the URL.		You must pass the Grooper Repository ID and The '''Batch''' ID in the URL.


	The following URL would take the user to the first available task in a '''Batch''' whose ID is 00000000-0000-0000-0000-000000000000 in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.		The following URL would take the user to the first available task in a '''Batch''' whose ID is 00000000-0000-0000-0000-000000000000 in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.
	:<pre style="width:100%">https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000</pre>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000</pre>


	'''''Optional Parameters:''' caller (string)''		'''''Optional Parameters:''' caller (string)''

	You may optionally pass a "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.		You may optionally pass a "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.


	The following URL would take the user back to the Batches Page after all available Review tasks are completed for the '''Batch'''.		The following URL would take the user back to the Batches Page after all available Review tasks are completed for the '''Batch'''.

Dgreenwood: /* The ReviewTask endpoint */

2024-09-04T15:56:57Z

The ReviewTask endpoint

← Older revision		Revision as of 10:56, 4 September 2024
Line 51:		Line 51:

	=== The ReviewTask endpoint ===		=== The ReviewTask endpoint ===
	<pre style="width:100%">https://{serverName}/Grooper/Review/~~ReviewBatch~~?repositoryId={repositoryId}&taskId={taskId}</pre>		<pre style="width:100%">https://{serverName}/Grooper/Review/ReviewTask?repositoryId={repositoryId}&taskId={taskId}</pre>

	Use this endpoint to direct a user to a specific Review task.		Use this endpoint to direct a user to a specific Review task.
Line 61:		Line 61:

	The following URL would take the user to a Review task whose ID is "1" in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.		The following URL would take the user to a Review task whose ID is "1" in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.
	:<pre style="width:100%">https://servername/Grooper/Review/~~ReviewBatch~~?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1</pre>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewTask?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1</pre>

	'''''Optional Parameters:''' caller (string)''		'''''Optional Parameters:''' caller (string)''
Line 68:		Line 68:

	The following URL would take the user back to the Tasks Page after the single task is completed.		The following URL would take the user back to the Tasks Page after the single task is completed.
	:<pre style="width:100%">https://servername/Grooper/Review/~~ReviewBatch~~?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1&caller=Grooper/Tasks</pre>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewTask?repositoryId=00000000-0000-0000-0000-000000000000&taskId=1&caller=Grooper/Tasks</pre>

	=== The Scan endpoint===		=== The Scan endpoint===

Dgreenwood: /* The ReviewBatch endpoint */

2024-09-04T15:56:21Z

The ReviewBatch endpoint

← Older revision		Revision as of 10:56, 4 September 2024
Line 32:		Line 32:

	=== The ReviewBatch endpoint ===		=== The ReviewBatch endpoint ===
			<pre style="width:100%">https://{serverName}/Grooper/Review/ReviewBatch?repositoryId={repositoryId}&taskId={taskId}</pre>

	Use this endpoint to direct a user to Review tasks available for a specific '''Batch'''.		Use this endpoint to direct a user to Review tasks available for a specific '''Batch'''.

Line 39:		Line 41:

	The following URL would take the user to the first available task in a '''Batch''' whose ID is 00000000-0000-0000-0000-000000000000 in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.		The following URL would take the user to the first available task in a '''Batch''' whose ID is 00000000-0000-0000-0000-000000000000 in a Grooper Repository whose ID is 00000000-0000-0000-0000-000000000000.
	* <~~code><nowiki~~>https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000</~~nowiki></code~~>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000</pre>

	'''''Optional Parameters:''' caller (string)''		'''''Optional Parameters:''' caller (string)''
Line 46:		Line 48:

	The following URL would take the user back to the Batches Page after all available Review tasks are completed for the '''Batch'''.		The following URL would take the user back to the Batches Page after all available Review tasks are completed for the '''Batch'''.
	* <~~code~~>~~<nowiki~~>https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000&caller=Grooper/Batches</~~nowiki></code~~>		:<pre style="width:100%">>https://servername/Grooper/Review/ReviewBatch?repositoryId=00000000-0000-0000-0000-000000000000&batchId=00000000-0000-0000-0000-000000000000&caller=Grooper/Batches</pre>

	=== The ReviewTask endpoint ===		=== The ReviewTask endpoint ===

Dgreenwood: /* The ReviewTask endpoint */

2024-09-04T15:55:12Z

The ReviewTask endpoint

← Older revision		Revision as of 10:55, 4 September 2024
Line 49:		Line 49:

	=== The ReviewTask endpoint ===		=== The ReviewTask endpoint ===
	<pre style="width:100%">https://~~servername~~/Grooper/Review/ReviewBatch?repositoryId={repositoryId}&taskId={taskId}</pre>		<pre style="width:100%">https://{serverName}/Grooper/Review/ReviewBatch?repositoryId={repositoryId}&taskId={taskId}</pre>

	Use this endpoint to direct a user to a specific Review task.		Use this endpoint to direct a user to a specific Review task.

← Older revision		Revision as of 11:01, 4 September 2024
Line 11:		Line 11:

	=== The ReviewAll endpoint ===		=== The ReviewAll endpoint ===
			<pre style="width:100%">https://{serverName}/Grooper/Review/ReviewAll?repositoryId={repositoryId}&processName={processName}</pre>

	Use this endpoint to direct a user to available Review tasks in a Grooper Repository. Accessing this link will take the user to available Review tasks in the Tasks page.		Use this endpoint to direct a user to available Review tasks in a Grooper Repository. Accessing this link will take the user to available Review tasks in the Tasks page.


	'''''Required Parameters:''' repositoryId (GUID)''		'''''Required Parameters:''' repositoryId (GUID)''

	You must pass the Grooper Repository ID in the URL.		You must pass the Grooper Repository ID in the URL.


	The following URL would take a user to the first available task in a Grooper Repo whose ID is 00000000-0000-0000-0000-000000000000. After completing this task, the user would be directed to the next available task. And the task after that until all available tasks are completed.		The following URL would take a user to the first available task in a Grooper Repo whose ID is 00000000-0000-0000-0000-000000000000. After completing this task, the user would be directed to the next available task. And the task after that until all available tasks are completed.
	* <~~code><nowiki~~>https://servername/Grooper/Review/ReviewAll?repositoryId=00000000-0000-0000-0000-000000000000</~~nowiki></code~~>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewAll?repositoryId=00000000-0000-0000-0000-000000000000</pre>


	'''''Optional Parameters:''' processName (string), stepName (string), queueName (string), caller (string)''		'''''Optional Parameters:''' processName (string), stepName (string), queueName (string), caller (string)''
Line 27:		Line 32:
	* A '''Review Queue's''' name to filter Review tasks by members in a '''Review Queue'''.		* A '''Review Queue's''' name to filter Review tasks by members in a '''Review Queue'''.
	* A "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.		* A "caller" to route the user to a particular page (like the Batches Page or the Tasks Page) after completing all Review tasks. If no caller is set, the user will be taken to the Grooper Home Page.


	The following URL would take a user to available tasks for steps named "Data Review" (&stepname=Data%20Review) for a '''Batch Process''' named "Invoices" (&processName=Invoices) and return the user to the Tasks Page when finished (&caller=Grooper/Tasks).		The following URL would take a user to available tasks for steps named "Data Review" (&stepname=Data%20Review) for a '''Batch Process''' named "Invoices" (&processName=Invoices) and return the user to the Tasks Page when finished (&caller=Grooper/Tasks).
	* <~~code><nowiki~~>https://servername/Grooper/Review/ReviewAll?repositoryId=00000000-0000-0000-0000-00000000000&processName=Invoices&stepName=Data%20Review&caller=Grooper/Tasks</~~nowiki></code~~>		:<pre style="width:100%">https://servername/Grooper/Review/ReviewAll?repositoryId=00000000-0000-0000-0000-00000000000&processName=Invoices&stepName=Data%20Review&caller=Grooper/Tasks</pre>

	=== The ReviewBatch endpoint ===		=== The ReviewBatch endpoint ===