ozamani9gh
commented
1 month ago @arlentees closing other ticket.
@rarmitag here is arlens comments on previous investigation ticket... we will use this ticket moving forwatd:
@doug-lovett we had a discussion today and the thought of pushing all logic over to a single scanning api endpoint came up which would have greater decision making responsibility (effectively removing the need to have a dual legacy DB scanning software and modern API scanning software running on the same machine). No need to take action on this now, but let's discuss when you're back.
oanyahuru
The Assets Team has a desktop scanning application written in .NET
Richard will investigate to see how much work it will be to convert all Oracle SQL Changes to REST API calls.
This will determine when we will have time to implement the changes.
The spec for the document service API is here: https://bcregistry-partnerrestricted.apigee.io/docs/doc-service-proxy/1/overview A postman collection with example calls is here: doc-api-unit.postman_collection.json.zip
In general, the API endpoints with /scanning in the path are for the scanning application,
Use the endpoint /docs/api/v1/scanning/{documentClass}/{consumerDocumentId} to get, create, and update a document scanning record.
Use the endpoint /docs/api/v1/documents/{documentClass}/{documentType} to create a document service record and save a pdf.
See https://app.zenhub.com/workspaces/assets-team-space-new-655515cb02e714000e74f9f3/issues/gh/bcgov/entity/23461 for creating, updating, getting scanner parameters and getting scanner schedule information.
See https://app.zenhub.com/workspaces/assets-team-space-new-655515cb02e714000e74f9f3/issues/gh/bcgov/entity/23458 for creating, updating, getting document boxes and getting the max batch id by accession number
See https://app.zenhub.com/workspaces/assets-team-space-new-655515cb02e714000e74f9f3/issues/gh/bcgov/entity/23371 for getting authors
See https://app.zenhub.com/workspaces/assets-team-space-new-655515cb02e714000e74f9f3/issues/gh/bcgov/entity/23455 for getting document clases and types.
Doc API URLs: https://bcregistry-dev.apigee.net/doc/api/v1 https://bcregistry-test.apigee.net/doc/api/v1 https://bcregistry-prod.apigee.net/doc/api/v1
To do: Create/update PROD gateway account for the scanner application to use the doc api: provide account id and api key as scanner application configuration variables (along with the doc api URL). The service account must have the Registries keycloak staff role.
TEST gateway account configured for the doc scan app. Request headers: x-apikey: KGGGEy1K67LgOZvdei6FPH23UtOf3oSF Account-Id: doc_scan Content-Type: application/json Example TEST request: GET https://bcregistry-test.apigee.net/doc/api/v1/searches/PPR?consumerDocumentId=99999997