Get Print Logos
post
/content/sim/v2/setup/getPrintLogos
Gets all the Print Logos configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Print Logos.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Print Logo objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Print Logo objects of the organization.
Show Source
-
Array of:
object PrintLogov2
Model for Print Logos Object
Nested Schema : PrintLogov2
Type:
objectModel for Print Logos Object
Show Source
-
content:
string
The actual file containing the image.Example:
abc123 -
filename:
string
The name of the image file with extensionSupported extensions - bmpExample:
ImageAppetizers.bmp -
hierUnitId:
integer
Unique reference of the hierarchy unit where the Print Logos is configuredExample:
3599 -
hierUnitObjNum:
integer
Object number of the hierarchy unit where the Print Logos is configuredExample:
26 -
name:
object name
A group of string objects representing the name of the Print Logos in configured languages
-
objectNum:
integer
Object Number of the Print Logos.Example:
1 -
size:
integer
The size of the image in bytes.Maximum file size - 2 MBExample:
1 -
url:
string
The URL of the download API which needs to be used to download the actual content file. This is auto generated and does not need to be provided during Add/Update API calls.Example:
baseURL/content/sim/v1/orgidentifier/printLogos/{hierUnitId}/download
Nested Schema : name
Type:
objectA group of string objects representing the name of the Print Logos in configured languages
Example:
{
"1":"Print Logos",
"2":"Print Logos"
}