2. Public API Explorer
  3. Manage OXOMI Content

Public API: Manage OXOMI Content

Active
Zurück
Provides services to import and delete catalogs and videos.
Documentation

Import Catalog

Imports the specified catalog.

POST JSON /import/catalog
Parameters
Name Description Required Example
filename Name of the file affected by the operation. true catalog.pdf
forwarding Indicates whether the content should be shared with partners. true false
password The user's password. true ****************
targetLevel Defines the Handelsstufen for which the content should be visible. true WHOLESALE
type Defines the content type. All possible types and the corresponding codes can be found at Dokumenttypen . true flyer
user Username of the OXOMI user to use for the operation. true john.doe
additionalLanguages Defines additional languages for which this content is available. This parameter could be provided multiple times, for each language one parameter-value-pair is necessary. All available languages and their abbreviations can be found at Sprachen . false en
additionalSearchTerms Defines additional search terms for this document. This parameter could be provided multiple times, for each term one parameter-value-pair is necessary. false Industrie Highlights 2023
brand Defines a brand for the content. false BRAND_ID
category Defines a category for the content. The category must already exist in OXOMI categories. false CATEGORY_ID
code Defines a code which can be used to specifically address the element. false Industry_Highlights_23
countries Defines for which countries this content is available. The value is a country code. This parameter could be provided multiple times, for each country one parameter-value-pair is necessary. All available countries and their abbreviations can be found at Länder . false de
description Defines a text that is used as a description of the content. false This is a description text.
editorMail This email address gets notified when new comments are added in this document in your own portals. false [email protected]
fileHash Defines the MD5 hash of the content file. If provided, OXOMI checks whether the file is different from the one currently stored based on this value. false d0765f518ff0cab426dbbd6d467c9967
id Defines the OXOMI ID of an already existing content whose metadata should be updated. The "id" is also presented as "entityId" in the server response after a successful operation. false 1193
internalName Use this parameter to define the internal name. The parameter "publicName" defines the name visible to portals and integrations. false Industry Highlights 01 2023
language Defines for which language this content is available. The value is a language code. If not specified, the default language of the tenant is used. All available languages and their abbreviations can be found at Sprachen . false de
pageOffset If the page of the document, on which the page number "1" is printed, is on the third page of the document, the page offset is 2. false 2
partnerRole Defines a partner role for the content. false PARTNER_ROLE_ID
printable Defines if the document has a print version available. false true
publicName Defines the name that will be displayed for the content if there is no translation of the name into a certain language. false Industry Highlights 2023
publicName-** Defines the name that will be displayed in OXOMI in a specific language for the content. The suffix "**" in the parameter stands for a language abbreviation that defines the target language. For example "publicName-de". All available languages and their abbreviations can be found at Sprachen . false Industrie Highlights 2023
series Defines a series for the content. false SERIES_ID
surcharge Defines additional information about the document. false This is an additional description or hint for the document.
tags Defines tags that will be added to this content. This parameter could be provided multiple times, for each tag one parameter-value-pair is necessary. false Exhibition_2023
updateInfo Defines whether the attached metadata should overwrite the existing one if the content already exists. If this parameter is not provided the existing metadata will not be overwritten. Possible values are: true/false. false true
validDateFrom Defines a date from when the content is visible. Format: DD.MM.YYYY false 01.01.2019
validDateUntil Defines a date until when the content is visible. Format: DD.MM.YYYY false 31.12.2019
Responses
Description Example
200 Your changes have been saved. Triggered when the request successfully started a new import job.
Content-Type: application/json 
        {
            "success": true,
            "error": false,
            "message": "Your changes have been saved.",
            "entityId": "1203",
            "jobId": "QU1CG7VKQU4VD796NLKT9L1TCS"
        }
200 Your changes have been saved. Triggered when an update took place, which requires updateInfo to be true.
Content-Type: application/json 
        {
            "success": true,
            "error": false,
            "message": "Your changes have been saved.",
            "entityId": "1200"
        }
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

Delete Catalog

Deletes the specified catalog.

