{ "opencollection": "1.0.0", "info": { "name": "Templafy Public DataSourceFields Images API", "version": "v3" }, "items": [ { "info": { "name": "Images", "type": "folder" }, "items": [ { "info": { "name": "Lists all image assets in the folder.", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/images/folders/:folderId/assets", "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "The identifier of the space" }, { "name": "folderId", "value": "", "type": "path", "description": "The identifier of the folder" }, { "name": "searchQuery", "value": "", "type": "query", "description": "Filter on image name, description, tags and automatic tags" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number from the result set. Page number is set to 1 by default if {searchQuery} is passed. A value passed only for the page number and not for the page size is ignored." }, { "name": "pageSize", "value": "", "type": "query", "description": "Size of the returned page. If {searchQuery} is not set, not passing page size or having it 0 returns all the assets from the folder. Acceptable values are 0 to 1000, inclusive." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The result does not include images from subfolders. When {searchQuery} is used the result includes images from subfolders. The search mode enables pagination with 1000 page size maximum." }, { "info": { "name": "Uploads the image file.", "type": "http" }, "http": { "method": "POST", "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/images/folders/:folderId/assets", "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "The identifier of the space" }, { "name": "folderId", "value": "", "type": "path", "description": "The identifier of the folder" } ], "body": { "type": "multipart-form", "data": [ { "name": "File", "type": "text", "value": "" }, { "name": "Name", "type": "text", "value": "" }, { "name": "Description", "type": "text", "value": "" }, { "name": "Tags", "type": "text", "value": "" }, { "name": "ExternalData", "type": "text", "value": "" } ] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Only one file can be attached to the request body. The supported file formats are .JPG/.JPEG, .PNG, .GIF and .SVG" }, { "info": { "name": "Returns the image by the identifier.", "type": "http" }, "http": { "method": "GET", "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/images/assets/:assetId", "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "The identifier of the space" }, { "name": "assetId", "value": "", "type": "path", "description": "The identifier of the image to retrieve" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the image by the identifier." }, { "info": { "name": "Updates the image asset.", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/images/assets/:assetId", "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "The identifier of the space" }, { "name": "assetId", "value": "", "type": "path", "description": "The identifier of the image asset" } ], "body": { "type": "multipart-form", "data": [ { "name": "AutomaticTags", "type": "text", "value": "" }, { "name": "FolderId", "type": "text", "value": "" }, { "name": "Name", "type": "text", "value": "" }, { "name": "Description", "type": "text", "value": "" }, { "name": "Tags", "type": "text", "value": "" }, { "name": "ExternalData", "type": "text", "value": "" }, { "name": "File", "type": "text", "value": "" } ] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Only one file can be attached to the request body. The supported file formats are .JPG/.JPEG, .PNG, .GIF and .SVG" }, { "info": { "name": "Deletes the image by the identifier.", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenantId}.api.templafy.com/v3/libraries/:spaceId/images/assets/:assetId", "params": [ { "name": "spaceId", "value": "", "type": "path", "description": "The identifier of the space" }, { "name": "assetId", "value": "", "type": "path", "description": "The identifier of the image to delete" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes the image by the identifier." } ] } ], "bundled": true }