{
  "openapi" : "3.1.0",
  "info" : {
    "title" : "Content Information",
    "version" : "1.0.0",
    "description" : "Provides services for requesting content information."
  },
  "paths" : {
    "/portals/api/v1/documents" : {
      "get" : {
        "operationId" : "get-portals-api-v1-documents",
        "summary" : "Fetch List of Documents",
        "description" : "Allows to fetch a list of documents in JSON format by applying various filter criteria.\n",
        "parameters" : [ {
          "name" : "accessToken",
          "in" : "query",
          "required" : true,
          "description" : "Access token for non-public portals. When submitting a <i>user</i> or <i>roles,</i> the respective values need to be considered during the computation of the token. See kba:INT63 for details.",
          "schema" : {
            "type" : "string"
          },
          "example" : "d0765f518ff0cab426dbbd6d467c9967"
        }, {
          "name" : "portal",
          "in" : "query",
          "required" : true,
          "description" : "Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the <a href=\"/portals\">Portals</a> page.",
          "schema" : {
            "type" : "string"
          },
          "example" : "9999999"
        }, {
          "name" : "user",
          "in" : "query",
          "required" : true,
          "description" : "User name",
          "schema" : {
            "type" : "string"
          },
          "example" : "john.doe"
        }, {
          "name" : "includeOutdated",
          "in" : "query",
          "required" : false,
          "description" : "Specifies whether outdated documents should be included in the result set.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "language",
          "in" : "query",
          "required" : false,
          "description" : "Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code.",
          "schema" : {
            "type" : "string"
          },
          "example" : "de"
        }, {
          "name" : "limit",
          "in" : "query",
          "required" : false,
          "description" : "Maximum number of items to return. Defaults to 50. Maximum is 1000.",
          "schema" : {
            "type" : "string"
          },
          "example" : "10"
        }, {
          "name" : "onlyOutdated",
          "in" : "query",
          "required" : false,
          "description" : "Specifies whether only outdated documents should be returned.",
          "schema" : {
            "type" : "string"
          },
          "example" : "false"
        }, {
          "name" : "roles",
          "in" : "query",
          "required" : false,
          "description" : "Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public.",
          "schema" : {
            "type" : "string"
          },
          "example" : "Heating,Electronics,Top-Customer"
        }, {
          "name" : "sortBy",
          "in" : "query",
          "required" : false,
          "description" : "Defines the sort criteria. Possible values are 'priority' (default), 'name', 'date', 'random'.",
          "schema" : {
            "type" : "string"
          },
          "example" : "priority"
        }, {
          "name" : "start",
          "in" : "query",
          "required" : false,
          "description" : "Number of items to skip for pagination purposes.",
          "schema" : {
            "type" : "string"
          },
          "example" : "50"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successful response",
            "content" : {
              "application/json" : {
                "examples" : {
                  "example1" : {
                    "value" : {
                      "success" : true,
                      "error" : false,
                      "documents" : [ {
                        "id" : "ABC123",
                        "code" : "CODE",
                        "type" : "promotion",
                        "typeName" : "Aktion",
                        "name" : "Sanitär Aktion",
                        "outdated" : false,
                        "previewUrl" : "https://oxomi.com/dasd/p/documents/.../.../....jpg",
                        "mediumUrl" : "https://oxomi.com/dasd/p/documents/.../.../....jpg",
                        "numberOfPages" : 42,
                        "supplierNumber" : "ST",
                        "supplierNumbers" : [ "ST" ],
                        "brand" : {
                          "id" : "XYZ456",
                          "name" : "ST Sanitär",
                          "mediumImageUrl" : "https://oxomi.com/dasd/p/tenants/.../.../....jpg"
                        },
                        "series" : {
                          "id" : "ABC456",
                          "code" : "CODE",
                          "name" : "ST CeramX",
                          "mediumImageUrl" : "https://oxomi.com/dasd/p/series/.../.../....jpg"
                        },
                        "tags" : [ "#Sanitär", "#Bad", "#Aktion" ],
                        "categories" : [ {
                          "id" : "XYZ789",
                          "name" : "Badmöbel",
                          "mediumImageUrl" : "https://oxomi.com/dasd/p/categories/.../.../....jpg"
                        } ],
                        "languages" : [ {
                          "code" : "de",
                          "name" : "Deutsch"
                        } ],
                        "countries" : [ {
                          "code" : "de",
                          "name" : "Deutschland"
                        } ]
                      } ]
                    }
                  }
                }
              }
            }
          },
          "400" : {
            "description" : "Missing parameter or malformed request",
            "content" : {
              "application/json" : {
                "examples" : {
                  "example1" : {
                    "value" : {
                      "success" : false,
                      "error" : true,
                      "message" : "The parameter {missingParameter} must be filled."
                    }
                  }
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication required but none provided",
            "content" : {
              "application/json" : { }
            }
          },
          "403" : {
            "description" : "Invalid authentication or missing permission",
            "content" : {
              "application/json" : { }
            }
          },
          "404" : {
            "description" : "Resource not found",
            "content" : {
              "application/json" : { }
            }
          },
          "405" : {
            "description" : "Incorrect request method, e.g. GET instead of POST",
            "content" : {
              "application/json" : { }
            }
          },
          "500" : {
            "description" : "Unexpected server-side error",
            "content" : {
              "application/json" : { }
            }
          }
        }
      }
    }
  }
}