GET JSON /import/catalog/delete
Parameters
Name Description Required Example
filename Name of the file affected by the operation. true catalog.pdf
password The user's password. true ****************
user Username of the OXOMI user to use for the operation. true john.doe
deleteOld Determines if the content should be deleted (true) or archived (false). false false
Responses
Description Example
200 Successful response
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "message": "The object was deleted successfully.",
    "entityId": "1191"
}
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

Import Video

Imports the specified Video.

POST JSON /import/video
Parameters
Name Description Required Example
filename Name of the file affected by the operation. true video.mp4
forwarding Indicates whether the content should be shared with partners. true false
password The user's password. true ****************
targetLevel Defines the Handelsstufen for which the content should be visible. true WHOLESALE
type Defines the content type. All possible types and the corresponding codes can be found at Videotypen . true usage
user Username of the OXOMI user to use for the operation. true john.doe
additionalLanguages Defines additional languages for which this content is available. This parameter could be provided multiple times, for each language one parameter-value-pair is necessary. All available languages and their abbreviations can be found at Sprachen . false en
brand Defines a brand for the content. false BRAND_ID
category Defines a category for the content. The category must already exist in OXOMI categories. false CATEGORY_ID
code Defines a code which can be used to specifically address the element. false Tool_Usage_2023
countries Defines for which countries this content is available. The value is a country code. This parameter could be provided multiple times, for each country one parameter-value-pair is necessary. All available countries and their abbreviations can be found at Länder . false de
description Defines a text that is used as a description of the content. false This is a description text.
fileHash Defines the MD5 hash of the content file. If provided, OXOMI checks whether the file is different from the one currently stored based on this value. false d0765f518ff0cab426dbbd6d467c9967
id Defines the OXOMI ID of an already existing content whose metadata should be updated. The "id" is also presented as "entityId" in the server response after a successful operation. false 1193
internalName Use this parameter to define the internal name. The parameter "publicName" defines the name visible to portals and integrations. false Tool Usage Demonstration 01 2023
language Defines for which language this content is available. The value is a language code. If not specified, the default language of the tenant is used. All available languages and their abbreviations can be found at Sprachen . false de
partnerRole Defines a partner role for the content. false PARTNER_ROLE_ID
publicName Defines the name that will be displayed for the content if there is no translation of the name into a certain language. false Tool Usage Demonstration
publicName-** Defines the name that will be displayed in OXOMI in a specific language for the content. The suffix "**" in the parameter stands for a language abbreviation that defines the target language. For example "publicName-de". All available languages and their abbreviations can be found at Sprachen false Demonstration der Werkzeugverwendung
series Defines a series for the content. false SERIES_ID
tags Defines tags that will be added to this content. This parameter could be provided multiple times, for each tag one parameter-value-pair is necessary. false Exhibition_2023
updateInfo Defines whether the attached metadata should overwrite the existing one if the content already exists. If this parameter is not provided the existing metadata will not be overwritten. Possible values are: true/false. false true
validDateFrom Defines a date from when the content is visible. Format: DD.MM.YYYY false 01.01.2019
validDateUntil Defines a date until when the content is visible. Format: DD.MM.YYYY false 31.12.2019
Responses
Description Example
200 Your changes have been saved. Triggered when the request successfully started a new import job.
Content-Type: application/json 
        {
            "success": true,
            "error": false,
            "message": "Your changes have been saved.",
            "entityId": "1203",
            "jobId": "QU1CG7VKQU4VD796NLKT9L1TCS"
        }
200 Your changes have been saved. Triggered when an update took place, which requires updateInfo to be true.
Content-Type: application/json 
        {
            "success": true,
            "error": false,
            "message": "Your changes have been saved.",
            "entityId": "1200"
        }
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

Delete Video

Deletes the specified Video.

GET JSON /import/video/delete
Parameters
Name Description Required Example
filename Name of the file affected by the operation. true video.mp4
password The user's password. true ****************
user Username of the OXOMI user to use for the operation. true john.doe
deleteOld Determines if the content should be deleted (true) or archived (false). false false
Responses
Description Example
200 Successful response
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "message": "The object was deleted successfully.",
    "entityId": "1191"
}
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