List Resources

Get a filtered list of all the resources in the organization

URL:

POST http://api.aurelon.com/api/v2/resource/list

Request Headers:

Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication

Request Body:

JSON object containing the type to filter on:

  • ResourceTypes – required – an array with one or more of the following types (“NormalProfile, DefectProfile, IccProfile, FotobaMarks, Label, ColorMapping, Template, LayoutTemplate, Library, Preview).When is used then all resources are listed.
  • Domain – optional – Domain to query, allowed values Private and Public. Default if Private when not specified.

Example:
[{“ResourceTypes”:[“Label”,”Template”]}]

Response:

Return the company resources filtered by request body filter. The list is a packed array of arrays. Each item in the array as a resource represented by an array of 4 elements.
Packed method is used to save space in the transfer. The following 4 elements are presented in the following order:

  1. ResourceGUID
  2. ResourceType
  3. SHA1 checksum
  4. Name

Success:

200 OK : Return resource list

[
    ["88de5c02-cce6-411f-950f-be309caa4439","Label","acox3",”MyName”],
    ["1cb6e329-d001-4aff-970e-7cfaf025f27b","Label","1r3ff",”Ticket”],
    ["267437af-459b-4b9d-8ace-5d52658c4626","Template","erffeff",”MyTmp”]
]

Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”: “Invalid MisKey”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}
Updated on May 19, 2022

Was this article helpful?