Configuration and Content API Guide

Get Print Logos

post

/content/sim/v1/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: object

Show Source

include: string

Objects included in the response.

Example: hierUnitId
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 the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

If using paging, number of results returned in this page.

Example: 10
offset: integer

Starting resource record index. Not required if paging parameters are not supported.

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Print Logos.

Root Schema : PrintLogosGetResponsev1

Type: object

Show Source

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 size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Print Logo objects of the organization.",
            "items":{
                "$ref":"#/definitions/PrintLogosResponse"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Print Logo objects of the organization.

Show Source

Array of: object PrintLogosResponse

Model for Print Logos Object

{
    "type":"array",
    "description":"Array of Print Logo objects of the organization.",
    "items":{
        "$ref":"#/definitions/PrintLogosResponse"
    }
}

Nested Schema : PrintLogosResponse

Type: object

Model 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 - bmp

Example: ImageAppetizers.bmp
hierUnitId: integer

Unique reference of the hierarchy unit where the Print Logos is configured

Example: 3599
hierUnitName: object hierUnitName

A string that contains translations of hierarchy unit name into multiple languages
hierUnitObjNum: integer

Object number of the hierarchy unit where the Print Logos is configured

Example: 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 MB

Example: 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

{
    "description":"Model for Print Logos Object",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Print Logos is configured",
            "type":"integer",
            "example":3599
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit where the Print Logos is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "description":"A string that contains translations of hierarchy unit name into multiple languages",
            "type":"object",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "es-MX":"Propiedad"
            }
        },
        "objectNum":{
            "description":"Object Number of the Print Logos.",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the Print Logos  in configured languages",
            "type":"object",
            "example":{
                "en-US":"Print Logos",
                "de-DE":"Print Logos"
            }
        },
        "size":{
            "description":"The size of the image in bytes.Maximum file size - 2 MB",
            "type":"integer",
            "example":1
        },
        "filename":{
            "description":"The name of the image file with extensionSupported extensions - bmp",
            "type":"string",
            "example":"ImageAppetizers.bmp"
        },
        "content":{
            "description":"The actual file containing the image.",
            "type":"string",
            "example":"abc123"
        },
        "url":{
            "description":"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.",
            "type":"string",
            "example":"baseURL/content/sim/v1/orgidentifier/printLogos/{hierUnitId}/download"
        }
    }
}

Nested Schema : hierUnitName

Type: object

A 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: object

A group of string objects representing the name of the Print Logos in configured languages

Example:

{
    "en-US":"Print Logos",
    "de-DE":"Print Logos"
}