Get Print Logos
post
/content/sim/v1/setup/getPrintLogos
Gets all the Print Logos configured
Request
Supported Media Types
- application/json
- multipart/form-data
Request body
Root Schema : PrintLogosGetRequest
Type:
Show Source
object-
include:
string
Objects included in responseExample:
locations -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits translated strings returnedExample:
en-US, de-DE, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record indexExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort orderExample:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Print Logos objects of the organization
Root Schema : PrintLogosGetResponse
Type:
objectModel for Print Logos Object
Show Source
-
content(required):
string
The actual file containing the image.Example:
abc123 -
filename(required):
string
The name of the image file with extensionSupported extensions - bmpExample:
ImageAppetizers.bmp -
hierUnitId(required):
integer
Unique reference of the hierarchy unit where the Print Logos is configuredExample:
3599 -
hierUnitName(required):
object hierUnitName
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unit where the Print Logos is configuredExample:
26 -
name(required):
object name
A group of string objects representing the name of the Print Logos in configured languages
-
objectNum(required):
integer
Object Number of the Print Logos.Example:
1 -
size(required):
integer
The size of the image in bytes.Maximum file size ??? 2 MBExample:
1 -
url(required):
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 : hierUnitName
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : name
Type:
objectA group of string objects representing the name of the Print Logos in configured languages
Example:
{
"en-US":"Print Logos",
"de-DE":"Print Logos"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html