REST Endpoints
Asset Resources
Task | Method | Path |
---|---|---|
Get asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId} |
Get asset resource metadata URL link. | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} | |
Read an asset by ID, type, and site along with its dependent assets in an aggregated format | get | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Navigation Resources
Task | Method | Path |
---|---|---|
Get navigation by nodeIdentifier resource metadata URL Link by node identifier | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} | |
Get navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation |
Get navigation resource metadata URL link | /resources/v1/aggregates/{siteName}/navigation | |
Get node ID based on navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get the navigation by node identifier | get | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get the navigation for a site | get | /resources/v1/aggregates/{siteName}/navigation |
Collection Asset Resources
Task | Method | Path |
---|---|---|
Get collection asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get collection resource metadata URL link | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items | |
Get the collection asset and its evalauted results by ID | get | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Recommendation Resources
Task | Method | Path |
---|---|---|
Get recommendation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get recommendation resource metadata URL link | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items | |
Get the items for a given recommendation | get | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Segments resource | get | /resources/v1/engage/segments |
Search Resources
Task | Method | Path |
---|---|---|
Get asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/types/{assetType}/assets |
Get search by an asset type resource metadata URL link | /resources/v1/search/types/{assetType}/assets | |
Get search by asset type in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/types/{assetType}/assets | |
Get search in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/assets | |
Get search resource metadata | get | /resources/v1/metadata-catalog/search/assets |
Get site name and asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets |
Get site name based search resource metadata | get | /resources/v1/metadata-catalog/search/sites/{siteName}/assets |
Get the search resource metadata URL link | /resources/v1/search/assets | |
Search all assets | get | /resources/v1/search/assets |
Search assets by asset type | get | /resources/v1/search/types/{assetType}/assets |
Search assets in a given site | get | /resources/v1/search/sites/{siteName}/assets |
Search assets in a site by asset type | get | /resources/v1/search/sites/{siteName}/types/{assetType}/assets |
Version Resources
Task | Method | Path |
---|---|---|
Get all the REST resources for a version | get | /resources/{version} |
Get all the versions of the REST API | get | /resources |
Get the metadata links for all REST resources in a given version | get | /resources/{version}/metadata-catalog |
Task | Method | Path |
---|---|---|
Get all the REST resources for a version | get | /resources/{version} |
Get all the versions of the REST API | get | /resources |
Get asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId} |
Get asset resource metadata URL link. | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} | |
Get asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/types/{assetType}/assets |
Get collection asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get collection resource metadata URL link | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items | |
Get navigation by nodeIdentifier resource metadata URL Link by node identifier | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} | |
Get navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation |
Get navigation resource metadata URL link | /resources/v1/aggregates/{siteName}/navigation | |
Get node ID based on navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get recommendation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get recommendation resource metadata URL link | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items | |
Get search by an asset type resource metadata URL link | /resources/v1/search/types/{assetType}/assets | |
Get search by asset type in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/types/{assetType}/assets | |
Get search in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/assets | |
Get search resource metadata | get | /resources/v1/metadata-catalog/search/assets |
Get site name and asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets |
Get site name based search resource metadata | get | /resources/v1/metadata-catalog/search/sites/{siteName}/assets |
Get the collection asset and its evalauted results by ID | get | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get the items for a given recommendation | get | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get the metadata links for all REST resources in a given version | get | /resources/{version}/metadata-catalog |
Get the navigation by node identifier | get | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get the navigation for a site | get | /resources/v1/aggregates/{siteName}/navigation |
Get the search resource metadata URL link | /resources/v1/search/assets | |
Read an asset by ID, type, and site along with its dependent assets in an aggregated format | get | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Search all assets | get | /resources/v1/search/assets |
Search assets by asset type | get | /resources/v1/search/types/{assetType}/assets |
Search assets in a given site | get | /resources/v1/search/sites/{siteName}/assets |
Search assets in a site by asset type | get | /resources/v1/search/sites/{siteName}/types/{assetType}/assets |
Segments resource | get | /resources/v1/engage/segments |
Asset Resources
Task | Method | Path |
---|---|---|
Read an asset by ID, type, and site along with its dependent assets in an aggregated format | get | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Get asset resource metadata URL link. | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} | |
Get asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId} |
Navigation Resources
Task | Method | Path |
---|---|---|
Get the navigation for a site | get | /resources/v1/aggregates/{siteName}/navigation |
Get navigation resource metadata URL link | /resources/v1/aggregates/{siteName}/navigation | |
Get the navigation by node identifier | get | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get navigation by nodeIdentifier resource metadata URL Link by node identifier | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} | |
Get navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation |
Get node ID based on navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier} |
Collection Asset Resources
Task | Method | Path |
---|---|---|
Get the collection asset and its evalauted results by ID | get | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get collection resource metadata URL link | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items | |
Get collection asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Recommendation Resources
Task | Method | Path |
---|---|---|
Get the items for a given recommendation | get | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get recommendation resource metadata URL link | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items | |
Segments resource | get | /resources/v1/engage/segments |
Get recommendation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Search Resources
Task | Method | Path |
---|---|---|
Get search resource metadata | get | /resources/v1/metadata-catalog/search/assets |
Get site name based search resource metadata | get | /resources/v1/metadata-catalog/search/sites/{siteName}/assets |
Get asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/types/{assetType}/assets |
Get site name and asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets |
Search all assets | get | /resources/v1/search/assets |
Get the search resource metadata URL link | /resources/v1/search/assets | |
Search assets in a given site | get | /resources/v1/search/sites/{siteName}/assets |
Get search in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/assets | |
Search assets in a site by asset type | get | /resources/v1/search/sites/{siteName}/types/{assetType}/assets |
Get search by asset type in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/types/{assetType}/assets | |
Search assets by asset type | get | /resources/v1/search/types/{assetType}/assets |
Get search by an asset type resource metadata URL link | /resources/v1/search/types/{assetType}/assets |
Version Resources
Task | Method | Path |
---|---|---|
Get all the versions of the REST API | get | /resources |
Get all the REST resources for a version | get | /resources/{version} |
Get the metadata links for all REST resources in a given version | get | /resources/{version}/metadata-catalog |
Task | Method | Path |
---|---|---|
Get all the versions of the REST API | get | /resources |
Get the items for a given recommendation | get | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get recommendation resource metadata URL link | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items | |
Get the navigation for a site | get | /resources/v1/aggregates/{siteName}/navigation |
Get navigation resource metadata URL link | /resources/v1/aggregates/{siteName}/navigation | |
Get the navigation by node identifier | get | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get navigation by nodeIdentifier resource metadata URL Link by node identifier | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} | |
Read an asset by ID, type, and site along with its dependent assets in an aggregated format | get | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Get asset resource metadata URL link. | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} | |
Get the collection asset and its evalauted results by ID | get | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get collection resource metadata URL link | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items | |
Segments resource | get | /resources/v1/engage/segments |
Get recommendation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation |
Get node ID based on navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId} |
Get collection asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get search resource metadata | get | /resources/v1/metadata-catalog/search/assets |
Get site name based search resource metadata | get | /resources/v1/metadata-catalog/search/sites/{siteName}/assets |
Get asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/types/{assetType}/assets |
Get site name and asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets |
Search all assets | get | /resources/v1/search/assets |
Get the search resource metadata URL link | /resources/v1/search/assets | |
Search assets in a given site | get | /resources/v1/search/sites/{siteName}/assets |
Get search in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/assets | |
Search assets in a site by asset type | get | /resources/v1/search/sites/{siteName}/types/{assetType}/assets |
Get search by asset type in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/types/{assetType}/assets | |
Search assets by asset type | get | /resources/v1/search/types/{assetType}/assets |
Get search by an asset type resource metadata URL link | /resources/v1/search/types/{assetType}/assets | |
Get all the REST resources for a version | get | /resources/{version} |
Get the metadata links for all REST resources in a given version | get | /resources/{version}/metadata-catalog |
Asset Resources
Task | Method | Path |
---|---|---|
Read an asset by ID, type, and site along with its dependent assets in an aggregated format | get | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Get asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId} |
Get asset resource metadata URL link. | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Navigation Resources
Task | Method | Path |
---|---|---|
Get the navigation for a site | get | /resources/v1/aggregates/{siteName}/navigation |
Get the navigation by node identifier | get | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation |
Get node ID based on navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get navigation resource metadata URL link | /resources/v1/aggregates/{siteName}/navigation | |
Get navigation by nodeIdentifier resource metadata URL Link by node identifier | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Collection Asset Resources
Task | Method | Path |
---|---|---|
Get the collection asset and its evalauted results by ID | get | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get collection asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get collection resource metadata URL link | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Recommendation Resources
Task | Method | Path |
---|---|---|
Get the items for a given recommendation | get | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Segments resource | get | /resources/v1/engage/segments |
Get recommendation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get recommendation resource metadata URL link | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Search Resources
Task | Method | Path |
---|---|---|
Get search resource metadata | get | /resources/v1/metadata-catalog/search/assets |
Get site name based search resource metadata | get | /resources/v1/metadata-catalog/search/sites/{siteName}/assets |
Get asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/types/{assetType}/assets |
Get site name and asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets |
Search all assets | get | /resources/v1/search/assets |
Search assets in a given site | get | /resources/v1/search/sites/{siteName}/assets |
Search assets in a site by asset type | get | /resources/v1/search/sites/{siteName}/types/{assetType}/assets |
Search assets by asset type | get | /resources/v1/search/types/{assetType}/assets |
Get the search resource metadata URL link | /resources/v1/search/assets | |
Get search in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/assets | |
Get search by asset type in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/types/{assetType}/assets | |
Get search by an asset type resource metadata URL link | /resources/v1/search/types/{assetType}/assets |
Version Resources
Task | Method | Path |
---|---|---|
Get all the versions of the REST API | get | /resources |
Get all the REST resources for a version | get | /resources/{version} |
Get the metadata links for all REST resources in a given version | get | /resources/{version}/metadata-catalog |
Task | Method | Path |
---|---|---|
Get all the versions of the REST API | get | /resources |
Get the items for a given recommendation | get | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get the navigation for a site | get | /resources/v1/aggregates/{siteName}/navigation |
Get the navigation by node identifier | get | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} |
Read an asset by ID, type, and site along with its dependent assets in an aggregated format | get | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} |
Get the collection asset and its evalauted results by ID | get | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Segments resource | get | /resources/v1/engage/segments |
Get recommendation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items |
Get navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation |
Get node ID based on navigation resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier} |
Get asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId} |
Get collection asset resource metadata | get | /resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items |
Get search resource metadata | get | /resources/v1/metadata-catalog/search/assets |
Get site name based search resource metadata | get | /resources/v1/metadata-catalog/search/sites/{siteName}/assets |
Get asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/types/{assetType}/assets |
Get site name and asset type based search resource metadata | get | /resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets |
Search all assets | get | /resources/v1/search/assets |
Search assets in a given site | get | /resources/v1/search/sites/{siteName}/assets |
Search assets in a site by asset type | get | /resources/v1/search/sites/{siteName}/types/{assetType}/assets |
Search assets by asset type | get | /resources/v1/search/types/{assetType}/assets |
Get all the REST resources for a version | get | /resources/{version} |
Get the metadata links for all REST resources in a given version | get | /resources/{version}/metadata-catalog |
Get recommendation resource metadata URL link | /resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items | |
Get navigation resource metadata URL link | /resources/v1/aggregates/{siteName}/navigation | |
Get navigation by nodeIdentifier resource metadata URL Link by node identifier | /resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier} | |
Get asset resource metadata URL link. | /resources/v1/aggregates/{siteName}/{assetType}/{assetId} | |
Get collection resource metadata URL link | /resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items | |
Get the search resource metadata URL link | /resources/v1/search/assets | |
Get search in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/assets | |
Get search by asset type in a site resource metadata URL link | /resources/v1/search/sites/{siteName}/types/{assetType}/assets | |
Get search by an asset type resource metadata URL link | /resources/v1/search/types/{assetType}/assets |