PATCH apioauth/tooltrackv2/items/{itemId}/images/{imageId}

Updates the comment and/or image data for an existing image. Only fields provided will be updated; omitted fields are left unchanged.

Request Information

URI Parameters

Name	Description	Type	Additional information
itemId	The id of the item the image belongs to.	integer	Required
imageId	The id of the image to update.	integer	Required

Body Parameters

The fields to update. All fields are optional.

PatchImageRequest

Name	Description	Type	Additional information
Comment	The updated comment. If omitted or whitespace, the existing comment is unchanged.	string	None.
ImageData	The updated image encoded as a Base64 string. If omitted or whitespace, the existing image is unchanged.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Comment": "sample string 1",
  "ImageData": "sample string 2"
}

application/xml, text/xml

Sample:

<PatchImageRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Comment>sample string 1</Comment>
  <ImageData>sample string 2</ImageData>
</PatchImageRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The id of the updated image.

CreateImageResponse

Name	Description	Type	Additional information
Id	The id of the created or updated image.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1
}

application/xml, text/xml

Sample:

<CreateImageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
</CreateImageResponse>