BusinessObjects

Operations for BusinessObjects

Task	Method	Path
Get Business Object details given its short ID	get	/v1/portal/businessobjects/{id}
Query for Business Objects	get	/v1/portal/businessobjects

CMIS

Operations for CMIS

Task	Method	Path
Creates or moves a child object in the specified repository	post	/cmis/children{repositoryId}
Creates the content stream for the specified object	post	/cmis/stream{repositoryId}
Deletes a document from the specified repository	delete	/cmis/document{repositoryId}
Deletes a document from the specified repository using POST	post	/cmis/document{repositoryId}
Deletes a folder from the specified repository	delete	/cmis/folder{repositoryId}
Deletes a folder from the specified repository using POST	post	/cmis/folder{repositoryId}
Deletes the children of the specified folder	delete	/cmis/descendants{repositoryId}
Get nested properties	get	/cmis/nestedProperties{repositoryId}
Gets the content stream for the specified object	get	/cmis/stream{repositoryId}
Gets the list of allowable actions for the specified object	get	/cmis/allowableActions{repositoryId}
Gets the list of child objects for the specified repository	get	/cmis/children{repositoryId}
Gets the list of properties of a folder	get	/cmis/folder{repositoryId}
Gets the parent for the specified node	get	/cmis/parents{repositoryId}
Gets the specified object by ID	get	/cmis/objectbyid
Gets the specified object by path	get	/cmis/objectbypath{repositoryId}
Gets the type definitions for the specified repository	get	/cmis/typebyid{repositoryId}
Gets the type definitions of specified repository	get	/cmis/type{repositoryId}
Queries a service document for the specified repository	get	/cmis/query/q{repositoryId}
Queries a service document for the specified repository using POST	post	/cmis/query{repositoryId}
Retrieves the properties of document	get	/cmis/document{repositoryId}
Returns a list of available CMIS repositories	get	/cmis/repository
Returns information about a CMIS repository	get	/cmis/repository{repositoryId}
Returns the list of object types defined for the specified repository	get	/cmis/typesChildren{repositoryId}
Returns the nested properties of the specified object	get	/cmis/nestedProperty{repositoryId}
Returns the set of descendant object types defined for the specified repository	get	/cmis/typesDescendants{repositoryId}
Sets the content stream for the specified object	put	/cmis/stream{repositoryId}
Updates the properties of a document	put	/cmis/document{repositoryId}
Updates the properties of a folder	put	/cmis/folder{repositoryId}

DPTaskflows

Operations for DPTaskflows

Task	Method	Path
Download DP TaskFlow to an EAR file	get	/v1/portal/dptaskflows/{id}/archive
Get DP TaskFlow details given its short ID	get	/v1/portal/dptaskflows/{id}
Query for DP TaskFlows	get	/v1/portal/dptaskflows
Upload DP TaskFlow metadata files (page and pageDef)	post	/v1/portal/dptaskflows

Layouts

Operations for Layouts

Task	Method	Path
Download layout to an EAR file	get	/v1/portal/layouts/{id}/archive
Get layout details given its short ID	get	/v1/portal/layouts/{id}
Query for Layouts	get	/v1/portal/layouts
Update layout given its short ID	put	/v1/portal/layouts/{id}
Upload Layout metadata file	post	/v1/portal/layouts

Lists

Operations for Lists

