Core API Endpoint Overview
Base path
/api/core/v1
For more details please check Core API URI schema.
Common
| /common/components/retrieve Retrieve a list of components |
| /common/glossaries/perform Perform actions for glossaries |
| /common/glossaries/persist Create or update the glossaries |
| /common/glossaries/retrieve Retrieve a list of glossaries |
| /common/glossaries/bulk Carries out a bulk operation for perform or persist |
| /common/glossaryEntries/perform Perform actions for glossary entries |
| /common/glossaryEntries/persist Create or update the glossary entries |
| /common/glossaryEntries/bulk Carries out a bulk operation for perform or persist |
| /common/keywords/perform Perform actions for keywords |
| /common/keywords/persist Create or update the keywords |
| /common/keywords/retrieve Retrieve a list of keywords and assets of the given keyword root or node |
| /common/keywords/bulk Carries out a bulk operation for perform or update |
| /common/links/persist Create links |
| /common/links/bulk Carries out a bulk operation for persist |
| /common/locales/retrieve Returns locales by mode, ids or identifiers |
| /common/messages/persist Sends a message to a user and/or group |
Digital Asset Management [DAM]
| /dam/assets/bin/chunked/start Initializes a chunk upload session for the file |
| /dam/assets/bin/chunked/upload/{uploadTid} Upload a specified chunk of an asset. |
| /dam/assets/bin/chunked/persist/{uploadTid} Finalize the chunking upload of an asset. |
| /dam/assets/bin/retrieve Retrieves binary data of asset(s). |
| /dam/assets/bin/persist Upload asset to the system. |
| /dam/assets/previews/retrieve Retrieve assets previews info. |
| /dam/assets/perform Delete / move / copy / checkin / checkout / clean checkout assets. |
| /dam/assets/retrieve Retrieve asset information and attributes details. |
| /dam/assets/persist Saves asset information and asset attributes details. |
| /dam/assets/query Gets list of asset tids by allowed criteria |
| /dam/assets/status Gets the status information for given assets. |
| /dam/assets/histories/retrieve Retrieve asset histories by specified path. |
| /dam/assets/bulk Carries out a bulk operation for perform or persist |
| /dam/assets/variations/retrieve Retrieves asset variations. |
| /dam/assets/variations/types Retrieves asset variation types. |
| /dam/assets/variations/bin/persist Upload file as variation to the system. |
| /dam/assets/versions/bin/chunked/start Initialize chunk upload session for the version file. |
| /dam/assets/versions/bin/chunked/upload/{uploadTid} Upload a specified chunk of an asset. |
| /dam/assets/versions/bin/chunked/persist/{uploadTid} Finalize the chunk upload of the asset version. |
| /dam/assets/versions/bin/persist Upload asset as version to the system. |
| /dam/assets/versions/bin Retrieves the binary data of asset version. |
| /dam/dirs/retrieve Retrieves a list of sub-directories of the given RNC or directory. |
| /dam/dirs/persist Persist a list of directories. |
| /dam/dirs/perform Delete / move / copy a directory or create multiple directories along a path. |
| /dam/dirs/bulk Carries out a bulk operation for perform or persist |
| /dam/rncs/retrieve Returns all Root Node Configurations [RNC]. |
Product Information Management [PIM]
| /pim/classes Get classifications. |
| /pim/classes/retrieve Retrieve classifications information without or with nodes and nodes attributes. |
| /pim/classes/persist Saves classifications and classification nodes with attributes. |
| /pim/classes/perform Deletes classifications and classification nodes with attributes. |
| /pim/classes/bulk Carries out a bulk operation for perform or persist |
| /pim/attribute-definitions Gets information about all attribute definitions. |
| /pim/attribute-definitions/query Gets attribute definition ids by allowed criteria. |
| /pim/attribute-definitions/retrieve Retrieves information about attribute definitions. |
| /pim/attribute-definitions/perform Deletes attribute definitions. |
| /pim/attribute-definitions/persist Creates or updates attribute definitions. |
| /pim/attribute-definitions/bulk Carries out a bulk operation for perform or persist |
| /pim/attributes/query Gets list of attribute IDs. |
| /pim/attributes/retrieve Retrieves attributes information. |
| /pim/attributes/persist Saves node attributes information. |
| /pim/attributes/perform Deletes attributes. |
| /pim/attributes/bulk Carries out a bulk operation for perform or persist |
| /pim/nodes/query Gets node ids. |
| /pim/nodes/retrieve Returns nodes structure with attributes. |
| /pim/nodes/persist Saves nodes structure. Several nodes could be persisted. |
| /pim/nodes/perform Deletes nodes. |
| /pim/nodes/bulk Carries out a bulk operation for perform or persist |
| /pim/products/persist Saves products information and product attributes details. |
| /pim/products/perform Deletes / copies products. |
| /pim/products/retrieve Returns list of product trees by identifiers. |
| /pim/products/query Get tids of products by allowed criteria |
| /pim/products/links/perform Unlink products from products. |
| /pim/products/links/persist Link products to another products. |
| /pim/products/bulk Carries out a bulk operation for perform or persist. Links does not have bulk operation |
Channel Management [CM]
| /cm/channels/query Query for channel TIDs |
| /cm/channels/retrieve Retrieve channels |
| /cm/channels/briefings/retrieve Retrieve channel briefings |
| /cm/channels/bulk Carries out a bulk operation for perform or persist |
Product Export Options [PEO]
| /peo/peos/query Get lost of PEO tids by allowed criteria. |
| /peo/peos/retrieve Retrieves information about PEOs. |
| /peo/peos/persist Creates or updates PEOs. |
| /peo/peos/perform Delete / copy PEOs. |
| /peo/peos/links/persist Link PEOs to projects. |
| /peo/peos/links/perform Unlinks PEOs from projects. |
| /peo/peos/bulk Carries out a bulk operation for perform or persist |