Skip to main content

Function: updateReferenceImage()

updateReferenceImage(client, props): Promise<{ id: number; productId: number; description: string; fileOid: string; createdAt: string; updatedAt: string; }>

Updates a reference image (e.g. description).

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; projectName: string; productCode: string; referenceImageId: number; } = updateReferenceImageParamsSchema

Path parameters (orgName, projectName, productCode, referenceImageId)

params.orgName​

string = orgNameSchema

params.projectName​

string = projectNameSchema

params.productCode​

string = productCodeSchema

params.referenceImageId​

number = ...

body​

{ description?: string; } = updateReferenceImageBodySchema

Body with optional description

body.description?​

string = ...

Returns​

Promise<{ id: number; productId: number; description: string; fileOid: string; createdAt: string; updatedAt: string; }>

Promise resolving to the updated reference image

Operation Id​

update-reference-image