{
"swagger":"2.0",
"info":{
"title":"Aggregate REST API Reference for Oracle WebCenter Sites",
"description":"WebCenter Sites Aggregate REST API enables you to access WebCenter Sites content in an aggregated fashion",
"version":"2015.08.31",
"x-summary":"WebCenter Sites Aggregate REST API enables you to access WebCenter Sites content in an aggregated fashion"
},
"schemes":[
"http",
"https"
],
"paths":{
"/resources/v1/search/assets":{
"get":{
"summary":"Search all assets",
"description":"The resource endpoint returns the list of all assets in sites.
It is a Collection Resource.
Note: To access this resource, at least one of the search criteria should be specified.\n",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"field:[fieldname]:[operation]",
"in":"query",
"description":"Specify a query condition for a field of [fieldname] with the specified operation. [Operation] is optional and can be one of equals, range, startswith, phrase, wildcard, similar, or contains; the default is contains. For the range operation, the value's format is {lower bound}:{upper bound}; for example, 1:10.\n",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"Specify the starting index from where the results will be returned.",
"type":"number"
},
{
"name":"limit",
"in":"query",
"description":"Specify the total number of items to be returned.",
"type":"number"
},
{
"name":"searchengine",
"in":"query",
"description":"Specify what search engine to use to find the results. The default search engine is Lucene.",
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specify the field on which the results should be sorted.
Usage: orderBy=[fieldname]:[asc/des].
Note: For Lucene, sorting is possible only for fields that were indexed as \"not tokenized\".",
"type":"string"
},
{
"name":"countonly",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays only the count, and no results are returned. The default is false.\n",
"type":"boolean"
},
{
"name":"totalResults",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.\n",
"type":"boolean"
},
{
"name":"fields",
"in":"query",
"description":"Accepts a comma-separated list of attribute names for each search result. By default only name and description are given for each search result. \n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"Specify a query string, the search engine-specific query that was specified during the configuration. (The default search engine is Lucene.)\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"List of all assets"
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-assets-get"
},
"options":{
"summary":"Get the search resource metadata URL link",
"description":"The resource endpoint returns a link to the search resource metadata URL in the response header.\n",
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-assets-options"
}
},
"/resources/v1/search/types/{assetType}/assets":{
"get":{
"summary":"Search assets by asset type",
"description":"The resource endpoint returns the list of all assets based on a given asset type.
It is a Collection Resource.\n",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"assetType",
"in":"path",
"required":true,
"description":"Asset type",
"type":"string"
},
{
"name":"field:[fieldname]:[operation]",
"in":"query",
"description":"Specify a query condition for a field of [fieldname] with the specified operation. [Operation] is optional and can be one of equals, range, startswith, phrase, wildcard, similar, or contains; the default is contains. For the range operation, the value's format is {lower bound}:{upper bound}; for example, 1:10.\n",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"Specify the starting index from where the results will be returned.",
"type":"number"
},
{
"name":"limit",
"in":"query",
"description":"Specify the total number of items to be returned.",
"type":"number"
},
{
"name":"searchengine",
"in":"query",
"description":"Specify what search engine to use to find the results. The default search engine is Lucene.",
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specify the field on which the results should be sorted.
Usage: orderBy=[fieldname]:[asc/des].
Note: For Lucene, sorting is possible only for fields that were indexed as \"not tokenized\".",
"type":"string"
},
{
"name":"countonly",
"in":"query",
"description":"Accepts a Boolean value. Setting it true displays only the count, and no results are returned. The default is false.\n",
"type":"boolean"
},
{
"name":"totalResults",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.\n",
"type":"boolean"
},
{
"name":"fields",
"in":"query",
"description":"Accepts a comma-separated list of attribute names for each search result. By default only name and description are given for each search result. \n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"Specify a query string, the search engine-specific query that was specified during the configuration. (The default search engine is Lucene.)\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"List of all assets based on asset type"
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-types-{assetType}-assets-get"
},
"options":{
"summary":"Get search by an asset type resource metadata URL link",
"description":"The resource endpoint returns a link to the search resource metadata URL in the response header.\n",
"parameters":[
{
"name":"assetType",
"in":"path",
"required":true,
"description":"Asset type",
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-types-{assetType}-assets-options"
}
},
"/resources/v1/search/sites/{siteName}/assets":{
"get":{
"summary":"Search assets in a given site",
"description":"The resource endpoint returns the list of all assets in a site.
It is a Collection Resource.\n",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"field:[fieldname]:[operation]",
"in":"query",
"description":"Specify a query condition for a field of [fieldname] with the specified operation. [Operation] is optional and can be one of equals, range, startswith, phrase, wildcard, similar, or contains; the default is contains. For the range operation, the value's format is {lower bound}:{upper bound}; for example, 1:10.\n",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"Specify the starting index from where the results will be returned.",
"type":"number"
},
{
"name":"limit",
"in":"query",
"description":"Specify the total number of items to be returned.",
"type":"number"
},
{
"name":"searchengine",
"in":"query",
"description":"Specify what search engine to use to find the results. the default search engine is Lucene.",
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specify the field on which the results should be sorted.
Usage: orderBy=[fieldname]:[asc/des].
Note: For Lucene, sorting is possible only for fields that were indexed as \"not tokenized\".",
"type":"string"
},
{
"name":"countonly",
"in":"query",
"description":"Accepts a Boolean value. Setting it true displays only the count, and no results are returned. The default is false.\n",
"type":"boolean"
},
{
"name":"totalResults",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.\n",
"type":"boolean"
},
{
"name":"fields",
"in":"query",
"description":"Accepts a comma-separated list of attribute names for each search result. By default only name and description are given for each search result. \n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"Specify a query string, the search engine-specific query that was specified during the configuration. (The default search engine is Lucene.)\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"List of all assets in a site."
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-sites-{siteName}-assets-get"
},
"options":{
"summary":"Get search in a site resource metadata URL link",
"description":"The resource endpoint returns a link to the search resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-sites-{siteName}-assets-options"
}
},
"/resources/v1/search/sites/{siteName}/types/{assetType}/assets":{
"get":{
"summary":"Search assets in a site by asset type",
"description":"The resource endpoint returns the list of all assets in a site based on asset type.
It is a Collection Resource.\n",
"produces":[
"application/json",
"application/xml"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"assetType",
"in":"path",
"required":true,
"description":"Asset type",
"type":"string"
},
{
"name":"field:[fieldname]:[operation]",
"in":"query",
"description":"Specify a query condition for a field of [fieldname] with the specified operation. [Operation] is optional and can be one of equals, range, startswith, phrase, wildcard, similar, or contains; the default is contains. For the range operation, the value's format is {lower bound}:{upper bound}; for example, 1:10.\n",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"Specify the starting index from where the results will be returned.",
"type":"number"
},
{
"name":"limit",
"in":"query",
"description":"Specify the total number of items to be returned.",
"type":"number"
},
{
"name":"searchengine",
"in":"query",
"description":"Specify what search engine to use to find the results. The default search engine is Lucene.",
"type":"string"
},
{
"name":"orderBy",
"in":"query",
"description":"Specify the field on which the results should be sorted.
Usage: orderBy=[fieldname]:[asc/des].
Note: For Lucene, sorting is possible only for fields that were indexed as \"not tokenized\".",
"type":"string"
},
{
"name":"countonly",
"in":"query",
"description":"Accepts a Boolean value. Setting it true displays only the count, and no results are returned. The default is false.\n",
"type":"boolean"
},
{
"name":"totalResults",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.\n",
"type":"boolean"
},
{
"name":"fields",
"in":"query",
"description":"Accepts a comma-separated list of attribute names for each search result. By default only name and description are given for each search result. \n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).",
"type":"string"
},
{
"name":"q",
"in":"query",
"description":"Specify a query string, the search engine-specific query that was specified during the configuration. (The default search engine is Lucene.)\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"List of all assets in a site based on asset type"
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-sites-{siteName}-types-{assetType}-assets-get"
},
"options":{
"summary":"Get search by asset type in a site resource metadata URL link",
"description":"The resource endpoint returns a link to the search resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"assetType",
"in":"path",
"required":true,
"description":"Asset type",
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-search-sites-{siteName}-types-{assetType}-assets-options"
}
},
"/resources/v1/metadata-catalog/search/assets":{
"get":{
"summary":"Get search resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the search resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of the search resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"responses":{
"200":{
"description":"Resource metadata."
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-search-assets-get"
}
},
"/resources/v1/metadata-catalog/search/types/{assetType}/assets":{
"get":{
"summary":"Get asset type based search resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the search resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of the search resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"assetType",
"in":"path",
"required":true,
"description":"Asset type",
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata"
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-search-types-{assetType}-assets-get"
}
},
"/resources/v1/metadata-catalog/search/sites/{siteName}/assets":{
"get":{
"summary":"Get site name based search resource metadata",
"description":"The resource endpoint returns a description of the resource, including the resource name, a link to the json schema of the resource, and a link to the search resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of the search resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata"
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-search-sites-{siteName}-assets-get"
}
},
"/resources/v1/metadata-catalog/search/{siteName}/types/{assetType}/assets":{
"get":{
"summary":"Get site name and asset type based search resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the search resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of the search resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"assetType",
"in":"path",
"required":true,
"description":"Asset type",
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata"
}
},
"tags":[
"Search Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-search-{siteName}-types-{assetType}-assets-get"
}
},
"/resources/v1/aggregates/{siteName}/navigation":{
"get":{
"summary":"Get the navigation for a site",
"description":"The resource endpoint returns the navigation data for a given site name.
Important Note: It is a Singular Resource. The response is in an aggregated asset format (refer to note in Asset Resource end point). It is similar to Asset Resource end point except in addition to asset info, it also gives navigation data. So all the aggregate asset query params (assetDepth, expand, fields, segments, profileName) are also applicable to this resource. All the navigation data (child nodes w.r.t navigation) is available in the 'children' array in the response. Each child is again an aggregated asset. The given aggregate asset query params are also applied to each child in the children array.\n",
"produces":[
"application/json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"navigationDepth",
"in":"query",
"description":"Accepts any positive integer or the string \"all\". The navigation depth\nas an integer defines the children level to which to traverse the site navigation.\nThe string \"all\" refers to the full depth. The default value is 2. In case of an\ninvalid navigationDepth value (negative number), the default navigationDepth\nvalue is used. The children of a node are available in a children array. This\nchildren attribute cannot be filtered out. Each children item is again\naggregated, and all the query parameters of the aggregated asset are applicable to each\nitem.\n",
"type":"number"
},
{
"name":"code",
"in":"query",
"description":"Accepts a comma-separated list of site node types. Determines whether placed or unplaced children nodes (pages) under a publication (site) are to be returned. The default node type is placed.
Usage:- \"code=unplaced\". It means to include only unplaced children in the response
- \"code=placed,unplaced\". It means to include both placed and unplaced children in the response.
\n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this\nparameter gives all the links (schema, self, and canonical resources).\n",
"type":"string"
},
{
"name":"assetDepth",
"in":"query",
"description":"To know about this parameter, refer to the 'assetDepth' query param in Asset Resource. Applicable to each child in the children array also. \n",
"type":"number"
},
{
"name":"expand",
"in":"query",
"description":"Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource. Applicable to each child in the children array also. \n",
"type":"string"
},
{
"name":"fields",
"in":"query",
"description":"To know about this parameter, refer to the 'fields' query param in Asset Resource. Applicable to each child in the children array also.\nThe 'children' array cannot be filtered out from the response.\n",
"type":"string"
},
{
"name":"segments",
"in":"query",
"description":"To know about this parameter, refer to the 'segments' query param in Asset Resource. Applicable to each child in the children array also.\n",
"type":"string"
},
{
"name":"profileName",
"in":"query",
"description":"To know about this parameter, refer to the 'profileName' query param in Asset Resource. Applicable to each child in the children array also.\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"Site navigation data in aggregated format"
}
},
"tags":[
"Navigation Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-navigation-get"
},
"options":{
"summary":"Get navigation resource metadata URL link",
"description":"The resource endpoint returns a link to the navigation resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Navigation Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-navigation-options"
}
},
"/resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier}":{
"get":{
"summary":"Get the navigation by node identifier",
"description":"The resource endpoint returns the navigation data for a given node identifier in a site name.
Important Note: It is a Singular Resource. The response is in an aggregated asset format (refer to the note in Asset Resource end point). It is similar to Asset Resource end point except in addition to asset info, it also gives navigation data. So all the aggregate asset query params (assetDepth, expand, fields, segments, profileName) are also applicable to this resource. All the navigation data (child nodes w.r.t navigation) is available in the 'children' array in the response. Each child is again an aggregated asset. The given aggregate asset query params are also applied to each child in the children array.\n",
"produces":[
"application/json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"nodeIdentifier",
"in":"path",
"description":"Site node ID or the site navigation name",
"required":true,
"type":"integer",
"format":"double"
},
{
"name":"navigationDepth",
"in":"query",
"description":"Accepts any positive integer or the string \"all\". The navigation depth\nas an integer defines the children level to which to traverse the site navigation.\nThe string \"all\" refers to the full depth. The default value is 2. In case of an\ninvalid navigationDepth value (negative number), the default navigationDepth\nvalue is used. The children of a node are available in a children array. This\nchildren attribute cannot be filtered out. Each children item is again\naggregated, and all the query parameters of the aggregated asset are applicable to each\nitem.\n",
"type":"number"
},
{
"name":"code",
"in":"query",
"description":"Accepts a comma-separated list of site node types. Determines whether placed or unplaced children nodes (pages) under a publication are to be returned. The default node type is placed. This is applicable only for a publication node (that is, nodeIdentifier is a publication ID).
Usage:- \"code=unplaced\". It means to include only unplaced children in the response.
- \"code=placed,unplaced\". It means to include both placed and unplaced children in the response.
\n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this\nparameter gives all the links (schema, self, and canonical resources).\n",
"type":"string"
},
{
"name":"assetDepth",
"in":"query",
"description":"To know about this parameter, refer to the 'assetDepth' query param in Asset Resource. Applicable to each child in the children array also. \n",
"type":"number"
},
{
"name":"expand",
"in":"query",
"description":"Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource. Applicable to each child in the children array also. \n",
"type":"string"
},
{
"name":"fields",
"in":"query",
"description":"To know about this parameter, refer to the 'fields' query param in Asset Resource. Applicable to each child in the children array also.\nThe 'children' array cannot be filtered out from the response.\n",
"type":"string"
},
{
"name":"segments",
"in":"query",
"description":"To know about this parameter, refer to the 'segments' query param in Asset Resource. Applicable to each child in the children array also.\n",
"type":"string"
},
{
"name":"profileName",
"in":"query",
"description":"To know about this parameter, refer to the 'profileName' query param in Asset Resource. Applicable to each child in the children array also.\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"Site navigation data in aggregated format"
}
},
"tags":[
"Navigation Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-navigation-{nodeIdentifier}-get"
},
"options":{
"summary":"Get navigation by nodeIdentifier resource metadata URL Link by node identifier",
"description":"The resource endpoint returns a link to the navigation resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"nodeIdentifier",
"in":"path",
"description":"Site node ID or the site navigation name",
"required":true,
"type":"integer",
"format":"double"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Navigation Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-navigation-{nodeIdentifier}-options"
}
},
"/resources/v1/metadata-catalog/aggregates/{siteName}/navigation":{
"get":{
"summary":"Get navigation resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the navigation resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\".\n\nNote: This is the metadata URL returned from an OPTIONS request of the navigation resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata."
}
},
"tags":[
"Navigation Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-aggregates-{siteName}-navigation-get"
}
},
"/resources/v1/metadata-catalog/aggregates/{siteName}/navigation/{nodeIdentifier}":{
"get":{
"summary":"Get node ID based on navigation resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to navigation resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\".\n\nNote: This is the metadata URL returned from an OPTIONS request of the navigation resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"nodeIdentifier",
"in":"path",
"description":"Site node ID or the site navigation name",
"required":true,
"type":"integer",
"format":"double"
}
],
"responses":{
"200":{
"description":"Resource metadata."
}
},
"tags":[
"Navigation Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-aggregates-{siteName}-navigation-{nodeIdentifier}-get"
}
},
"/resources/v1/aggregates/{siteName}/{assetType}/{assetId}":{
"get":{
"summary":"Read an asset by ID, type, and site along with its dependent assets in an aggregated format",
"description":"The resource endpoint returns information about any given asset, along with its dependent assets to any depth,\nbelonging to a given site name. It is a Singular Resource.
\nImportant Note: The response is in an aggregated asset format. All the aggregated asset responses contain a 'start' field. The 'root asset' referred to below is the asset to which the value of 'start' key points in the response. This asset is the starting asset at level 0 (requested asset, here {assetId}). We have to navigate through all dependent assets at the next levels in the response through this root asset.
\nSpecial Case : If the root asset or any dependent asset at any depth is of\nthe collection asset type, such as ContentQuery or Recommendation, then in\naddition to asset data, results are also evaluated for the collection asset and given\nin the items array. The default number of results is 10. Each item is again an\naggregated asset, and the query parameters are also applicable to it. WebCenter Sites Aggregate REST API recommends that you access collection resources through collection-asset-resource and recommendation assets through recommendation-resource because you have the ability to control the number of results and pagination. \n",
"produces":[
"application/json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"assetType",
"in":"path",
"description":"Name of the asset type",
"required":true,
"type":"string"
},
{
"name":"assetId",
"in":"path",
"description":"ID of the asset",
"required":true,
"type":"integer",
"format":"int64"
},
{
"name":"assetDepth",
"in":"query",
"description":"Accepts any positive integer or the string \"all\". The asset depth as an\ninteger defines the tree level to which to traverse dependent assets. The\nstring \"all\" refers to the full depth. The default value is 2. In case of an invalid\nassetDepth value (negative number), the default assetDepth value is used.\n",
"type":"string"
},
{
"name":"expand",
"in":"query",
"description":"This is used to control what asset types to expand in the response. Accepts a semicolon-separated list of asset types. The assets of these asset types will be expanded. Other asset types will not be\nexpanded. However, the root asset (ref: note in resoure description) is always expanded. The default is to expand all asset types. Placing the NOT operator (!) before an asset type in the list indicates to\nexclude that asset type from the expansion.
\nFor example:\n - expand=assetType1,assetType2. means expand only assets of 'assetType1' and 'assetType2'.
\n - expand=!assetType1,!assetType2.means expand all assets except the assets of 'assetType1' and 'assetType2'.
\n",
"type":"string"
},
{
"name":"fields",
"in":"query",
"description":"This is used to control what attributes to return for an AssetType in the response. This query param works only if any asset of this assetType occurs within the given depth and that assetType is allowed to expand. Accepts a list of attributes, separated by commas, for an asset type in\nthe format assetType1(attr1,attr2). It means to give only attr1 and attr2 for\nassetType1. If no asset type is specified, the attributes in the fields parameter\nare applicable only to the root asset (ref: note in resoure description). If the fields query parameter is not\nspecified, then by default all attributes are given. This parameter can include\nwildcards, as follows
\n\n - fields=*(attr1,attr2) gives only attr1 and attr2 for all asset types.
\n - fields=!*(attr1,attr2,attr3) gives all attributes excluding att1, attr2, and attr3 for all asset types.
\n - fields=!attr1,attr2 gives all attributes excluding attr1 and attr2 for the root asset.
\n
\n",
"type":"string"
},
{
"name":"segments",
"in":"query",
"description":"Accepts a list of segment names, separated by commas, that exist in the\nsites. These segments will be applied to the recommendation assets encountered at\nany depth to evaluate the results. If segments are not specified, then this\nparameter uses the Default segment.\n",
"type":"string"
},
{
"name":"profileName",
"in":"query",
"description":"Accepts a Visitor Services profile name. This profileName will be applied to the recommendation assets encountered at any depth to evaluate the results. \n",
"type":"string"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this\nparameter gives all the links (schema, self, and canonical resources).\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"An asset's data in aggregated format"
}
},
"tags":[
"Asset Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-{assetType}-{assetId}-get"
},
"options":{
"summary":"Get asset resource metadata URL link.",
"description":"The resource endpoint returns a link to the asset resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"assetType",
"in":"path",
"description":"Name of the asset type",
"required":true,
"type":"string"
},
{
"name":"assetId",
"in":"path",
"description":"ID of the asset",
"required":true,
"type":"integer",
"format":"int64"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Asset Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-{assetType}-{assetId}-options"
}
},
"/resources/v1/metadata-catalog/aggregates/{siteName}/{assetType}/{assetId}":{
"get":{
"summary":"Get asset resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the asset resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of an asset resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"required":true,
"description":"Name of the site",
"type":"string"
},
{
"name":"assetType",
"in":"path",
"description":"Name of the asset type",
"required":true,
"type":"string"
},
{
"name":"assetId",
"in":"path",
"description":"ID of the asset",
"required":true,
"type":"integer",
"format":"int64"
}
],
"responses":{
"200":{
"description":"Resource metadata."
}
},
"tags":[
"Asset Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-aggregates-{siteName}-{assetType}-{assetId}-get"
}
},
"/resources/v1/aggregates/{siteName}/{collectionAssetType}/{assetId}/items":{
"get":{
"summary":"Get the collection asset and its evalauted results by ID",
"description":"The resource endpoint returns the evalauted results in aggregated form for a given collection asset\nbelonging to a given site name.
Important Note: It is a Collection Resource. All the evaluated results for the given collection asset are available in an items array in response. Each result is again an aggregated asset. So all the aggregate asset query params (assetDepth, expand, fields, segments, profileName) are also applicable to this resource. These aggregate asset query params are applied to each result in the items array. To know more about an aggregate asset and its query params, refer to Asset Resource end point.\n",
"produces":[
"application/json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"collectionAssetType",
"in":"path",
"description":"Name of the collection asset type",
"required":true,
"type":"string"
},
{
"name":"assetId",
"in":"path",
"description":"ID of the collection asset",
"required":true,
"type":"integer",
"format":"double"
},
{
"name":"offset",
"in":"query",
"description":"Specify the starting index from where the results will be returned.",
"type":"number"
},
{
"name":"limit",
"in":"query",
"description":"Specify the total number of items to be returned.",
"type":"number"
},
{
"name":"totalResults",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.\n",
"type":"boolean"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).",
"type":"string"
},
{
"name":"assetDepth",
"in":"query",
"description":"To know about this parameter, refer to the 'assetDepth' query param in Asset Resource end point. Applicable to each result in the items array. \n",
"type":"number"
},
{
"name":"fields",
"in":"query",
"description":"To know about this parameter, refer to the 'fields' query param in Asset Resource end point. Applicable to each result in the items array. \n",
"type":"string"
},
{
"name":"expand",
"in":"query",
"description":"Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource end point. Applicable to each result in the items array. \n",
"type":"string"
},
{
"name":"segments",
"in":"query",
"description":"To know about this refer to the 'segments' query param in Asset Resource. Applicable to each result in the items array.\n",
"type":"string"
},
{
"name":"profileName",
"in":"query",
"description":"To know about this parameter, refer to the 'profileName' query param in Asset Resource. Applicable to each result in the items array.\n",
"type":"string"
}
],
"responses":{
"200":{
"description":"Collection asset results in aggregated format."
}
},
"tags":[
"Collection Asset Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-{collectionAssetType}-{assetId}-items-get"
},
"options":{
"summary":"Get collection resource metadata URL link",
"description":"The resource endpoint returns a link to the collection resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"collectionAssetType",
"in":"path",
"description":"Name of the collection asset type",
"required":true,
"type":"string"
},
{
"name":"assetId",
"in":"path",
"description":"ID of the collection asset",
"required":true,
"type":"integer",
"format":"double"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Collection Asset Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-{collectionAssetType}-{assetId}-items-options"
}
},
"/resources/v1/metadata-catalog/aggregates/{siteName}/{collectionAssetType}/{assetId}/items":{
"get":{
"summary":"Get collection asset resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the collection asset resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of the collection asset resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"collectionAssetType",
"in":"path",
"description":"Name of the collection asset type",
"required":true,
"type":"string"
},
{
"name":"assetId",
"in":"path",
"description":"ID of the collection asset",
"required":true,
"type":"integer",
"format":"double"
}
],
"responses":{
"200":{
"description":"Resource metadata."
}
},
"tags":[
"Collection Asset Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-aggregates-{siteName}-{collectionAssetType}-{assetId}-items-get"
}
},
"/resources/v1/aggregates/{siteName}/engage/recommendation/{recommendationName}/items":{
"get":{
"summary":"Get the items for a given recommendation",
"description":"The resource endpoint returns the aggregated results for a given recommendation asset\nbelonging to a given site name.
Important Note: It is a Collection Resource. All the recommended assets for the given recommendation name are available in an items array in the response. Each result is again an aggregated asset. So all the aggregate asset query params (assetDepth, expand, fields) are also applicable to this resource. These aggregate asset query params are applied to each result in the items array. To know more about aggregate asset query params, refer to Asset Resource end point.\n",
"produces":[
"application/json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"recommendationName",
"in":"path",
"description":"Name of the recommendation",
"required":true,
"type":"string"
},
{
"name":"visitorid",
"in":"query",
"description":"Visitor ID based on which recommendations are evaluated",
"type":"number"
},
{
"name":"segments",
"in":"query",
"description":"Accepts comma-separated segment names based on which recommendations are evaluated.",
"type":"string"
},
{
"name":"profileName",
"in":"query",
"description":"SitesVisitorService profile name based on which recommendations are evaluated",
"type":"string"
},
{
"name":"offset",
"in":"query",
"description":"Specify the starting index from where the results will be returned.",
"type":"number"
},
{
"name":"limit",
"in":"query",
"description":"Specify the total number of items to be returned.",
"type":"number"
},
{
"name":"totalResults",
"in":"query",
"description":"Accepts a Boolean value. Setting it to true displays the total results field in the response. The default is false.\n",
"type":"boolean"
},
{
"name":"links",
"in":"query",
"description":"Accepts a comma-separated list of link names. By default, this parameter gives all the links (next, prev, first, last, schema, self, and canonical resources).",
"type":"string"
},
{
"name":"assetDepth",
"in":"query",
"description":"To know about this parameter, refer to the 'assetDepth' query param in Asset Resource end point. Applicable to each result in the items array. \n",
"type":"number"
},
{
"name":"fields",
"in":"query",
"description":"To know about this parameter, refer to the 'fields' query param in Asset Resource end point. Applicable to each result in the items array. \n",
"type":"string"
},
{
"name":"expand",
"in":"query",
"description":"Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource end point. Applicable to each result in the items array. \n",
"type":"string"
}
],
"responses":{
"200":{
"description":"Recommendation asset results in aggregated format"
}
},
"tags":[
"Recommendation Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-engage-recommendation-{recommendationName}-items-get"
},
"options":{
"summary":"Get recommendation resource metadata URL link",
"description":"The resource endpoint returns a link to the recommendation resource metadata URL in the response header.\n",
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"recommendationName",
"in":"path",
"description":"Name of the recommendation",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata URL in the response header with rel as \"describedby\""
}
},
"tags":[
"Recommendation Resources"
],
"x-internal-id":"resources-v1-aggregates-{siteName}-engage-recommendation-{recommendationName}-items-options"
}
},
"/resources/v1/metadata-catalog/aggregates/{siteName}/engage/recommendation/{recommendationName}/items":{
"get":{
"summary":"Get recommendation resource metadata",
"description":"The resource endpoint returns description of the resource, including the resource name, a link to the json schema of the resource, and a link to the recommendation resource instance when requested with \"application/json\". When requested with \"application/schema+json\", the json schema of the resource is returned. The default is \"application/json\". \n\nNote: This is the metadata URL returned from an OPTIONS request of the recommendation resource instance.\n",
"produces":[
"application/json",
"application/schema+json"
],
"parameters":[
{
"name":"siteName",
"in":"path",
"description":"Name of the site",
"required":true,
"type":"string"
},
{
"name":"recommendationName",
"in":"path",
"description":"Name of the recommendation",
"required":true,
"type":"string"
}
],
"responses":{
"200":{
"description":"Resource metadata."
}
},
"tags":[
"Recommendation Resources"
],
"x-internal-id":"resources-v1-metadata-catalog-aggregates-{siteName}-engage-recommendation-{recommendationName}-items-get"
}
},
"/resources/v1/engage/segments":{
"get":{
"summary":"Segments resource",
"description":"The Segments resource fetches segments for a given visitor ID, visitor attributes, or\nVisitor Services profile name, in the following format. This resource is mainly used by a site developer\nto know the segments.\n",
"parameters":[
{
"name":"visitor.{attribute}",
"in":"query",
"description":"Name of the visitor attribute on the basis of which the segments are evaluated. You can submit multiple visitor attributes by - visitor.att1=\"value1\"&visitor.attr2=\"value2\".",
"type":"string"
},
{
"name":"visitorid",
"in":"query",
"description":"ID of the site visitor based on which segments are evaluated",
"type":"number"
},
{
"name":"profileName",
"description":"Name of the Visitor Services profile based on which segments are evaluated",
"type":"string",
"in":"query"
}
],
"responses":{
"200":{
"description":"List of segments."
}
},
"tags":[
"Recommendation Resources"
],
"x-internal-id":"resources-v1-engage-segments-get"
}
},
"/resources":{
"get":{
"summary":"Get all the versions of the REST API",
"description":"This resource fetches all the REST versions along with their REST end points supported by WebCenter \nSites. It is a Collection Resource.\n",
"responses":{
"200":{
"description":"List of all versions of the REST API along with thier REST endpoints"
}
},
"tags":[
"Version Resources"
],
"x-internal-id":"resources-get"
}
},
"/resources/{version}":{
"get":{
"summary":"Get all the REST resources for a version",
"description":"This resource fetches all the REST resources for a given version \nsupported by WebCenter Sites. It is a Singular Resource.\n",
"parameters":[
{
"name":"version",
"in":"path",
"required":true,
"type":"string",
"description":"Version of the WebCenter Sites REST API"
}
],
"responses":{
"200":{
"description":"List of all rest endpoints in a given version"
}
},
"tags":[
"Version Resources"
],
"x-internal-id":"resources-{version}-get"
}
},
"/resources/{version}/metadata-catalog":{
"get":{
"summary":"Get the metadata links for all REST resources in a given version",
"description":"This resource fetches all the metadata links for all the REST \nresources for a given version supported by WebCenter Sites. \nIt is a Collection Resource.\n",
"parameters":[
{
"name":"version",
"in":"path",
"required":true,
"type":"string",
"description":"Version of the WebCenter Sites REST API"
}
],
"responses":{
"200":{
"description":"Metadata info for all REST resources in a given version"
}
},
"tags":[
"Version Resources"
],
"x-internal-id":"resources-{version}-metadata-catalog-get"
}
}
},
"tags":[
{
"name":"Asset Resources",
"description":"Get aggregate asset data, resource metadata",
"x-priority":60
},
{
"name":"Navigation Resources",
"description":"Get aggregate navigation data, resource metadata",
"x-priority":50
},
{
"name":"Collection Asset Resources",
"description":"Get aggregate collection asset data, resource metadata",
"x-priority":40
},
{
"name":"Recommendation Resources",
"description":"Get aggregate recommendation asset data, segments, resource metadata",
"x-priority":30
},
{
"name":"Search Resources",
"description":"Search assets by site, asset type. Get resource metadata",
"x-priority":20
},
{
"name":"Version Resources",
"description":"Get all versions, resources in a version, metadata resources in a version",
"x-priority":10
}
]
}