Product Repository APIProduct
Replace a global product
Security groups:Global Product Creators
Replaces a global Product with the provided payload. Creates the Product if it does not exist.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
productId*string
The ID of the product.
Length
length <= 65currentVersion*integer
The current version of product. Must be a non-negative integer.
Range
0 <= valuekeepFiles?boolean
When true (default), existing files attached to the product are preserved after an update. When false, all attached files are deleted.
Default
trueeligibleApplications?array<>
Validate this product against the listed eClear applications. Each application has a defined set of required fields; if all required fields are present, the product is tagged for that application. Tags appear in applicationTags on the product response.
Request Body
application/json
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/products/global?productId=ProductId1¤tVersion=1" \ -H "Content-Type: application/json" \ -d '{}'Empty
{
"code": "BadRequest",
"message": "Bad request.",
"status": "BAD_REQUEST"
}{
"code": "Unauthorized",
"message": "Not authorized.",
"status": "UNAUTHORIZED"
}{
"code": "Forbidden",
"message": "API key no longer has access to the account, or their user level doesn’t allow access to the endpoint.",
"status": "FORBIDDEN"
}{
"code": "NotFound",
"message": "The requested resource could not be found. Either no object exists with the ID provided in the path, or the path is incorrect.",
"status": "NOT_FOUND"
}{
"status": "CONFLICT",
"code": "CONFLICT_ENTITY_MODIFIED",
"message": "Conflict.",
"timestamp": "2024-06-21T12:36:37.900574",
"path": "/path"
}{
"status": "UNPROCESSABLE_ENTITY",
"timestamp": "2024-02-05T18:04:28Z",
"code": "INVALID_DATA_EXCEPTION",
"message": "The request entity cannot be processed.",
"path": "/path"
}{
"code": "LIMIT_EXCEEDED",
"message": "Usage limit exceeded for free trial subscription.",
"status": "TOO_MANY_REQUESTS",
"detail": "The free trial monthly limit of 100 checks has been exceeded. Please upgrade to a paid subscription.",
"instance": "3b4dcb40-0b6b-4820-bfaa-41267b3826ea"
}