Task	Method	Path
Creates a new column in a lists	post	/spaces/{spacename}/lists/({listid: .+})/columns
Creates a new list	post	/spaces/{spacename}/lists
Creates a new row in a list	post	/spaces/{spacename}/lists/({id: .+})/rows
Deletes a column in a list	delete	/spaces/{spacename}/lists/({listid: .+})/columns/({columnid: .+})
Deletes a list	delete	/spaces/{spacename}/lists/({id: .+})
Deletes a row in a list	delete	/spaces/{spacename}/lists/({listid: .+})/rows/({rowid: .+})
Retrieves a column in a list	get	/spaces/{spacename}/lists/({listid: .+})/columns/({columnid: .+})
Retrieves a list by ID	get	/spaces/{spacename}/lists/({id: .+})
Retrieves a list by compound ID	get	/lists/({compoundId: .+})
Retrieves a row in a list	get	/spaces/{spacename}/lists/({listid: .+})/rows/({rowid: .+})
Retrieves all columns in a list	get	/spaces/{spacename}/lists/({listid: .+})/columns
Retrieves lists in a portal based on search criteria	get	/spaces/{spacename}/lists
Retrieves rows in a list based on search criteria	get	/spaces/{spacename}/lists/({id: .+})/rows
Updates a column in a list	put	/spaces/{spacename}/lists/({listid: .+})/columns/({columnid: .+})
Updates a list definition	put	/spaces/{spacename}/lists/({id: .+})
Updates a row in a list	put	/spaces/{spacename}/lists/({listid: .+})/rows/({rowid: .+})

NavigationNodes

Operations for NavigationNodes

Task	Method	Path
Add a child node in a specific position	post	/v1/portal/navigationnodes/{id}/childNodes/{toFollow}
Add a child node to a navigation node	post	/v1/portal/navigationnodes/{id}/childNodes
Add a page variant to a navigation node	post	/v1/portal/navigationnodes/{id}/pageVariants
Create a new navigation node	post	/v1/portal/navigationnodes
Get a child node	get	/v1/portal/navigationnodes/{id}/childNodes/{nodeId}
Get all child nodes for a navigation node given its shortID	get	/v1/portal/navigationnodes/{id}/childNodes
Get all page variants for a navigation node given its shortID	get	/v1/portal/navigationnodes/{id}/pageVariants
Get navigation node details given its short ID	get	/v1/portal/navigationnodes/{id}
Query for navigation nodes	get	/v1/portal/navigationnodes
Remove a child node	delete	/v1/portal/navigationnodes/{id}/childNodes/{nodeId}
Update a navigation node given its short ID	put	/v1/portal/navigationnodes/{id}

PageStyles

Operations for PageStyles

Task	Method	Path
Download page style to an EAR file	get	/v1/portal/pagestyles/{id}/archive
Get page style details given its short ID	get	/v1/portal/pagestyles/{id}
Get the content items for a given page style	get	/v1/portal/pagestyles/{id}/contentItems
Query for Page Styles	get	/v1/portal/pagestyles
Update page style given its short ID	put	/v1/portal/pagestyles/{id}
Upload Page Style metadata files (page and pageDef)	post	/v1/portal/pagestyles

PageTemplates

Operations for PageTemplates

Task	Method	Path
Create a new Page Template	post	/v1/portal/pagetemplates
Download Page Template to an EAR file	get	/v1/portal/pagetemplates/{id}/archive
Get Page Template details given its short ID	get	/v1/portal/pagetemplates/{id}
Query for Page Templates	get	/v1/portal/pagetemplates
Update Page Template given its short ID	put	/v1/portal/pagetemplates/{id}

Pages

Operations for Pages

Task	Method	Path
Create a new page	post	/v1/portal/pages
Get page details given its short ID	get	/v1/portal/pages{id}
Get the content items for a given page	get	/v1/portal/pages{id}/contentItems
Query for Pages	get	/v1/portal/pages
Update page given its short ID	put	/v1/portal/pages{id}

PortalTemplates

Operations about WebCenter Portal Templates

