resolution

Resolution Search

Changed on

Search Resolutions this user has access to

get/resolution

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/resolution
  • Auth
    none declared

Query parameters

resolutionIdinteger

Filter by Resolution Id

resolutionstring

Filter by Resolution Name

useRegexForNameinteger

Flag (0,1). When filtering by multiple resolutions in resolution filter, should we use regex?

logicalOperatorNamestring

When filtering by multiple resolutions in resolution filter, which logical operator should be used? AND|OR

enabledinteger

Filter by Enabled

widthinteger

Filter by Resolution width

heightinteger

Filter by Resolution height

sortBy'resolutionId' | 'resolution' | 'width' | 'height' | 'enabled'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

resolutionIdinteger

The ID of this Resolution

resolutionstring

The resolution name

widthnumber double

The display width of the resolution

heightnumber double

The display height of the resolution

designerWidthnumber double

The designer width of the resolution

designerHeightnumber double

The designer height of the resolution

versioninteger

The layout schema version

enabledinteger

A flag indicating whether this resolution is enabled or not

userIdinteger

The userId who owns this Resolution

Changes

  • fe497e811c7fRevision changes
    • warning

      deleted the query request parameter partialResolution

    • info

      added the new optional query request parameter logicalOperatorName

    • info

      added the new optional query request parameter sortBy

    • info

      added the new optional query request parameter sortDir

    • info

      added the new optional query request parameter useRegexForName

  • 41c04de98ec5Revision changes
    • info

      added the media type application/json for the response with the status