2. Public API Explorer
  3. Content Information

Public API: Content Information

Active
Zurück
Provides services for requesting content information.

Fetch List of Documents

Allows to fetch a list of documents in JSON format by applying various filter criteria.

GET JSON /portals/api/v1/documents
Parameters
Name Description Example
accessToken
Required
Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. d0765f518ff0cab426dbbd6d467c9967
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name john.doe
includeOutdated Specifies whether outdated documents should be included in the result set. true
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. de
limit Maximum number of items to return. Defaults to 50. Maximum is 1000. 10
onlyOutdated Specifies whether only outdated documents should be returned. false
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. Heating,Electronics,Top-Customer
sortBy Defines the sort criteria. Possible values are 'priority' (default), 'name', 'date', 'random'. priority
start Number of items to skip for pagination purposes. 50
Responses
Description Example
200 Successful response
Content-Type: application/json 
{
    "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 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json