Task	Method	Path
Create a layout as a sub-resource of a portal template	post	/v1/portal/portaltemplates/{portalTemplateId}/layouts
Create a member as a sub-resource of a portal template	post	/v1/portal/portaltemplates/{portalTemplateId}/members
Create a navigation node as a sub-resource of a portal template	post	/v1/portal/portaltemplates/{portalTemplateId}/navigationnodes
Create a page style as a sub-resource of a portal template	post	/v1/portal/portaltemplates/{portalTemplateId}/pagestyles
Create page within a portal given its short ID	post	/v1/portal/portaltemplates/{portalTemplateId}/pages
Get portal template details given its short ID	get	/v1/portal/portaltemplates/{id}
Query for Data Presenter business objects as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/businessobjects
Query for Data Presenter taskflows as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/dptaskflows
Query for Page Styles as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/pagestyles
Query for REST DataServices as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/restdataservices
Query for Resource Catalogs as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/resourcecatalogs
Query for SQL DataServices as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/sqldataservices
Query for Skins as sub-resource of a portali template	get	/v1/portal/portaltemplates/{portalTemplateId}/skins
Query for content presenter templates as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/contentpresentertemplates
Query for layouts as sub-resource of a portali template	get	/v1/portal/portaltemplates/{portalTemplateId}/layouts
Query for members as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/members
Query for navigation nodes as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/navigationnodes
Query for page templates as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/pagetemplates
Query for pages as subresource of a portal template given its short ID	get	/v1/portal/portaltemplates/{portalTemplateId}/pages
Query for portal templates to export a portal template to a PAR file	get	/v1/portal/portaltemplates/{portalTemplateId}/archive
Query for portal templates to import data presenter taskflow(s) at portal template or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/dptaskflows
Query for portal templates to import page template(s) at portal or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/pagetemplates
Query for portal templates to import portal template(s) from a PAR file	post	/v1/portal/portaltemplates
Query for portal templates to import resource catalog(s) at portal template or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/resourcecatalogs
Query for portal templates to import taskflow(s) at portal template or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/taskflows
Query for portal templates; when search criteria is omitted, all portal templates will be returned.	get	/v1/portal/portaltemplates
Query for portals to import content presenter template(s) at portal template or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/contentpresentertemplates
Query for portals to import skin(s) at portal or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/skins
Query for portals to import visualization template(s) at portal template or shared level	post	/v1/portal/portaltemplates/{portalTemplateId}/visualizationtemplates
Query for taskflows as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/taskflows
Query for visualization templates as sub-resource of a portal template	get	/v1/portal/portaltemplates/{portalTemplateId}/visualizationtemplates
Update portal template given its short ID	put	/v1/portal/portaltemplates/{id}

Portals

Operations for Portals

Task	Method	Path
Create a member as a sub-resource of a portal	post	/v1/portal/portals/{portalId}/members
Create a navigation node as a sub-resource of a portal	post	/v1/portal/portals/{portalId}/navigationnodes
Create a page template as a sub-resource of a portal	post	/v1/portal/portals/{portalId}/pagetemplates
Create a taskflow as a sub-resource of a portal	post	/v1/portal/portals/{portalId}/taskflows
Create page within a portal given its short ID	post	/v1/portal/portals/{portalId}/pages
Get portal details given its short ID	get	/v1/portal/portals/{id}
Query for Data Presenter business objects as sub-resource of a portal	get	/v1/portal/portals/{portalId}/businessobjects
Query for Data Presenter taskflows as sub-resource of a portal	get	/v1/portal/portals/{portalId}/dptaskflows
Query for Page Styles as sub-resource of a portal	get	/v1/portal/portals/{portalId}/pagestyles
Query for REST DataServices as sub-resource of a portal	get	/v1/portal/portals/{portalId}/restdataservices
Query for Resource Catalogs as sub-resource of a portal	get	/v1/portal/portals/{portalId}/resourcecatalogs
Query for SQL DataServices as sub-resource of a portal	get	/v1/portal/portals/{portalId}/sqldataservices
Query for Skins as sub-resource of a portal	get	/v1/portal/portals/{portalId}/skins
Query for content presenter templates as sub-resource of a portal	get	/v1/portal/portals/{portalId}/contentpresentertemplates
Query for layouts as sub-resource of a portal	get	/v1/portal/portals/{portalId}/layouts
Query for members as sub-resource of a portal	get	/v1/portal/portals/{portalId}/members
Query for navigation nodes as sub-resource of a portal	get	/v1/portal/portals/{portalId}/navigationnodes
Query for page templates as sub-resource of a portal	get	/v1/portal/portals/{portalId}/pagetemplates
Query for pages as subresource of a portal given its short ID	get	/v1/portal/portals/{portalId}/pages
Query for portals to export a portal to a PAR file	get	/v1/portal/portals/{portalId}/archive
Query for portals to import content presenter template(s) at portal or shared level	post	/v1/portal/portals/{portalId}/contentpresentertemplates
Query for portals to import data presenter taskflow(s) at portal or shared level	post	/v1/portal/portals/{portalId}/dptaskflows
Query for portals to import layout(s) at portal or shared level	post	/v1/portal/portals/{portalId}/layouts
Query for portals to import page style(s) at portal or shared level	post	/v1/portal/portals/{portalId}/pagestyles
Query for portals to import portal(s) from a PAR file	post	/v1/portal/portals
Query for portals to import resource catalog(s) at portal or shared level	post	/v1/portal/portals/{portalId}/resourcecatalogs
Query for portals to import skin(s) at portal or shared level	post	/v1/portal/portals/{portalId}/skins
Query for portals to import visualization template(s) at portal or shared level	post	/v1/portal/portals/{portalId}/visualizationtemplates
Query for portals; when search criteria is omitted, all portals will be returned.	get	/v1/portal/portals
Query for taskflows as sub-resource of a portal	get	/v1/portal/portals/{portalId}/taskflows
Query for visualization templates as sub-resource of a portal	get	/v1/portal/portals/{portalId}/visualizationtemplates
Update portal given its short ID	put	/v1/portal/portals/{id}

