GAganjoor
Image

replace an image (Auth policies: artifact:modify)

put/api/images/replace/{id}

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required

Request body multipart/form-data

filestring binary

Response

OK

idstring uuid

Id

originalFileNamestring nullable

Original File Name

contentTypestring nullable

content type

fileSizeInBytesinteger

Original Image File Size In Byte

imageWidthinteger

Original Image Width

imageHeightinteger

Original Image Height

folderNamestring nullable

پوشه محل ذخیره تصویر

storedFileNamestring nullable

نام فایل ذخیره شده با بالاترین کیفیت

dataTimestring date-time

datetime

lastModifiedstring date-time

Last Modified for caching purposes

titlestring nullable

Title

titleInEnglishstring nullable

Title in English

descriptionstring nullable

Description

descriptionInEnglishstring nullable

Description in English

status0 | 1 | 2 | 4 | 8 | 16 | 32

Items or pictures status

orderinteger

order in the collection it belongs to it

normalSizeImageStoredFileNamestring nullable

نام فایل ذخیره شده با بالاترین کیفیت

thumbnailImageStoredFileNamestring nullable

نام فایل ذخیره شده با بالاترین کیفیت

normalSizeImageWidthinteger

عرض تصویر مناسب نمایش در صفحهٔ اختصاصی

normalSizeImageHeightinteger

طول تصویر مناسب نمایش در صفحهٔ اختصاصی

thumbnailImageWidthinteger

عرض تصویر با اندازه مناسب نمایش در صفحات لیستی

thumbnailImageHeightinteger

طول تصویر با اندازه مناسب نمایش در صفحات لیستی

srcUrlstring nullable

source url

lastModifiedMetastring date-time

Last Modified for caching purposes

externalNormalSizeImageUrlstring nullable

url to access this image from THE external host, contains '/norm/' which when you replace it with '/thumb/' you would have ExternalThumbnailImageUrl and if you replace it with '/orig/' you would have a url for ExternalOriginalSizeImageUrl which MIGHT NOT EXIST and end in a 404 error

Example response

{
  "folderName": "2017-08",
  "storedFileName": "85007253-09f2-4434-8b7e-1a23db2cd9c9.png",
  "normalSizeImageStoredFileName": "\r\n            e0d7050a-7e30-4a2f-b181-0daa4a1e1068.jpg\r\n            ",
  "thumbnailImageStoredFileName": "\r\n            fbe9cc8e-12fa-4cb9-8f09-bbf353333383.jpg\r\n            "
}

Changes

No recorded changes to this operation across all 43 revisions of this API.