Preferences

Operations for Preferences

Task	Method	Path
Provide values for general preference settings	put	/preferences/general
Retrieve current values of general preference settings	get	/preferences/general

RESTDataServices

Operations for REST DataServices

Task	Method	Path
Get REST DataService details given its short ID	get	/v1/portal/restdataservices/{id}
Query for REST DataServices	get	/v1/portal/restdataservices

ResourceCatalogs

Operations for ResourceCatalogs

Task	Method	Path
Download resource catalog to an EAR file	get	/v1/portal/resourcecatalogs/{id}/archive
Get page style details given its short ID	get	/v1/portal/resourcecatalogs/{id}
Query for Resource Catalogs	get	/v1/portal/resourcecatalogs
Update resource catalog given its short ID	put	/v1/portal/resourcecatalogs/{id}
Upload Resource Catalog metadata file	post	/v1/portal/resourcecatalogs

SQLDataServices

Operations for SQLDataServices

Task	Method	Path
Get SQL DataService details given its short ID	get	/v1/portal/sqldataservices/{id}
Query for SQL DataServices	get	/v1/portal/sqldataservices

Skins

Operations for Skins

Task	Method	Path
Download skin to an EAR file	get	/v1/portal/skins/{id}/archive
Get skin details given its short ID	get	/v1/portal/skins/{id}
Query for Skins	get	/v1/portal/skins
Update skin given its short ID	put	/v1/portal/skins/{id}
Upload Skin metadata file	post	/v1/portal/skins

Taskflows

Operations for Taskflows

Task	Method	Path
Download TaskFlow to an EAR file	get	/v1/portal/taskflows/{id}/archive
Get TaskFlow details given its short ID	get	/v1/portal/taskflows/{id}
Query for TaskFlows	get	/v1/portal/taskflows
Update TaskFlow given its short ID	put	/v1/portal/taskflows/{id}
Upload TaskFlow metadata files (page and pageDef)	post	/v1/portal/taskflows

VisualizationTemplates

Operations for VisualizationTemplates

Task	Method	Path
Create a new Visualization Template	post	/v1/portal/visualizationtemplates
Download Visualization Template to an EAR file	get	/v1/portal/visualizationtemplates/{id}/archive
Get Visualization Template details given its short ID	get	/v1/portal/visualizationtemplates/{id}
Query for Visualization Templates	get	/v1/portal/visualizationtemplates
Update Visualization Template given its short ID	put	/v1/portal/visualizationtemplates/{id}